markdown-maker 1.10.0 → 1.10.2

package/.vscode/launch.json

@@ -4,31 +4,13 @@
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
-        {
-            "name": "Compile main",
-            "request": "launch",
-            "runtimeArgs": [
-                "run-script",
-                "main"
-            ],
-            "runtimeExecutable": "npm",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            "type": "pwa-node"
-        },
         {
             "name": "Run test",
             "request": "launch",
-            "runtimeArgs": [
-                "run-script",
-                "test"
-            ],
+            "runtimeArgs": ["run-script", "test"],
             "runtimeExecutable": "npm",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            "type": "pwa-node"
+            "skipFiles": ["<node_internals>/**"],
+            "type": "node"
         }
     ]
-}
+}

package/package.json

@@ -1,64 +1,41 @@
 {
     "name": "markdown-maker",
-    "version": "1.10.0",
-    "description": "",
-    "main": "src/cltool.ts",
+    "version": "1.10.2",
+    "description": "A superset-compiler for markdown using marked",
+    "main": "src/main.ts",
     "bin": {
-        "mdparse": "build/cltool.js"
-    },
-    "pkg": {
-        "assets": [
-            "node_modules/argparse/*",
-            "node_modules/chokidar/*",
-            "node_modules/colors/*",
-            "node_modules/colors./*",
-            "node_modules/marked/*",
-            "build/cltool.js",
-            "src/templates/*"
-        ],
-        "targets": [
-            "node12-macos-x64",
-            "node12-win-x64",
-            "node12-linux-x64"
-        ]
+        "mdparse": "bundle/main.js"
     },
     "scripts": {
         "test": "mocha --require test/hooks.js",
         "test:yarn": "mocha",
         "bundle": "tsc --project tsconfig.json",
-        "main": "node build/cltool.js document/main.md -o dist/bundle.md --debug",
-        "debug": "node src/cltool.js -db document/main.md -o dist/bundle.md",
-        "build": "npm run bundle && pkg --output bin/mdparse .",
-        "build:yarn": "yarn bundle && pkg --output bin/mdparse .",
-        "clear": "rm -rf dist",
-        "premac-deploy": "npm run build",
-        "mac-deploy": "mv bin/mdparse-macos ~/Documents/commands/mdparse",
-        "prewin-deploy": "npm run build",
-        "win-deploy": "mv bin/mdparse-win.exe ../../commands/mdparse.exe",
+        "main": "node bundle/main.js document/main.md -o dist/bundle.md --debug",
+        "debug": "node src/main.js -db document/main.md -o dist/bundle.md",
+        "clear": "rm -rf bundle bin",
         "pretest": "npm run bundle",
-        "pretest:yarn": "yarn bundle",
-        "prepare": "npm run build"
+        "pretest:yarn": "yarn bundle"
     },
     "keywords": [],
     "author": "blitzher",
     "license": "MIT",
     "dependencies": {
-        "@types/chokidar": "^2.1.3",
-        "@types/colors": "^1.2.1",
-        "@types/node": "^15.6.1",
-        "@types/ws": "^8.5.3",
         "argparse": "^2.0.1",
         "chokidar": "^3.5.1",
-        "colors": "^1.4.0",
         "colors.ts": "^1.0.20",
         "marked": "^2.0.1",
+        "node-html-parser": "^6.1.13",
         "require-runtime": "^2.0.0",
         "ws": "^8.8.1"
     },
     "devDependencies": {
+        "@types/argparse": "^2.0.16",
+        "@types/chokidar": "^2.1.3",
+        "@types/colors": "^1.2.1",
+        "@types/node": "^15.6.1",
+        "@types/ws": "^8.5.3",
         "cloc": "^2.7.0",
         "mocha": "^8.3.1",
-        "pkg": "^4.4.9",
         "prettier": "^2.3.0",
         "typescript": "^4.3.2"
     }

package/src/cltool.ts

@@ -2,21 +2,19 @@ const fs = require("fs"); /* for handling reading of files */
 const path = require("path"); /* for handling file paths */
 
 import Colors = require("colors.ts"); /* for adding colours to strings */
-import Parser from "./parse";
-import { WebSocketServer } from "ws";
+import { TargetType } from "./commands";
+import Parser from "./parser";
 
 Colors.enable();
-const { ArgumentParser } = require("argparse"); /* for parsing clargs */
+import { ArgumentParser } from "argparse"; /* for parsing clargs */
 const { version } = require("../package.json"); /* package version number */
-const choki = require("chokidar");
 
 export const argParser = new ArgumentParser({
-    description: "Markdown bundler, with extra options. Extension file is loaded from ./extensions.js, if it exists",
+    description:
+        "Markdown bundler, with extra options. Extension file is loaded from ./extensions.js, if it exists",
     prog: "mdparse",
 });
 
-const configFileName = ".mdmconfig.json";
-
 //#region command line args
 argParser.add_argument("src", {
     help: "file to be parsed. If this is a directory, it looks for entry point in the directory, see --entry",
@@ -66,103 +64,47 @@ argParser.add_argument("--allow-undefined", "-A", {
 });
 //#endregion
 
-function main() {
-    let clargs, fileargs;
-    let server: WebSocketServer | undefined;
-
-    /* Read config file or parse args from cmd-line */
-    if (fs.existsSync(configFileName)) {
-        let data: { [key: string]: string | boolean | number } = JSON.parse(fs.readFileSync(configFileName)).opts;
-
-        let args: (string | number)[] = [];
-        Object.entries(data).forEach(([key, value]) => {
-            if (key != "src" && value !== false) {
-                args.push("--" + key);
-            }
-            if (typeof value != "boolean") {
-                args.push(value);
-            }
-        });
-
-        /* We skip [0] and [1], as  it is the binary and source file, even when compiled*/
-        for (let i = 2; i < process.argv.length; i++) args.push(process.argv[i]);
-
-        clargs = argParser.parse_args(args);
-    } else {
-        clargs = argParser.parse_args();
-    }
-
-    /* if src is init, create config file and exit */
-    if (clargs.src == "init") {
-        const template = fs.readFileSync(path.join(__dirname, "..", "src", "templates", "configTemplate.json"));
-        fs.writeFileSync(configFileName, template);
-        fs.writeFileSync("main.md", "# Main\n");
-        return;
-    }
-
-    /* helper method for calling parser */
-    const compile = (source, output, cb?) => {
-        /* load data from file, if it exists,
-         * otherwise, interpret as string */
-
-        const parser = new Parser(source, clargs);
-        parser.to(output, (file) => {
-            console.log(`Compiled ${file}`.green);
-            if (cb) cb();
-        });
-        return parser;
+export type CLArgs = {
+    src: string;
+    output: string;
+    verbose: boolean;
+    debug: boolean;
+    max_depth: number;
+    entry: string;
+    watch: boolean;
+    use_underscore: boolean;
+    toc_level: number;
+    html: boolean;
+    allow_undefined: boolean;
+};
+
+export type ParserOptions = {
+    defs: {
+        [key: string]: string;
     };
-
-    const internalCooldown = 1000;
-    function watcher(event, path) {
-        const 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, () => {
-                /* after compile, send refresh command to clients */
-                server.clients.forEach((client) => {
-                    if (client.OPEN) client.send("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);
-    }
-
-    if (clargs.debug) console.dir(clargs);
-
-    /* compile once */
-    if (!clargs.watch) compile(clargs.src, clargs.output);
-    /* watch the folder and recompile on change */
-    else {
-        const srcDirName = path.dirname(clargs.src);
-        console.log(`Watching ${srcDirName} for changes...`.yellow);
-        server = new WebSocketServer({ port: 7788 });
-
-        const _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();
+    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;
+};

package/src/commands.ts

@@ -1,8 +1,9 @@
 import * as path from "path";
-import Parser from "./parse";
+import Parser from "./parser";
 import * as fs from "fs";
 import templates, { new_template } from "./templates";
 import requireRuntime from "require-runtime";
+import * as nodeHtmlParser from "node-html-parser";
 
 export class MDMError extends Error {
     match: RegExpMatchArray;
@@ -128,7 +129,7 @@ new Command(
 
         const recursiveParser = new Parser(
             path.join(parser.wd, name),
-            parser.opts,
+            parser.clargs,
             {
                 parent: parser,
             }
@@ -207,12 +208,65 @@ new Command(
     CommandType.PARSE
 );
 
+/* mdmaketoc */
 new Command(
     /#mdmaketoc(?:<>)?/,
     (match, parser) => parser.gen_toc(),
     CommandType.POSTPARSE
 );
 
+/* basic mdhook */
+new Command(
+    /#mdhook<(\w+)>/,
+    (match, parser) => {
+        if (parser.opts.hooks[match[1]]) {
+            return parser.opts.hooks[match[1]]();
+        }
+    },
+    CommandType.POSTPARSE
+);
+
+/* mdadvhook */
+new Command(
+    /\#mdadvhook<(\w+)>([\w\W]+?)\#mdendhook/,
+    (match, parser) => {
+        if (parser.opts.adv_hooks[match[1]]) {
+            const innerElements = match[2].trim();
+            /* Find tagNames in innerElements */
+            const re = /<(\w+)[\s=\w\"\'-]*>/g;
+            const tags = [];
+            innerElements.match(re)?.forEach((tag) => {
+                tags.push(tag.slice(1, -1).split(" ")[0]);
+            });
+            /* Evil type hack */
+            const root = nodeHtmlParser.parse(innerElements, {
+                voidTag: {
+                    tags,
+                    closingSlash: true,
+                },
+            }) as any as HTMLElement;
+
+            const helper = (node: HTMLElement) => {
+                /*  */
+                const map: { [tag: string]: HTMLElement } = {};
+                for (let tag of tags) {
+                    const el = node.getElementsByTagName(tag)[0];
+                    const dataTag = el.toString().match(/data-tag="([\w-]+)"/);
+                    if (!dataTag || dataTag[1] == undefined) continue;
+                    el.tagName = dataTag[1];
+                    el.removeAttribute("data-tag");
+                    map[tag] = el;
+                }
+                return map;
+            };
+
+            const hooked = parser.opts.adv_hooks[match[1]](root, helper(root));
+            return hooked.toString();
+        }
+    },
+    CommandType.POSTPARSE
+);
+
 const loaded_extentions: fs.PathLike[] = [];
 
 function load_extension(parser: Parser, file: fs.PathLike) {

package/src/main.ts

@@ -0,0 +1,122 @@
+import path from "path";
+import { WebSocketServer } from "ws";
+import Parser from "./parser";
+import * as fs from "fs";
+const choki = require("chokidar");
+
+import { argParser, CLArgs as CommmandLineArgs, ParserOptions } from "./cltool";
+const configFileName = ".mdmconfig.json";
+
+function main() {
+    let clargs: CommmandLineArgs;
+    let server: WebSocketServer | undefined;
+
+    /* Read config file or parse args from cmd-line */
+    if (fs.existsSync(configFileName)) {
+        let data: CommmandLineArgs = JSON.parse(
+            fs.readFileSync(configFileName).toString()
+        ).opts;
+
+        let args: (string | number)[] = [];
+        Object.entries(data).forEach(([key, value]) => {
+            if (key != "src" && value !== false) {
+                args.push("--" + key);
+            }
+            if (typeof value != "boolean") {
+                args.push(value);
+            }
+        });
+
+        /* We skip [0] and [1], as  it is the binary and source file, even when compiled*/
+        for (let i = 2; i < process.argv.length; i++)
+            args.push(process.argv[i]);
+
+        clargs = argParser.parse_args(args.map((x) => x.toString()));
+    } else {
+        clargs = argParser.parse_args();
+    }
+
+    /* if src is init, create config file and exit */
+    if (clargs.src == "init") {
+        const template = fs.readFileSync(
+            path.join(
+                __dirname,
+                "..",
+                "src",
+                "templates",
+                "configTemplate.json"
+            )
+        );
+        fs.writeFileSync(configFileName, template);
+        fs.writeFileSync("main.md", "# Main\n");
+        return;
+    }
+
+    /* helper method for calling parser */
+    const compile = (source, output, cb?) => {
+        /* load data from file, if it exists,
+         * otherwise, interpret as string */
+
+        const parser = new Parser(source, clargs);
+        parser.to(output, (file) => {
+            console.log(`Compiled ${file}`.green);
+            if (cb) cb();
+        });
+        return parser;
+    };
+
+    const internalCooldown = 1000;
+    function watcher(event, path) {
+        const 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, () => {
+                /* after compile, send refresh command to clients */
+                server.clients.forEach((client) => {
+                    if (client.OPEN) client.send("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);
+    }
+
+    if (clargs.debug) console.dir(clargs);
+
+    /* compile once */
+    if (!clargs.watch) compile(clargs.src, clargs.output);
+    /* watch the folder and recompile on change */ else {
+        const srcDirName = path.dirname(clargs.src);
+        console.log(`Watching ${srcDirName} for changes...`.yellow);
+        server = new WebSocketServer({ port: 7788 });
+
+        const _watcher = choki.watch(srcDirName).on("all", watcher);
+        try {
+            compile(clargs.src, clargs.output);
+        } catch (e) {
+            console.log(e.message);
+        }
+    }
+}
+export default {
+    Parser,
+};
+/* main entrypoint */
+if (require.main === module) {
+    main();
+}

package/src/{parse.ts → parser.ts}

@@ -1,10 +1,12 @@
-const fs = require("fs"); /* for handling reading of files */
-const path = require("path"); /* for handling file paths */
+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();
-const marked = require("marked");
+import marked from "marked";
+
 import { Command, commands, load_extensions, MDMError } from "./commands";
+import { argParser, CLArgs as CommandLineArgs, ParserOptions } from "./cltool";
 
 enum TargetType {
     HTML,
@@ -22,36 +24,15 @@ class Parser {
     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;
-        isFileCallback: (s: string) => false | string;
-    };
+    opts: ParserOptions;
+    clargs: CommandLineArgs;
     raw: string;
 
     static TOKEN = "#md";
 
     constructor(
-        filename,
-        clargs,
+        filename: string,
+        clargs?: CommandLineArgs,
         opts?: {
             parent?: Parser;
             isFileCallback?: (s: string) => false | string;
@@ -73,6 +54,7 @@ class Parser {
         this.blobs = {};
 
         /* all options */
+        this.clargs = clargs;
         this.opts = {
             defs: {},
             secs: [],
@@ -89,6 +71,8 @@ class Parser {
             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";
@@ -96,7 +80,7 @@ class Parser {
         };
 
         if (!clargs) {
-            clargs = {};
+            clargs = argParser.parse_args([filename]);
         }
 
         /* append all commandline arguments to this */
@@ -237,13 +221,27 @@ class Parser {
             const link = this.titleId(title);
 
             let __line =
-                hor.repeat(Math.max(sec.level - 1, 0)) + beg + `[${title}](#${link})`;
+                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;
     }
@@ -258,7 +256,7 @@ class Parser {
     /* output the parsed document to bundle */
     to(bundleName: string, callback: (fileName: string) => void) {
         const dir = path.dirname(bundleName);
-        if (callback === undefined) callback = () => { };
+        if (callback === undefined) callback = () => {};
 
         if (!fs.existsSync(dir)) {
             fs.mkdirSync(dir, { recursive: true });
@@ -268,11 +266,11 @@ class Parser {
             this.get(TargetType.MARKDOWN, (blob) => {
                 fs.writeFile(bundleName, blob, () => callback(bundleName));
             });
-        }
-
-        else {
+        } else {
             const htmlFileName = bundleName.replace(".md", ".html");
-            fs.writeFile(htmlFileName, this.html(), () => callback(htmlFileName));
+            fs.writeFile(htmlFileName, this.html(), () =>
+                callback(htmlFileName)
+            );
         }
     }
 
@@ -301,7 +299,7 @@ class Parser {
                 let blob = this.parse();
                 this.opts.targetType = undefined;
                 if (callback) callback(blob);
-                return blob
+                return blob;
             } catch (error) {
                 /* Compile a traceback of error */
                 let traceback = "";
@@ -312,7 +310,9 @@ class Parser {
                         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);
+                    else
+                        traceback +=
+                            `\n...on line ${p.line_num} in ${p.file}`.grey(15);
                     if (p.parent) p = p.parent;
                 } while (p.parent);
 
@@ -353,7 +353,8 @@ marked.use({
             const id = args.filter((arg) => arg.startsWith("#"));
 
             const classNames = classes.map((c) => c.slice(1));
-            const classText = classes.length > 0 ? `class="${classNames.join(" ")}"` : "";
+            const classText =
+                classes.length > 0 ? `class="${classNames.join(" ")}"` : "";
             const idText = id.length > 0 ? `id="${id[0].slice(1)}"` : "";
 
             /* remove the ending from the quote */

package/test/advanced.test.js

@@ -10,7 +10,6 @@ const putTemplate = () => {
 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>`;
 
@@ -18,7 +17,6 @@ describe("Use of templates", () => {
     });
 
     it("should use custom templates from project extensions.js file", () => {
-        putTemplate();
         util.put("#mdtemplate<hi>", "sample1.md");
 
         util.assert.strictEqual(
@@ -28,7 +26,6 @@ describe("Use of templates", () => {
     });
 
     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");