markdown-maker 1.7.11 → 1.9.2

package/build/cltool.d.ts

@@ -1 +0,0 @@
-export declare const argParser: any;

package/build/cltool.js

@@ -1,141 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.argParser = void 0;
-var fs = require("fs"); /* for handling reading of files */
-var path = require("path"); /* for handling file paths */
-var Colors = require("colors.ts"); /* for adding colours to strings */
-var parse_1 = __importDefault(require("./parse"));
-Colors.enable();
-var ArgumentParser = require("argparse").ArgumentParser; /* for parsing clargs */
-var version = require("../package.json").version; /* package version number */
-var choki = require("chokidar");
-exports.argParser = new ArgumentParser({
-    description: "Markdown bundler, with extra options",
-    prog: process.argv[0].split(path.sep).pop(),
-});
-var configFileName = ".mdmconfig.json";
-//#region command line args
-exports.argParser.add_argument("src", {
-    help: "file to be parsed. If this is a directory, it looks for entry point in the directory, see --entry",
-});
-exports.argParser.add_argument("--version", { action: "version", version: version });
-exports.argParser.add_argument("-v", "--verbose", {
-    action: "store_true",
-    help: "enable verbose output",
-});
-exports.argParser.add_argument("-db", "--debug", {
-    action: "store_true",
-    help: "enable debugging information",
-});
-exports.argParser.add_argument("-o", "--output", {
-    help: "destination of bundle, by default is 'dist/bundle.md'",
-    default: "dist/bundle.md",
-});
-exports.argParser.add_argument("-d", "--max-depth", {
-    help: "maximum recursion depth, by default is 15",
-    default: 15,
-    type: "int",
-});
-exports.argParser.add_argument("-e", "--entry", {
-    help: "assign entry point in directory, by default is 'main.md'",
-    default: "main.md",
-});
-exports.argParser.add_argument("-w", "--watch", {
-    action: "store_true",
-    help: "recompile after a change in target target file or directory.",
-});
-exports.argParser.add_argument("-uu", "--use-underscore", {
-    action: "store_true",
-    help: "set the parser to use '_' as seperator in ids for Table of Content. If the links in the table does not work, this is likely to be the issue.",
-});
-exports.argParser.add_argument("--toc-level", {
-    help: "the section level of the table of contents, by default is 3",
-    default: 3,
-    type: "int",
-});
-exports.argParser.add_argument("--html", {
-    action: "store_true",
-    help: "compile HTML from the parsed markdown",
-});
-exports.argParser.add_argument("--allow-undef", "-au", {
-    action: "store_true",
-    help: "allow undefined variables. Mostly useful for typing inline html tags, and other non-strictly markdown related uses",
-});
-//#endregion
-function main() {
-    // var server: refreshServer | undefined;
-    var clargs;
-    if (fs.existsSync(configFileName)) {
-        var data = JSON.parse(fs.readFileSync(configFileName)).opts;
-        var args_1 = [];
-        Object.entries(data).forEach(function (_a) {
-            var key = _a[0], value = _a[1];
-            if (key != "src")
-                args_1.push("--" + key);
-            if (typeof value != "boolean")
-                args_1.push(value);
-        });
-        args_1.push(data.src);
-        exports.argParser.parse_args(args_1);
-    }
-    else
-        clargs = exports.argParser.parse_args();
-    /* helper method for calling parser */
-    var compile = function (source, output, cb) {
-        /* load data from file, if it exists,
-         * otherwise, interpret as string */
-        var parser = new parse_1.default(source, clargs);
-        parser.to(output, function (file) {
-            console.log(("Compiled " + file).green);
-            if (cb)
-                cb();
-        });
-        return parser;
-    };
-    var internalCooldown = 1000;
-    function watcher(event, path) {
-        var now = Date.now();
-        if (!this.time)
-            this.time = now;
-        if (now - this.time < internalCooldown)
-            return;
-        console.log(path);
-        console.log("Detected change in " + path + "...");
-        try {
-            compile(clargs.src, clargs.output, function () {
-                // if (server.refresh) server.refresh();
-            });
-        }
-        catch (e) {
-            console.log(e.message);
-        }
-        this.time = now;
-    }
-    /* in case source is a directory, look for entry in directory */
-    if (fs.existsSync(clargs.src) && fs.lstatSync(clargs.src).isDirectory()) {
-        clargs.src = path.join(clargs.src, clargs.entry);
-    }
-    var srcDirName = path.dirname(clargs.src);
-    if (clargs.debug)
-        console.dir(clargs);
-    if (!clargs.watch)
-        compile(clargs.src, clargs.output);
-    if (clargs.watch) {
-        /* watch the folder of entry */
-        // server = wsServer();
-        console.log(("Watching " + srcDirName + " for changes...").yellow);
-        var _watcher = choki.watch(srcDirName).on("all", watcher);
-        try {
-            compile(clargs.src, clargs.output);
-        }
-        catch (e) {
-            console.log(e.message);
-        }
-    }
-}
-/* main entrypoint */
-if (require.main === module)
-    main();

package/build/commands.d.ts

@@ -1,9 +0,0 @@
-import Parser from "./parse";
-export declare class Command {
-    type: number;
-    validator: (token: string, parser: Parser) => boolean | RegExpMatchArray;
-    acter: (token: string, parser: Parser) => string | void;
-    constructor(type: any, validator: (token: string, parser: Parser) => boolean | RegExpMatchArray, acter: (token: string, parser: Parser) => string | void);
-    valid(token: any, parser: any): boolean | RegExpMatchArray;
-    act(token: any, parser: any): string | void;
-}

package/build/commands.js

@@ -1,140 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Command = void 0;
-var path = __importStar(require("path"));
-var parse_1 = __importDefault(require("./parse"));
-var commands = {
-    preparse: [],
-    parse: [],
-    postparse: [],
-};
-var CommandType = {
-    PREPARSE: 0,
-    PARSE: 1,
-    POSTPARSE: 2,
-};
-var TargetType;
-(function (TargetType) {
-    TargetType[TargetType["HTML"] = 0] = "HTML";
-    TargetType[TargetType["MARKDOWN"] = 1] = "MARKDOWN";
-})(TargetType || (TargetType = {}));
-var Command = /** @class */ (function () {
-    function Command(type, validator, acter) {
-        this.type = type;
-        this.validator = validator;
-        this.acter = acter;
-        /* add this function to appropriate file */
-        switch (type) {
-            case CommandType.PARSE:
-                commands.parse.push(this);
-                break;
-            case CommandType.PREPARSE:
-                commands.preparse.push(this);
-                break;
-            case CommandType.POSTPARSE:
-                commands.postparse.push(this);
-                break;
-        }
-    }
-    Command.prototype.valid = function (token, parser) {
-        return this.validator(token, parser);
-    };
-    Command.prototype.act = function (token, parser) {
-        return this.acter(token, parser);
-    };
-    return Command;
-}());
-exports.Command = Command;
-/* variable shorthand */
-new Command(CommandType.PREPARSE, function (t, p) { return t.match(/(?:\s|^)<\w+>/); }, function (t, p) { return "#mdvar" + t; });
-/* mddef */
-new Command(CommandType.PARSE, function (t, p) { return t.match(/^#mddef<(\w+)=(\w+)>/); }, function (t, p) {
-    var m = t.match(/^#mddef<(\w+)=(\w+)>/);
-    p.opts.defs[m[1]] = m[2];
-});
-/* mdvar */
-new Command(CommandType.PARSE, function (t, p) { return t.match(/^#mdvar<(\w+)>/) || t.match(/^<(\w+)>/); }, function (t, p) {
-    var match = t.match(/#mdvar<(\w+)>/);
-    var value = p.opts.defs[match[1]];
-    if (!value && !p.opts.allow_undef)
-        throw new Error("Undefined variable: " + match[1]);
-    value = value || "<" + match[1] + ">";
-    return t.replace(match[0], value.replace("_", " "));
-});
-/** mdinclude */
-new Command(CommandType.PARSE, function (t, p) { return t.match(/^#mdinclude<([\w.\/-]+)(?:[,\s]+([\w]+))?>/); }, function (t, p) {
-    /* increase the current recursive depth */
-    p.opts.depth++;
-    if (p.opts.depth > p.opts.max_depth) {
-        throw new Error("max depth exceeded!");
-    }
-    /* get the matching group */
-    var match = t.match(/^#mdinclude<([\w.\/-]+)(?:[,\s]+([\w]+))?>/);
-    var _ = match[0], name = match[1], condition = match[2];
-    /* implement conditional imports */
-    if (condition && !p.opts.args.includes(condition))
-        return;
-    var recursiveParser = new parse_1.default(path.join(p.wd, name), p.opts, {
-        parent: p,
-    });
-    /* keep the options the same */
-    recursiveParser.opts = p.opts;
-    recursiveParser.parent = p;
-    var fileType = path.extname(recursiveParser.file);
-    var blob = fileType === ".md"
-        ? recursiveParser.get(p.opts.targetType)
-        : recursiveParser.raw;
-    p.opts.depth--;
-    return blob;
-});
-new Command(CommandType.PREPARSE, function (t, p) { return t.match(/#mdlabel<(\d+),([\w\W]+)>/); }, function (t, p) {
-    if (p.opts.targetType !== TargetType.HTML)
-        return;
-    var match = t.match(/#mdlabel<([\d]+),([\w\W]+)>/);
-    var level = Number.parseInt(match[1]);
-    var title = match[2];
-    var link = p.titleId(title);
-    p.opts.secs.push({ level: level, title: title });
-    return "<span id=\"" + link + "\"></span>";
-});
-/* mdref */
-new Command(CommandType.PARSE, function (t, p) { return t.match(/#mdref<([\w\W]+)>/); }, function (t, p) {
-    var match = t.match(/#mdref<([\w\W]+)>/);
-    for (var i = 0; i < p.opts.secs.length; i++) {
-        var title = p.opts.secs[i].title;
-        if (title === match[1])
-            break;
-        if (i === p.opts.secs.length - 1)
-            throw new Error("Reference to [" + match[1] + "] could not be resolved!");
-    }
-    match[1] = match[1].replace("_", " ");
-    var link = p.titleId(match[1]);
-    if (p.opts.targetType === TargetType.HTML)
-        return "<a href=\"#" + link + "\">" + match[1] + "</a>";
-    else if (p.opts.targetType === TargetType.MARKDOWN)
-        return "[" + match[1] + "](#" + link + ")";
-});
-new Command(CommandType.POSTPARSE, function (t, p) { return t.match(/#mdmaketoc/); }, function (t, p) { return p.gen_toc(); });
-module.exports = commands;

package/build/parse.d.ts

@@ -1,57 +0,0 @@
-declare enum TargetType {
-    HTML = 0,
-    MARKDOWN = 1
-}
-declare class Parser {
-    file: string;
-    parent?: Parser;
-    line_num: number;
-    wd: string;
-    blobs: {
-        [key: number]: string | undefined;
-    };
-    opts: {
-        defs: {
-            [key: string]: string;
-        };
-        secs: {
-            level: number;
-            title: string;
-        }[];
-        args: string[];
-        depth: number;
-        verbose: boolean;
-        debug: boolean;
-        max_depth: number;
-        use_underscore: boolean;
-        toc_level: number;
-        allow_undef: boolean;
-        html: boolean;
-        targetType: TargetType | undefined;
-        only_warn: boolean;
-        parent?: Parser;
-        isFileCallback: (s: string) => false | string;
-    };
-    raw: string;
-    static TOKEN: string;
-    constructor(filename: any, clargs: any, opts?: {
-        parent?: Parser;
-        isFileCallback?: (s: string) => false | string;
-    });
-    /**
-     * parse wrapper for handling
-     * preprocessing, parsing and postprocess
-     **/
-    parse(): any;
-    mainparse(blob: any): string;
-    parseToken(token: any): any;
-    preprocess(blob: any): string;
-    postprocess(blob: any): string;
-    titleId(title: string): string;
-    gen_toc(): string;
-    remove_double_blank_lines(blob: any): any;
-    to(bundleName: any, cb: any): void;
-    html(): any;
-    get(targetType: TargetType, callback?: any): any;
-}
-export default Parser;

package/build/parse.js

@@ -1,298 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var fs = require("fs"); /* for handling reading of files */
-var path = require("path"); /* for handling file paths */
-var Colors = require("colors.ts"); /* for adding colours to strings */
-Colors.enable();
-var marked = require("marked");
-var commands = require("./commands.js");
-var TargetType;
-(function (TargetType) {
-    TargetType[TargetType["HTML"] = 0] = "HTML";
-    TargetType[TargetType["MARKDOWN"] = 1] = "MARKDOWN";
-})(TargetType || (TargetType = {}));
-/* parse some md
- * recursively with extra options */
-var Parser = /** @class */ (function () {
-    function Parser(filename, clargs, opts) {
-        /* this.working_directory */
-        this.file = filename;
-        if (!opts)
-            opts = {};
-        /* the parent parser */
-        this.parent = opts.parent;
-        this.line_num = 0;
-        this.wd = path.dirname(filename);
-        /* finished blob */
-        this.blobs = {};
-        /* all options */
-        this.opts = {
-            defs: {},
-            secs: [],
-            args: [],
-            depth: 0,
-            verbose: false,
-            debug: false,
-            max_depth: 5,
-            use_underscore: false,
-            toc_level: 3,
-            allow_undef: false,
-            html: false,
-            targetType: undefined,
-            only_warn: false,
-            parent: undefined,
-            isFileCallback: function (f) {
-                if (!fs.existsSync(f))
-                    return false;
-                return fs.readFileSync(f, "utf-8") + "\n";
-            },
-        };
-        if (!clargs) {
-            clargs = {};
-        }
-        /* append all commandline arguments to this */
-        Object.assign(this.opts, clargs);
-        Object.assign(this.opts, opts);
-        this.raw = this.opts.isFileCallback(filename) || filename;
-    }
-    /**
-     * parse wrapper for handling
-     * preprocessing, parsing and postprocess
-     **/
-    Parser.prototype.parse = function () {
-        if (this.opts.verbose || this.opts.debug) {
-            console.log(Colors.colors("magenta", "parsing " + this.file + ": depth=" + this.opts.depth));
-        }
-        if (this.opts.debug) {
-            console.log("Parsing options:");
-            console.log(this.opts);
-        }
-        /* reset sections for beginning parse */
-        if (this.opts.depth === 0)
-            this.opts.secs = [];
-        var __blob;
-        /* apply preproccessing to raw file */
-        __blob = this.preprocess(this.raw);
-        /* main parser instance call */
-        __blob = this.mainparse(__blob);
-        /**
-         * apply postprocessing after */
-        __blob = this.postprocess(__blob);
-        return __blob;
-    };
-    Parser.prototype.mainparse = function (blob) {
-        var _this = this;
-        if (this.opts.verbose || this.opts.debug) {
-            console.debug(("beginning mainparse of '" + this.file + "'").blue);
-        }
-        var __blob = "";
-        /* main parser instance loop */
-        blob.split("\n").forEach(function (line, lnum) {
-            _this.line_num = lnum;
-            /* if line looks like a title */
-            var titleMatch = line.trim().match(/^(#+) (.+)$/);
-            if (titleMatch) {
-                if (_this.opts.verbose || _this.opts.debug)
-                    console.log("found toc element: " + line);
-                /* implement toc level */
-                var level = titleMatch[1].length;
-                /**
-                 * parse elements of title
-                 * such as variables */
-                var title = titleMatch[2]
-                    .trim()
-                    .split(" ")
-                    .map(function (s) {
-                    return s.startsWith(Parser.TOKEN) ? _this.parseToken(s) : s;
-                })
-                    .join("_");
-                _this.opts.secs.push({ level: level, title: title });
-                if (_this.opts.debug) {
-                    console.log("updated sections:", { level: level, title: title });
-                }
-            }
-            var __line_tokens = [];
-            /* split line into tokens */
-            line.split(" ").forEach(function (token) {
-                /* if token is not #md token,
-                 * just add it and continue */
-                if (token.startsWith(Parser.TOKEN)) {
-                    token = _this.parseToken(token);
-                }
-                __line_tokens.push(token);
-            });
-            /* put line back properly */
-            __blob += __line_tokens.join(" ") + "\n";
-        });
-        return __blob;
-    };
-    Parser.prototype.parseToken = function (token) {
-        /* iterate over all commands,
-         * and if command is valid, execute it */
-        if (this.opts.verbose || this.opts.debug)
-            console.log("found mdtoken: " + token);
-        for (var i = 0; i < commands.parse.length; i++) {
-            var command = commands.parse[i];
-            if (command.valid(token, this)) {
-                return command.act(token, this);
-            }
-        }
-        /* check if the command is for later */
-        for (var i = 0; i < commands.postparse.length; i++) {
-            var command = commands.postparse[i];
-            if (command.valid(token, this)) {
-                return token;
-            }
-        }
-        throw new SyntaxError("Unknown token: " + token);
-    };
-    Parser.prototype.preprocess = function (blob) {
-        var _this = this;
-        if (this.opts.verbose || this.opts.debug) {
-            console.debug(("beginning preprocess of '" + this.file + "'").blue);
-        }
-        var __blob = "";
-        var lines = blob.split("\n");
-        lines.forEach(function (line) {
-            var __line_tokens = [];
-            line.split(" ").forEach(function (token) {
-                for (var _i = 0, _a = commands.preparse; _i < _a.length; _i++) {
-                    var command = _a[_i];
-                    if (command.valid(token, _this)) {
-                        token = command.act(token, _this);
-                    }
-                }
-                __line_tokens.push(token);
-            });
-            __blob += __line_tokens.join(" ") + "\n";
-        });
-        return __blob;
-    };
-    Parser.prototype.postprocess = function (blob) {
-        var _this = this;
-        if (this.opts.verbose || this.opts.debug) {
-            console.debug(("beginning postprocess of '" + this.file + "'").blue);
-        }
-        var __blob = "";
-        var lines = blob.split("\n");
-        lines.forEach(function (line) {
-            var __line_tokens = [];
-            line.split(" ").forEach(function (token) {
-                // only look
-                for (var _i = 0, _a = commands.postparse; _i < _a.length; _i++) {
-                    var command = _a[_i];
-                    if (command.valid(token, _this)) {
-                        token = command.act(token, _this);
-                    }
-                }
-                __line_tokens.push(token);
-            });
-            __blob += __line_tokens.join(" ") + "\n";
-        });
-        /* remove double empty lines */
-        __blob = this.remove_double_blank_lines(__blob);
-        return __blob;
-    };
-    Parser.prototype.titleId = function (title) {
-        var sep = this.opts.use_underscore ? "_" : "-";
-        title = title
-            .toLowerCase()
-            .replace(/[^\w\s]+/g, "")
-            .replace(/[\s_]+/g, sep);
-        return title;
-    };
-    Parser.prototype.gen_toc = function () {
-        var _this = this;
-        var __blob = [];
-        var tabSize = 2;
-        var beg = "* ";
-        var hor = " ".repeat(tabSize);
-        this.opts.secs.forEach(function (sec) {
-            if (sec.level > _this.opts.toc_level)
-                return;
-            var link = _this.titleId(sec.title);
-            var title = sec.title.replace(/_/g, " ");
-            var __line = hor.repeat(Math.max(sec.level - 1, 0)) +
-                beg +
-                ("[" + title + "](#" + link + ")");
-            __blob.push(__line);
-        });
-        return __blob.join("\n");
-    };
-    Parser.prototype.remove_double_blank_lines = function (blob) {
-        /* replace all triple newlines, and EOF by double newline */
-        blob = blob.replace(/(\r\n|\n){3,}/g, "\n\n");
-        return blob;
-    };
-    /* output the parsed document to bundle */
-    Parser.prototype.to = function (bundleName, cb) {
-        var dir = path.dirname(bundleName);
-        var called = false;
-        if (!cb)
-            cb = function () { };
-        if (!fs.existsSync(dir)) {
-            fs.mkdirSync(dir);
-        }
-        this.get(TargetType.MARKDOWN, function (blob) {
-            fs.writeFile(bundleName, blob, function () {
-                if (!called)
-                    cb(bundleName);
-                called = true;
-            });
-        });
-        if (this.opts.html) {
-            var htmlFileName_1 = bundleName.replace(".md", ".html");
-            fs.writeFile(htmlFileName_1, this.html(), function () {
-                if (!called)
-                    cb(htmlFileName_1);
-                called = true;
-            });
-        }
-    };
-    Parser.prototype.html = function () {
-        var htmlFormatted = marked(this.get(TargetType.HTML));
-        return htmlFormatted;
-    };
-    Parser.prototype.get = function (targetType, callback) {
-        /* If target type is undefined, markdown is the default */
-        if (targetType == undefined)
-            targetType = TargetType.MARKDOWN;
-        if (this.blobs[targetType]) {
-            if (callback) {
-                callback(this.blobs[targetType]);
-            }
-            return this.blobs[targetType];
-        }
-        else {
-            try {
-                this.opts.targetType = targetType;
-                var blob = this.parse();
-                this.opts.targetType = undefined;
-                if (callback)
-                    callback(blob);
-                return blob;
-            }
-            catch (error) {
-                var traceback = "";
-                var p = this;
-                do {
-                    traceback += ("\n...on line " + (p.line_num + 1) + " in " + p.file).grey(15);
-                    if (p.parent)
-                        p = p.parent;
-                } while (p.parent);
-                error.message += traceback;
-                /* only interested in stacktrace, when debugging */
-                if (!this.opts.debug)
-                    error.stack = "";
-                if (this.opts.only_warn)
-                    console.error(error);
-                else
-                    throw error;
-            }
-        }
-    };
-    Parser.TOKEN = "#md";
-    return Parser;
-}());
-module.exports = Parser;
-exports.default = Parser;