markdown-maker 1.7.10 → 1.9.1

package/src/parse.ts

@@ -4,7 +4,7 @@ const path = require("path"); /* for handling file paths */
 import Colors = require("colors.ts"); /* for adding colours to strings */
 Colors.enable();
 const marked = require("marked");
-const commands = require("./commands.js");
+import { Command, commands, load_extensions, MDMError } from "./commands";
 
 enum TargetType {
     HTML,
@@ -18,6 +18,7 @@ class Parser {
     parent?: Parser;
     line_num: number;
     wd: string;
+    wd_full: string;
     blobs: {
         [key: number]: string | undefined;
     };
@@ -36,8 +37,9 @@ class Parser {
         max_depth: number;
         use_underscore: boolean;
         toc_level: number;
-        allow_undef: boolean;
+        allow_undefined: boolean;
         html: boolean;
+        watch: boolean;
         targetType: TargetType | undefined;
         only_warn: boolean;
         parent?: Parser;
@@ -53,7 +55,7 @@ class Parser {
         opts?: {
             parent?: Parser;
             isFileCallback?: (s: string) => false | string;
-        }
+        },
     ) {
         /* this.working_directory */
         this.file = filename;
@@ -65,6 +67,7 @@ class Parser {
 
         this.line_num = 0;
         this.wd = path.dirname(filename);
+        this.wd_full = path.resolve(this.wd);
 
         /* finished blob */
         this.blobs = {};
@@ -80,8 +83,9 @@ class Parser {
             max_depth: 5,
             use_underscore: false,
             toc_level: 3,
-            allow_undef: false,
+            allow_undefined: false,
             html: false,
+            watch: false,
             targetType: undefined,
             only_warn: false,
             parent: undefined,
@@ -94,6 +98,7 @@ class Parser {
         if (!clargs) {
             clargs = {};
         }
+
         /* append all commandline arguments to this */
         Object.assign(this.opts, clargs);
         Object.assign(this.opts, opts);
@@ -106,12 +111,13 @@ class Parser {
      * 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
-                )
+                    "parsing " + this.file + ": depth=" + this.opts.depth,
+                ),
             );
         }
 
@@ -137,11 +143,10 @@ class Parser {
         return __blob;
     }
 
-    mainparse(blob) {
+    mainparse(blob: string) {
         if (this.opts.verbose || this.opts.debug) {
             console.debug(`beginning mainparse of '${this.file}'`.blue);
         }
-        let __blob = "";
 
         /* main parser instance loop */
         blob.split("\n").forEach((line, lnum) => {
@@ -156,121 +161,57 @@ class Parser {
 
                 /* implement toc level */
                 let level = titleMatch[1].length;
+                let title = titleMatch[2];
 
-                /**
-                 * parse elements of title
-                 * such as variables */
-                if (level <= this.opts.toc_level) {
-                    let title = titleMatch[2]
-                        .trim()
-                        .split(" ")
-                        .map((s) =>
-                            s.startsWith(Parser.TOKEN) ? this.parseToken(s) : s
-                        )
-                        .join("_");
-
-                    this.opts.secs.push({ level, title });
-
-                    if (this.opts.debug) {
-                        console.log("updated sections:", { level, title });
-                    }
-                }
-            }
+                this.opts.secs.push({ level, title });
 
-            let __line_tokens = [];
-            /* split line into tokens */
-            line.split(" ").forEach((token) => {
-                /* if token is not #md token,
-                 * just add it and continue */
-                if (token.startsWith(Parser.TOKEN)) {
-                    token = this.parseToken(token);
+                if (this.opts.debug) {
+                    console.log("updated sections:", { level, title });
                 }
-
-                __line_tokens.push(token);
-            });
-            /* put line back properly */
-            __blob += __line_tokens.join(" ") + "\n";
-        });
-
-        return __blob;
-    }
-
-    parseToken(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 (let i = 0; i < commands.parse.length; i++) {
-            const command = commands.parse[i];
-
-            if (command.valid(token, this)) {
-                return command.act(token, this);
             }
-        }
-
-        /* check if the command is for later */
-        for (let i = 0; i < commands.postparse.length; i++) {
-            const command = commands.postparse[i];
-
-            if (command.valid(token, this)) {
-                return token;
-            }
-        }
+        });
 
-        throw new SyntaxError(`Unknown token: ${token}`);
+        return this.parse_commands(blob, commands.parse);
     }
 
-    preprocess(blob) {
+    preprocess(blob: string) {
         if (this.opts.verbose || this.opts.debug) {
             console.debug(`beginning preprocess of '${this.file}'`.blue);
         }
-        let __blob = "";
-        const lines = blob.split("\n");
-
-        lines.forEach((line) => {
-            let __line_tokens = [];
-            line.split(" ").forEach((token) => {
-                for (const command of commands.preparse) {
-                    if (command.valid(token, this)) {
-                        token = command.act(token, this);
-                    }
-                }
 
-                __line_tokens.push(token);
-            });
-            __blob += __line_tokens.join(" ") + "\n";
-        });
-        return __blob;
+        return this.parse_commands(blob, commands.preparse);
     }
 
-    postprocess(blob) {
+    postprocess(blob: string) {
         if (this.opts.verbose || this.opts.debug) {
             console.debug(`beginning postprocess of '${this.file}'`.blue);
         }
-        let __blob = "";
-        const lines = blob.split("\n");
-
-        lines.forEach((line) => {
-            let __line_tokens = [];
-            line.split(" ").forEach((token) => {
-                // only look
-
-                for (const command of commands.postparse) {
-                    if (command.valid(token, this)) {
-                        token = command.act(token, this);
-                    }
-                }
 
-                __line_tokens.push(token);
-            });
-            __blob += __line_tokens.join(" ") + "\n";
-        });
+        blob = this.parse_commands(blob, commands.postparse);
 
         /* remove double empty lines */
-        __blob = this.remove_double_blank_lines(__blob);
-        return __blob;
+        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) {
@@ -290,18 +231,25 @@ class Parser {
         const hor = " ".repeat(tabSize);
 
         this.opts.secs.forEach((sec) => {
-            const link = this.titleId(sec.title);
-            const title = sec.title.replace(/_/g, " ");
+            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");
     }
 
+    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");
@@ -310,25 +258,27 @@ class Parser {
     }
 
     /* output the parsed document to bundle */
-    to(bundleName, cb) {
+    to(bundleName: string, callback: (fileName: string) => void) {
         const dir = path.dirname(bundleName);
         var called = false;
-        if (!cb) cb = () => {};
+        if (callback === undefined) callback = () => {};
 
         if (!fs.existsSync(dir)) {
             fs.mkdirSync(dir);
         }
         this.get(TargetType.MARKDOWN, (blob) => {
             fs.writeFile(bundleName, blob, () => {
-                if (!called) cb(bundleName);
-                called = true;
+                if (!this.opts.html) {
+                    callback(bundleName);
+                    called = true;
+                }
             });
         });
 
         if (this.opts.html) {
             const htmlFileName = bundleName.replace(".md", ".html");
             fs.writeFile(htmlFileName, this.html(), () => {
-                if (!called) cb(htmlFileName);
+                if (!called) callback(htmlFileName);
                 called = true;
             });
         }
@@ -336,11 +286,18 @@ class Parser {
 
     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?) {
+    get(targetType?: 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]);
@@ -359,9 +316,13 @@ class Parser {
                 let p: Parser = this;
 
                 do {
-                    traceback += `\n...on line ${p.line_num + 1} in ${
-                        p.file
-                    }`.grey(15);
+                    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);
 
@@ -377,6 +338,43 @@ class Parser {
     }
 }
 
+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 */
+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/src/templates/mathjax.js

@@ -0,0 +1,3 @@
+const template = `<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script><script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>`;
+
+module.exports = template;

package/src/templates/presentation.js

@@ -0,0 +1,3 @@
+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>`;
+
+module.exports = template;

package/src/templates.ts

@@ -0,0 +1,18 @@
+const templates: { [key: string]: string } = {};
+
+/**
+ * Function to add a template to the templates object. Similar to definitions and variables, but reside as an extension.
+ * @param name The name of the template
+ * @param content The replacement string
+ */
+export function new_template(name: string, content: string) {
+    templates[name] = content;
+}
+
+/* initialize default templates */
+const presentation_template = require("../src/templates/presentation.js");
+const mathjax_template = require("../src/templates/mathjax.js");
+new_template("presentation", presentation_template);
+new_template("mathjax", mathjax_template);
+
+export default templates;

package/test/advanced.test.js

@@ -0,0 +1,35 @@
+const util = require("./tester.test.js");
+
+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", () => {
+    it("should import presentation template as expected", () => {
+        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", () => {
+        util.put("#mdtemplate<hi>", "sample1.md");
+
+        util.assert.strictEqual(
+            new util.Parser("test/test-files/sample1.md").get(),
+            "hello\n\n"
+        );
+
+        /* make sure to remove after, to not mess with future tests */
+    });
+
+    it("should use custom commands from project extensions.js file", () => {
+        util.put("#test_cmd", "sample1.md");
+
+        const parser = new util.Parser("test/test-files/sample1.md");
+        util.assert.strictEqual(parser.get(), "yeet\n\n");
+
+        /* make sure to remove after, to not mess with future tests */
+    });
+});

package/test/basic.test.js

@@ -1,14 +1,6 @@
 const util = require("./tester.test.js");
 
 describe("Basic features", () => {
-    it("should raise an error if invalid token", () => {
-        util.assert.throws(
-            () => {
-                const output = new util.Parser("#mdNON<>").get();
-            },
-            SyntaxError
-        )
-    });
     it("should join two files with include", () => {
         util.put("hello\n#mdinclude<sample2.md>", "sample1.md");
         util.put("there", "sample2.md");
@@ -19,32 +11,47 @@ describe("Basic features", () => {
         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();
+        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");
+        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 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")
+        util.assert.strictEqual(
+            markdown,
+            "# mac's farm\n* [mac's farm](#macs-farm)\n\n"
+        );
     });
     it("should allow variables in toc", () => {
-        const parser = new util.Parser("#mddef<name=Foobar>\n# mr. #mdvar<name>\n#mdmaketoc<>");
+        const output = new util.Parser(
+            "#mddef<name= Foobar>\n# mr. #mdvar<name>\n#mdmaketoc<>"
+        ).get();
 
-        util.assert.strictEqual(parser.get(), "\n# mr. Foobar\n* [mr. Foobar](#mr-foobar)\n\n");
+        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
-        )
+        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");
     });
 });

package/test/clargs.test.js

@@ -20,14 +20,14 @@ describe("Command Line Arguments", () => {
     });
     it("--allow-undef should not throw when variable is not defined", () => {
         const output = new util.Parser("#mdvar<zum>", {
-            allow_undef: true,
+            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("hello\n#mdinclude<sample2.md, YES>", "sample1.md");
             util.put("there", "sample2.md");
 
             const parser = new util.Parser("test/test-files/sample1.md");

package/test/errors.test.js

@@ -1,65 +1,26 @@
+const { Parser } = require("marked");
 const util = require("./tester.test.js");
 
 describe("Error handling", () => {
-    it("should provide basic traceback", () => {
-        util.put("hi there\n\n\n#mdNON\n\n", "sample1.md");
+    it("should dissallow undefined templates", () => {
+        util.put("#mdtemplate<UNDEF>", "sample1.md");
 
         const parser = new util.Parser("test/test-files/sample1.md");
 
         let e;
-        /* should throw an error */
-        util.assert.throws(
-            () => {
-                try {
-                    parser.get();
-                } catch (_e) {
-                    e = _e;
-                    throw _e;
-                }
+        util.assert.throws(() => {
+            try {
+                parser.get();
+            } catch (_e) {
+                e = _e;
+                throw _e;
             }
-        )
+        }, Error);
 
-        /**
-         * ..and error message should provide
-         * info as to where the error occured
-         */
-        util.assert.strictEqual(
-            e.message,
-            "Unknown token: #mdNON" +
-            "\n...on line 4 in test/test-files/sample1.md".grey(15)
-        )
+        let answer =
+            'Template "UNDEF" not found!' +
+            "\n...on line 1 in test/test-files/sample1.md".grey(15);
 
-    });
-    it("should traceback across file includes", () => {
-        util.put("\n#mdinclude<sample2.md>", "sample1.md");
-        util.put("#mdNON", "sample2.md");
-
-        const parser = new util.Parser("test/test-files/sample1.md");
-
-        let e;
-
-        /* should throw SyntaxError */
-        util.assert.throws(
-            /* run parser, but store error for further inspection */
-            () => {
-                try {
-                    parser.get();
-                } catch (_e) {
-                    e = _e;
-                    throw _e;
-                }
-            },
-            SyntaxError
-        );
-
-        /* ...where the error message is the traceback on line 2 -> */
-        let answer = "Unknown token: #mdNON" +
-            "\n...on line 1 in test/test-files/sample2.md".grey(15) +
-            "\n...on line 2 in test/test-files/sample1.md".grey(15);
-
-        util.assert.strictEqual(
-            e.message.replace(/(\\)+/g, "/"),
-            answer
-        );
+        util.assert.strictEqual(e.message.replace(/(\\)+/g, "/"), answer);
     });
 });

package/test/html.test.js

@@ -7,7 +7,10 @@ describe("HTML Emitting", () => {
         parser.opts.quiet = true;
 
         parser.to("test/test-files/dist/bundle.md", () => {
-            util.assert.strictEqual(util.fs.existsSync("test/test-files/dist/bundle.html"), true);
+            util.assert.strictEqual(
+                util.fs.existsSync("test/test-files/dist/bundle.html"),
+                true
+            );
             done();
         });
     });
@@ -17,7 +20,10 @@ describe("HTML Emitting", () => {
 
         const output = parser.html();
 
-        util.assert.strictEqual(output, '<h1 id="cool-title">cool title</h1>\n<p>with a cool paragraph</p>\n');
+        util.assert.strictEqual(
+            output,
+            '<h1 id="cool-title">cool title</h1>\n<p>with a cool paragraph</p>\n'
+        );
     });
     it("should be able to include html documents, and not parse", () => {
         util.put("#mdinclude<sample2.html>", "sample1.md");
@@ -28,4 +34,4 @@ describe("HTML Emitting", () => {
 
         util.assert.strictEqual(output, "#mdvar<lul>\n\n");
     });
-})
+});