npm - markdown-maker - Versions diffs - 1.10.1 → 1.10.3 - Mend

markdown-maker 1.10.1 → 1.10.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (39) hide show

package/.github/workflows/node.js.yml +21 -26
package/.vscode/extensions.json +3 -0
package/.vscode/launch.json +4 -22
package/.vscode/settings.json +8 -3
package/.vscode/snippets.code-snippets +6 -8
package/jest.config.js +7 -0
package/package.json +41 -64
package/src/cltool.ts +119 -135
package/src/commands.ts +238 -244
package/src/errors.ts +26 -0
package/src/main.ts +123 -0
package/src/parser.ts +398 -0
package/src/templates.ts +5 -1
package/src/types.ts +33 -0
package/tests/_test-util.ts +44 -0
package/tests/advanced.spec.ts +92 -0
package/tests/basic.spec.ts +68 -0
package/tests/clargs.spec.ts +50 -0
package/tests/errors.spec.ts +64 -0
package/tests/html.spec.ts +23 -0
package/tests/line.spec.ts +21 -0
package/tests/marked.spec.ts +40 -0
package/tests/target.spec.ts +41 -0
package/tests/vars.spec.ts +45 -0
package/tsconfig.json +66 -64
package/prettierrc.yaml +0 -4
package/src/parse.ts +0 -396
package/test/advanced.test.js +0 -37
package/test/basic.test.js +0 -67
package/test/clargs.test.js +0 -51
package/test/errors.test.js +0 -47
package/test/hooks.js +0 -9
package/test/hooks.test.js +0 -114
package/test/html.test.js +0 -37
package/test/line.test.js +0 -21
package/test/marked.test.js +0 -43
package/test/target.test.js +0 -43
package/test/tester.test.js +0 -41
package/test/vars.test.js +0 -49

package/test/hooks.test.js DELETED Viewed

@@ -1,114 +0,0 @@
-const util = require("./tester.test.js");
-describe("Use of markdown hooks for SSR", () => {
-    it("should allow a simple hook to be used", () => {
-        util.put("#mdhook<test>", "sample1.md");
-        const parser = new util.Parser("test/test-files/sample1.md");
-        parser.add_hook("test", () => "hello");
-        const output = parser.get();
-        util.assert.strictEqual(output, "hello\n\n");
-    });
-    it("should allow advanced hooks to be used", () => {
-        util.put(
-            "#mdadvhook<test>\n<b>Bold</b>\n<p>Paragraph</p>\n#mdendhook",
-            "sample1.md"
-        );
-        const replacer = (arg) => {
-            const elem = new util.html.HTMLElement("p", {});
-            elem.set_content("complete");
-            return elem;
-        };
-        const parser = new util.Parser("test/test-files/sample1.md");
-        parser.opts.allow_undefined = true;
-        parser.add_adv_hook("test", replacer);
-        const output = parser.get();
-        util.assert.strictEqual(output, "<p>complete</p>\n\n");
-    });
-    it("should allow for hooks to be used in HTML", () => {
-        util.put("<html><body>#mdhook<test></body></html>", "sample1.html");
-        const parser = new util.Parser("test/test-files/sample1.html");
-        parser.opts.allow_undefined = true;
-        parser.add_hook("test", () => "hello");
-        const output = parser.get();
-        util.assert.strictEqual(output, "<html><body>hello</body></html>\n\n");
-    });
-    it("should allow for hooks to be used in HTML with advanced hooks", () => {
-        util.put(
-            "<html><body>#mdadvhook<test>\n<b>Bold</b>\n<p>Paragraph</p>\n#mdendhook</body></html>",
-            "sample1.html"
-        );
-        const replacer = (arg) => {
-            const elem = new util.html.HTMLElement("p", {});
-            elem.set_content("complete");
-            return elem;
-        };
-        const parser = new util.Parser("test/test-files/sample1.html");
-        parser.opts.allow_undefined = true;
-        parser.add_adv_hook("test", replacer);
-        const output = parser.get();
-        util.assert.strictEqual(
-            output,
-            "<html><body><p>complete</p></body></html>\n\n"
-        );
-    });
-    it("should allow for extracting a node from the document as a template manually with ids", () => {
-        util.put(
-            `<html><body>#mdadvhook<template><name id="b"></name><class id="p"></class>#mdendhook</body></html>`,
-            "sample1.html"
-        );
-        const replacer = (elem) => {
-            const nameElem = elem.getElementsByTagName("name")[0];
-            nameElem.tagName = nameElem.id;
-            nameElem.removeAttribute("id");
-            nameElem.set_content("bold");
-            const classElem = elem.getElementsByTagName("class")[0];
-            classElem.tagName = classElem.id;
-            classElem.removeAttribute("id");
-            classElem.set_content("paragraph");
-            return elem;
-        };
-        const parser = new util.Parser("test/test-files/sample1.html");
-        parser.opts.allow_undefined = true;
-        parser.add_adv_hook("template", replacer);
-        const output = parser.get();
-        util.assert.strictEqual(
-            output,
-            "<html><body><b>bold</b><p>paragraph</p></body></html>\n\n"
-        );
-    });
-    it("should allow for extracting a node from the document as a template using map and data-tags", () => {
-        util.put(
-            `<html><body>#mdadvhook<template><name data-tag="b"></name><class data-tag="p"></class>#mdendhook</body></html>`,
-            "sample1.html"
-        );
-        const replacer = (elem, map) => {
-            map["name"].set_content("bold");
-            map["class"].set_content("paragraph");
-            return elem;
-        };
-        const parser = new util.Parser("test/test-files/sample1.html");
-        parser.opts.allow_undefined = true;
-        parser.add_adv_hook("template", replacer);
-        const output = parser.get();
-        util.assert.strictEqual(
-            output,
-            "<html><body><b>bold</b><p>paragraph</p></body></html>\n\n"
-        );
-    });
-});

package/test/html.test.js DELETED Viewed

@@ -1,37 +0,0 @@
-const util = require("./tester.test.js");
-describe("HTML Emitting", () => {
-    it("should emit an html file", (done) => {
-        const parser = new util.Parser("# sum title\nand a paragraph");
-        parser.opts.html = true;
-        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
-            );
-            done();
-        });
-    });
-    it("should generate valid html", () => {
-        const parser = new util.Parser("# cool title\nwith a cool paragraph");
-        parser.opts.html = true;
-        const output = parser.html();
-        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");
-        util.put("#mdvar<lul>", "sample2.html");
-        const parser = new util.Parser("test/test-files/sample1.md");
-        const output = parser.get();
-        util.assert.strictEqual(output, "#mdvar<lul>\n\n");
-    });
-});

package/test/line.test.js DELETED Viewed

@@ -1,21 +0,0 @@
-const util = require("./tester.test");
-describe("Managing blank lines", () => {
-    it("should always end with 2 blank lines, even with no input", () => {
-        const output = new util.Parser("").get();
-        util.assert.strictEqual(output, "\n\n");
-    });
-    it("should reduce blank lines to 2", () => {
-        const output1 = new util.Parser("\n\n\n\n").get();
-        util.assert.strictEqual(output1, "\n\n");
-        const output2 = new util.Parser("\n\n\n\nHello!").get();
-        util.assert.strictEqual(output2, "\n\nHello!\n\n");
-    });
-    it("should allow words when removing blank lines", () => {
-        const output = new util.Parser("hii\n\n\n").get();
-        util.assert.strictEqual(output, "hii\n\n");
-    });
-});

package/test/marked.test.js DELETED Viewed

@@ -1,43 +0,0 @@
-const util = require("./tester.test.js");
-describe("Marked extentions", () => {
-    it("should add a single class to blockquotes", () => {
-        const parser = new util.Parser("> hello {.one}", {
-            use_underscore: true,
-            html: true,
-        });
-        const output = parser.html();
-        util.assert.strictEqual(
-            output,
-            '<blockquote class="one" >\n<p>hello </p></blockquote>'
-        );
-    });
-    it("should add multiple class to blockquotes", () => {
-        const parser = new util.Parser("> hello {.one .two}", {
-            use_underscore: true,
-            html: true,
-        });
-        const output = parser.html();
-        util.assert.strictEqual(
-            output,
-            '<blockquote class="one two" >\n<p>hello </p></blockquote>'
-        );
-    });
-    it("should add a single class and id to blockquotes", () => {
-        const parser = new util.Parser("> hello {.one #myid}", {
-            use_underscore: true,
-            html: true,
-        });
-        const output = parser.html();
-        util.assert.strictEqual(
-            output,
-            '<blockquote class="one" id="myid">\n<p>hello </p></blockquote>'
-        );
-    });
-});

package/test/target.test.js DELETED Viewed

@@ -1,43 +0,0 @@
-const util = require("./tester.test.js");
-describe("Target specific functionality", () => {
-    describe("HTML", () => {
-        it("Should include `#mdlabel` command, when compiling HTML", () => {
-            const parser = new util.Parser("#mdlabel<0,Cool!>");
-            const html = parser.get(util.TargetType.HTML);
-            util.assert.strictEqual(html, '<span id="cool"></span>\n\n');
-        });
-        it("Should link to sections with #mdref", () => {
-            const parser = new util.Parser(
-                "#mdlabel<0,Cool!>\n#mdlabel<1,coolzz>\n#mdref<Cool!>"
-            );
-            const html = parser.get(util.TargetType.HTML);
-            util.assert.strictEqual(
-                html,
-                '<span id="cool"></span>\n<span id="coolzz"></span>\n<a href="#cool">Cool!</a>\n\n'
-            );
-        });
-    });
-    describe("Markdown", () => {
-        it("Should not include `#mdlabel` command, when compiling Markdown", () => {
-            const parser = new util.Parser("#mdlabel<0,Cool!>");
-            const md = parser.get(util.TargetType.MARKDOWN);
-            util.assert.strictEqual(md, "\n\n");
-        });
-        it("Should include #mdref to title elements in markdown", () => {
-            const output = new util.Parser(
-                "# Some Title!\n#mdref<Some Title!>"
-            ).get();
-            util.assert.strictEqual(
-                output,
-                "# Some Title!\n[Some Title!](#some-title)\n\n"
-            );
-        });
-    });
-});

package/test/tester.test.js DELETED Viewed

@@ -1,41 +0,0 @@
-const fs = require("fs");
-const assert = require("assert");
-const Parser = require("../build/parse");
-const path = require("path");
-const html = require("node-html-parser");
-/* make folder for temporary files, if it doesn't exist */
-if (
-    !fs.existsSync("test/test-files") ||
-    !fs.lstatSync("test/test-files").isDirectory()
-) {
-    fs.mkdirSync("test/test-files");
-}
-/**
- * Create a new file under `test/test-files` with the given content.
- * @param {string} text
- * @param {string} file
- */
-function put(text, file) {
-    fs.writeFileSync(path.join("test", "test-files", file), text);
-}
-function putDir(name) {
-    fs.mkdirSync(path.join("test", "test-files", name));
-}
-const TargetType = {
-    HTML: 0,
-    MARKDOWN: 1,
-};
-module.exports = {
-    assert,
-    fs,
-    html,
-    path,
-    Parser,
-    put,
-    putDir,
-    TargetType,
-};

package/test/vars.test.js DELETED Viewed

@@ -1,49 +0,0 @@
-const util = require("./tester.test.js");
-describe("Use variables", () => {
-    it("should replace var with the value", () => {
-        const output = new util.Parser("#mddef<hi=yo>\n#mdvar<hi>").get();
-        util.assert.strictEqual(output, "\nyo\n\n");
-    });
-    it("should use variable shorthand", () => {
-        const output = new util.Parser("#mddef<hi=yo>\n<hi>").get();
-        util.assert.strictEqual(output, "\nyo\n\n");
-    });
-    it("should use variables across files", () => {
-        util.put("#mddef<hi=yo>\n#mdinclude<sample2.md>", "sample1.md");
-        util.put("<hi>", "sample2.md");
-        const output = new util.Parser("test/test-files/sample1.md").get();
-        util.assert.strictEqual(output, "\nyo\n\n");
-    });
-    it("should throw if undefined variable", () => {
-        const parser = new util.Parser("<yo>");
-        let e;
-        /* should throw an error */
-        util.assert.throws(() => {
-            try {
-                parser.get();
-            } catch (_e) {
-                e = _e;
-                throw _e;
-            }
-        });
-    });
-    it("should preserve whatever comes after", () => {
-        const output = new util.Parser("#mddef<hi=yo>\n<hi>,").get();
-        util.assert.strictEqual(output, "\nyo,\n\n");
-    });
-    it("should replace underscore with space", () => {
-        const output = new util.Parser(
-            "#mddef<name=Mr_Sir>\n#mdvar<name>"
-        ).get();
-        util.assert.strictEqual(output, "\nMr Sir\n\n");
-    });
-});