markdown-maker 1.9.1 → 1.10.0

package/src/parse.ts

@@ -55,7 +55,7 @@ class Parser {
         opts?: {
             parent?: Parser;
             isFileCallback?: (s: string) => false | string;
-        },
+        }
     ) {
         /* this.working_directory */
         this.file = filename;
@@ -116,8 +116,8 @@ class Parser {
             console.log(
                 Colors.colors(
                     "magenta",
-                    "parsing " + this.file + ": depth=" + this.opts.depth,
-                ),
+                    "parsing " + this.file + ": depth=" + this.opts.depth
+                )
             );
         }
 
@@ -200,7 +200,7 @@ class Parser {
             /* Add global flag to RegExp */
             const re = new RegExp(
                 command.validator.source,
-                (command.validator.flags || "") + "g",
+                (command.validator.flags || "") + "g"
             );
             blob = blob.replace(re, (...args) => command.act(args, this) || "");
         });
@@ -237,9 +237,7 @@ 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);
         });
@@ -260,27 +258,21 @@ class Parser {
     /* output the parsed document to bundle */
     to(bundleName: string, callback: (fileName: string) => void) {
         const dir = path.dirname(bundleName);
-        var called = false;
-        if (callback === undefined) callback = () => {};
+        if (callback === undefined) callback = () => { };
 
         if (!fs.existsSync(dir)) {
-            fs.mkdirSync(dir);
+            fs.mkdirSync(dir, { recursive: true });
         }
-        this.get(TargetType.MARKDOWN, (blob) => {
-            fs.writeFile(bundleName, blob, () => {
-                if (!this.opts.html) {
-                    callback(bundleName);
-                    called = true;
-                }
+
+        if (!this.opts.html) {
+            this.get(TargetType.MARKDOWN, (blob) => {
+                fs.writeFile(bundleName, blob, () => callback(bundleName));
             });
-        });
+        }
 
-        if (this.opts.html) {
+        else {
             const htmlFileName = bundleName.replace(".md", ".html");
-            fs.writeFile(htmlFileName, this.html(), () => {
-                if (!called) callback(htmlFileName);
-                called = true;
-            });
+            fs.writeFile(htmlFileName, this.html(), () => callback(htmlFileName));
         }
     }
 
@@ -295,7 +287,7 @@ class Parser {
         return htmlFormatted;
     }
 
-    get(targetType?: TargetType, callback?) {
+    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]) {
@@ -309,26 +301,24 @@ 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 = "";
-
                 let p: Parser = this;
 
                 do {
                     if (error instanceof MDMError)
                         traceback += `\n...on line ${p.line_num_from_index(
-                            error.match.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);
 
                 error.message += traceback;
 
-                /* only interested in stacktrace, when debugging */
+                /* only interested in node stacktrace when debugging */
                 if (!this.opts.debug) error.stack = "";
 
                 if (this.opts.only_warn) console.error(error);
@@ -342,14 +332,14 @@ export function splice(
     str: string,
     startIndex: number,
     width: number,
-    newSubStr: string,
+    newSubStr: string
 ) {
     const start = str.slice(0, startIndex);
     const end = str.slice(startIndex + width);
     return start + newSubStr + end;
 }
 
-/* add extention to marked */
+/* add extention to marked for classed blockquotes*/
 marked.use({
     renderer: {
         blockquote(quote) {
@@ -363,8 +353,7 @@ 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/src/templates/configTemplate.json

@@ -0,0 +1,13 @@
+{
+	"opts": {
+		"src": "main.md",
+		"verbose": false,
+		"debug": false,
+		"output": "dist/bundle.md",
+		"max-depth": 3,
+		"toc-level": 3,
+		"watch": false,
+		"html": false,
+		"allow-undefined": false
+	}
+}

package/test/advanced.test.js

@@ -1,12 +1,16 @@
 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"
-);
+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>`;
 
@@ -14,22 +18,20 @@ describe("Use of templates", () => {
     });
 
     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"
         );
-
-        /* make sure to remove after, to not mess with future tests */
     });
 
     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");
-
-        /* make sure to remove after, to not mess with future tests */
     });
 });

package/test/basic.test.js

@@ -1,3 +1,4 @@
+const path = require("path");
 const util = require("./tester.test.js");
 
 describe("Basic features", () => {
@@ -54,4 +55,14 @@ describe("Basic features", () => {
 
         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/errors.test.js

@@ -1,5 +1,5 @@
-const { Parser } = require("marked");
 const util = require("./tester.test.js");
+const fs = require("fs");
 
 describe("Error handling", () => {
     it("should dissallow undefined templates", () => {
@@ -23,4 +23,26 @@ describe("Error handling", () => {
 
         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

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

package/test/tester.test.js

@@ -1,8 +1,7 @@
 const fs = require("fs");
 const assert = require("assert");
 const Parser = require("../build/parse");
-
-
+const path = require("path");
 
 /* make folder for temporary files, if it doesn't exist */
 if (
@@ -12,8 +11,16 @@ if (
     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("test/test-files/" + file, text);
+    fs.writeFileSync(path.join("test", "test-files", file), text);
+}
+function putDir(name) {
+    fs.mkdirSync(path.join("test", "test-files", name));
 }
 
 const TargetType = {
@@ -24,7 +31,9 @@ const TargetType = {
 module.exports = {
     fs,
     assert,
+    path,
     Parser,
     put,
+    putDir,
     TargetType,
 };