markdown-maker 1.10.1 → 1.10.3

package/src/parse.ts

@@ -1,396 +0,0 @@
-import fs from "fs"; /* for handling reading of files */
-import path from "path"; /* for handling file paths */
-
-import Colors = require("colors.ts"); /* for adding colours to strings */
-Colors.enable();
-import marked from "marked";
-
-import { Command, commands, load_extensions, MDMError } from "./commands";
-
-enum TargetType {
-    HTML,
-    MARKDOWN,
-}
-
-/* parse some md
- * recursively with extra options */
-class Parser {
-    file: string;
-    parent?: Parser;
-    line_num: number;
-    wd: string;
-    wd_full: 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_undefined: boolean;
-        html: boolean;
-        watch: boolean;
-        targetType: TargetType | undefined;
-        only_warn: boolean;
-        parent?: Parser;
-        hooks: { [key: string]: () => string };
-        adv_hooks: {
-            [key: string]: (
-                tree: HTMLElement,
-                map: { [tag: string]: HTMLElement }
-            ) => HTMLElement;
-        };
-        isFileCallback: (s: string) => false | string;
-    };
-    raw: string;
-
-    static TOKEN = "#md";
-
-    constructor(
-        filename,
-        clargs,
-        opts?: {
-            parent?: Parser;
-            isFileCallback?: (s: string) => false | string;
-        }
-    ) {
-        /* 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);
-        this.wd_full = path.resolve(this.wd);
-
-        /* 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_undefined: false,
-            html: false,
-            watch: false,
-            targetType: undefined,
-            only_warn: false,
-            parent: undefined,
-            hooks: {},
-            adv_hooks: {},
-            isFileCallback: (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
-     **/
-    parse() {
-        load_extensions(this);
-        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 = [];
-        let __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;
-    }
-
-    mainparse(blob: string) {
-        if (this.opts.verbose || this.opts.debug) {
-            console.debug(`beginning mainparse of '${this.file}'`.blue);
-        }
-
-        /* main parser instance loop */
-        blob.split("\n").forEach((line, lnum) => {
-            this.line_num = lnum;
-
-            /* if line looks like a title */
-            const titleMatch = line.trim().match(/^(#+) (.+)$/);
-
-            if (titleMatch) {
-                if (this.opts.verbose || this.opts.debug)
-                    console.log("found toc element: " + line);
-
-                /* implement toc level */
-                let level = titleMatch[1].length;
-                let title = titleMatch[2];
-
-                this.opts.secs.push({ level, title });
-
-                if (this.opts.debug) {
-                    console.log("updated sections:", { level, title });
-                }
-            }
-        });
-
-        return this.parse_commands(blob, commands.parse);
-    }
-
-    preprocess(blob: string) {
-        if (this.opts.verbose || this.opts.debug) {
-            console.debug(`beginning preprocess of '${this.file}'`.blue);
-        }
-
-        return this.parse_commands(blob, commands.preparse);
-    }
-
-    postprocess(blob: string) {
-        if (this.opts.verbose || this.opts.debug) {
-            console.debug(`beginning postprocess of '${this.file}'`.blue);
-        }
-
-        blob = this.parse_commands(blob, commands.postparse);
-
-        /* remove double empty lines */
-        blob = this.remove_double_blank_lines(blob);
-        blob = blob.trimEnd() + "\n\n";
-        return blob;
-    }
-
-    parse_commands(blob: string, commands: Command[]) {
-        commands.forEach((command) => {
-            /* Add global flag to RegExp */
-            const re = new RegExp(
-                command.validator.source,
-                (command.validator.flags || "") + "g"
-            );
-            blob = blob.replace(re, (...args) => command.act(args, this) || "");
-        });
-        return blob;
-    }
-
-    parse_all_commands(blob: string, commands: { [key: string]: Command[] }) {
-        Object.keys(commands).forEach((key) => {
-            blob = this.parse_commands(blob, commands[key]);
-        });
-        return blob;
-    }
-
-    titleId(title: string) {
-        const sep = this.opts.use_underscore ? "_" : "-";
-
-        title = title
-            .toLowerCase()
-            .replace(/[^\w\s]+/g, "")
-            .replace(/[\s_]+/g, sep);
-        return title;
-    }
-
-    gen_toc() {
-        let __blob = [];
-        let tabSize = 2;
-        const beg = "* ";
-        const hor = " ".repeat(tabSize);
-
-        this.opts.secs.forEach((sec) => {
-            if (sec.level > this.opts.toc_level) return;
-            let title = sec.title.replace(/_/g, " ");
-            title = this.parse_all_commands(title, commands);
-            const link = this.titleId(title);
-
-            let __line =
-                hor.repeat(Math.max(sec.level - 1, 0)) +
-                beg +
-                `[${title}](#${link})`;
-
-            __blob.push(__line);
-        });
-        return __blob.join("\n");
-    }
-
-    add_hook(name: string, hook: () => string) {
-        if (this.opts.hooks[name] != undefined)
-            throw new Error(`Hook ${name} already exists!`);
-        this.opts.hooks[name] = hook;
-    }
-
-    add_adv_hook(name: string, hook: (tree: HTMLElement) => HTMLElement) {
-        if (this.opts.hooks[name] != undefined)
-            throw new Error(`Hook ${name} already exists!`);
-        this.opts.adv_hooks[name] = hook;
-    }
-
-    line_num_from_index(index: number) {
-        return this.raw.substring(0, index).split("\n").length + 1;
-    }
-
-    remove_double_blank_lines(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 */
-    to(bundleName: string, callback: (fileName: string) => void) {
-        const dir = path.dirname(bundleName);
-        if (callback === undefined) callback = () => {};
-
-        if (!fs.existsSync(dir)) {
-            fs.mkdirSync(dir, { recursive: true });
-        }
-
-        if (!this.opts.html) {
-            this.get(TargetType.MARKDOWN, (blob) => {
-                fs.writeFile(bundleName, blob, () => callback(bundleName));
-            });
-        } else {
-            const htmlFileName = bundleName.replace(".md", ".html");
-            fs.writeFile(htmlFileName, this.html(), () =>
-                callback(htmlFileName)
-            );
-        }
-    }
-
-    html() {
-        const htmlFormatted = marked(this.get(TargetType.HTML));
-        if (this.opts.watch) {
-            return (
-                `<script>w=new WebSocket("ws:localhost:7788");w.addEventListener("message",(e)=>{if(e.data=="refresh")location.reload();});</script>\n` +
-                htmlFormatted
-            );
-        }
-        return htmlFormatted;
-    }
-
-    get(targetType?: TargetType, callback?: (blob: string) => void): string {
-        /* 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;
-                let blob = this.parse();
-                this.opts.targetType = undefined;
-                if (callback) callback(blob);
-                return blob;
-            } catch (error) {
-                /* Compile a traceback of error */
-                let traceback = "";
-                let p: Parser = this;
-
-                do {
-                    if (error instanceof MDMError)
-                        traceback += `\n...on line ${p.line_num_from_index(
-                            error.match.index
-                        )} in ${p.file}`.grey(15);
-                    else
-                        traceback +=
-                            `\n...on line ${p.line_num} in ${p.file}`.grey(15);
-                    if (p.parent) p = p.parent;
-                } while (p.parent);
-
-                error.message += traceback;
-
-                /* only interested in node stacktrace when debugging */
-                if (!this.opts.debug) error.stack = "";
-
-                if (this.opts.only_warn) console.error(error);
-                else throw error;
-            }
-        }
-    }
-}
-
-export function splice(
-    str: string,
-    startIndex: number,
-    width: number,
-    newSubStr: string
-) {
-    const start = str.slice(0, startIndex);
-    const end = str.slice(startIndex + width);
-    return start + newSubStr + end;
-}
-
-/* add extention to marked for classed blockquotes*/
-marked.use({
-    renderer: {
-        blockquote(quote) {
-            /* find the ending, and if not, return the default */
-            const ending = quote.match(/\{(.+)\}\s*<\/p>/);
-            if (!ending) return `<blockquote>${quote}</blockquote>`;
-
-            const args = ending[1].split(" ");
-
-            const classes = args.filter((arg) => arg.startsWith("."));
-            const id = args.filter((arg) => arg.startsWith("#"));
-
-            const classNames = classes.map((c) => c.slice(1));
-            const classText =
-                classes.length > 0 ? `class="${classNames.join(" ")}"` : "";
-            const idText = id.length > 0 ? `id="${id[0].slice(1)}"` : "";
-
-            /* remove the ending from the quote */
-            quote = quote.replace(/\{(.+)\}\s*<\/p>/, "</p>");
-
-            return `<blockquote ${classText} ${idText}>\n${quote.trim()}</blockquote>`;
-        },
-    },
-});
-
-module.exports = Parser;
-
-export default Parser;

package/test/advanced.test.js

@@ -1,37 +0,0 @@
-const util = require("./tester.test.js");
-
-const putTemplate = () => {
-    util.put(
-        "module.exports = {main: (new_template, new_command) => {new_template('hi', 'hello'); new_command(/#test_cmd/, (t,p) => 'yeet', 0);}};",
-        "extensions.js"
-    );
-};
-
-describe("Use of templates", () => {
-    beforeEach(putTemplate);
-    it("should import presentation template as expected", () => {
-        putTemplate();
-        const output = new util.Parser("#mdtemplate<presentation>").get();
-        const template = `<style>html {width: 100vw;height: 100vh;}.slide {padding: 5%;border-radius: 25px;margin: 0;}div > .slide-num {position: absolute;top: 12.5%;right: 15%;/* font-size: 150%; */}body {margin: 5% 15%;}img {max-width: 100%;max-height: 40vh;}</style><script>document.addEventListener("DOMContentLoaded", () => {let current_slide = 0;const all_slides = document.querySelectorAll("div.slide");const num_slides = all_slides.length;all_slides.forEach((slide) => {const num_elem = document.createElement("p");num_elem.classList.add("slide-num");slide.appendChild(num_elem);});onkeydown = (ev) => {if (ev.key == "ArrowRight" && current_slide < all_slides.length - 1)update_slide(++current_slide);else if (ev.key == "ArrowLeft" && current_slide > 0)update_slide(--current_slide);};const update_slide = (index) => {all_slides.forEach((slide) => (slide.style.display = "none"));all_slides[current_slide].style.display = "block";all_slides[current_slide].lastChild.textContent = \`\${current_slide + 1} / \${num_slides}\`;};update_slide(current_slide);});</script>`;
-
-        util.assert.strictEqual(output, template + "\n\n");
-    });
-
-    it("should use custom templates from project extensions.js file", () => {
-        putTemplate();
-        util.put("#mdtemplate<hi>", "sample1.md");
-
-        util.assert.strictEqual(
-            new util.Parser("test/test-files/sample1.md").get(),
-            "hello\n\n"
-        );
-    });
-
-    it("should use custom commands from project extensions.js file", () => {
-        putTemplate();
-        util.put("#test_cmd", "sample1.md");
-
-        const parser = new util.Parser("test/test-files/sample1.md");
-        util.assert.strictEqual(parser.get(), "yeet\n\n");
-    });
-});

package/test/basic.test.js

@@ -1,67 +0,0 @@
-const util = require("./tester.test.js");
-
-describe("Basic features", () => {
-    it("should join two files with include", () => {
-        util.put("hello\n#mdinclude<sample2.md>", "sample1.md");
-        util.put("there", "sample2.md");
-
-        const parser = new util.Parser("test/test-files/sample1.md");
-        const output = parser.get();
-
-        util.assert.strictEqual(output, "hello\nthere\n\n");
-    });
-    it("should make a table of contents", () => {
-        const output = new util.Parser(
-            "# yo\n## bruh nugget\n#mdmaketoc"
-        ).get();
-
-        util.assert.strictEqual(
-            output,
-            "# yo\n## bruh nugget\n* [yo](#yo)\n  * [bruh nugget](#bruh-nugget)\n\n"
-        );
-    });
-    it("should allow quotation marks in titles for toc", () => {
-        const parser = new util.Parser("# mac's farm\n#mdmaketoc");
-        const markdown = parser.get();
-
-        util.assert.strictEqual(
-            markdown,
-            "# mac's farm\n* [mac's farm](#macs-farm)\n\n"
-        );
-    });
-    it("should allow variables in toc", () => {
-        const output = new util.Parser(
-            "#mddef<name= Foobar>\n# mr. #mdvar<name>\n#mdmaketoc<>"
-        ).get();
-
-        util.assert.strictEqual(
-            output,
-            "\n# mr. Foobar\n* [mr. Foobar](#mr-foobar)\n\n"
-        );
-    });
-    it("should not exceed max include depth", () => {
-        util.put("#mdinclude<sample2.md>", "sample1.md");
-        util.put("yo.md>", "sample2.md");
-
-        util.assert.throws(() => {
-            const parser = new util.Parser("test/test-files/sample1.md");
-            parser.opts.max_depth = 0;
-            parser.get();
-        }, Error);
-    });
-    it("should be able to reference toc elements, even if they are below toc-level", () => {
-        const parser = new util.Parser(`### Title\n#mdref<Title>`);
-
-        util.assert.strictEqual(parser.get(), "### Title\n[Title](#title)\n\n");
-    });
-    it("should include file with same name as folder when including a folder", () => {
-        util.put("#mdinclude<sample_fld>", "sample1.md");
-        util.putDir("sample_fld");
-        util.put("hello", util.path.join("sample_fld", "sample_fld.md"));
-
-        const parser = new util.Parser("test/test-files/sample1.md");
-        const output = parser.get();
-
-        util.assert.strictEqual(output, "hello\n\n");
-    });
-});

package/test/clargs.test.js

@@ -1,51 +0,0 @@
-const util = require("./tester.test.js");
-
-describe("Command Line Arguments", () => {
-    it("--use-underscore should replace '-' with '_' in toc", () => {
-        const output = new util.Parser("# foo bar\n#mdmaketoc", {
-            use_underscore: true,
-        }).get();
-
-        util.assert.strictEqual(output, "# foo bar\n* [foo bar](#foo_bar)\n\n");
-    });
-    it("--toc-level should exclude subsection with lower level", () => {
-        const output = new util.Parser("# foo bar\n### baz\n#mdmaketoc", {
-            toc_level: 2,
-        }).get();
-
-        util.assert.strictEqual(
-            output,
-            "# foo bar\n### baz\n* [foo bar](#foo-bar)\n\n"
-        );
-    });
-    it("--allow-undef should not throw when variable is not defined", () => {
-        const output = new util.Parser("#mdvar<zum>", {
-            allow_undefined: true,
-        }).get();
-
-        util.assert.strictEqual(output, "<zum>\n\n");
-    });
-    describe("Conditional imports", () => {
-        it("should be able to conditionally import documents", () => {
-            util.put("hello\n#mdinclude<sample2.md, YES>", "sample1.md");
-            util.put("there", "sample2.md");
-
-            const parser = new util.Parser("test/test-files/sample1.md");
-            parser.opts.args.push("YES");
-
-            const output = parser.get();
-
-            util.assert.strictEqual(output, "hello\nthere\n\n");
-        });
-        it("shouldn't include a document when flag is unset", () => {
-            util.put("hello\n#mdinclude<sample2.md,YES>", "sample1.md");
-            util.put("there", "sample2.md");
-
-            const parser = new util.Parser("test/test-files/sample1.md");
-
-            const output = parser.get();
-
-            util.assert.strictEqual(output, "hello\n\n");
-        });
-    });
-});

package/test/errors.test.js

@@ -1,47 +0,0 @@
-const util = require("./tester.test.js");
-
-describe("Error handling", () => {
-    it("should dissallow undefined templates", () => {
-        util.put("#mdtemplate<UNDEF>", "sample1.md");
-
-        const parser = new util.Parser("test/test-files/sample1.md");
-
-        let e;
-        util.assert.throws(() => {
-            try {
-                parser.get();
-            } catch (_e) {
-                e = _e;
-                throw _e;
-            }
-        }, Error);
-
-        let answer =
-            'Template "UNDEF" not found!' +
-            "\n...on line 1 in test/test-files/sample1.md".grey(15);
-
-        util.assert.strictEqual(e.message.replace(/(\\)+/g, "/"), answer);
-    });
-    it("should dissallow loading a folder without an entry file", () => {
-        util.put("#mdinclude<sample_fld>", "sample1.md");
-        util.putDir("sample_fld");
-
-        const parser = new util.Parser("test/test-files/sample1.md");
-
-        let e;
-        util.assert.throws(() => {
-            try {
-                parser.get();
-            } catch (_e) {
-                e = _e;
-                throw _e;
-            }
-        }, Error);
-
-        let answer =
-            'No entry file found in folder "sample_fld". Looking for "sample_fld.md"' +
-            "\n...on line 1 in test/test-files/sample1.md".grey(15);
-
-        util.assert.strictEqual(e.message.replace(/(\\)+/g, "/"), answer);
-    });
-});

package/test/hooks.js

@@ -1,9 +0,0 @@
-const fs = require("fs");
-
-exports.mochaHooks = {
-    beforeEach(done) {
-        fs.rmSync("test/test-files", { recursive: true });
-        fs.mkdirSync("test/test-files");
-        done();
-    },
-};