markdown-maker 1.10.1 → 1.10.3

package/tests/basic.spec.ts

@@ -0,0 +1,68 @@
+import util from "./_test-util";
+import { MDMError } from "../src/errors";
+
+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("tests/test-files/sample1.md");
+		const output = parser.get();
+
+		util.expect(output).toEqual("hello\nthere\n\n");
+	});
+	it("should make a table of contents", () => {
+		const output = new util.Parser(
+			"# yo\n## bruh nugget\n#mdmaketoc"
+		).get();
+
+		util.expect(output).toBe(
+			"# 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.expect(markdown).toBe(
+			"# 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.expect(output).toBe(
+			"\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");
+
+		function get() {
+			const parser = new util.Parser("tests/test-files/sample1.md", {
+				max_depth: 0,
+			});
+			parser.get();
+		}
+
+		util.expect(get).toThrow(MDMError);
+	});
+	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.expect(parser.get()).toBe("### 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("tests/test-files/sample1.md");
+		const output = parser.get();
+
+		util.expect(output).toBe("hello\n\n");
+	});
+});

package/tests/clargs.spec.ts

@@ -0,0 +1,50 @@
+import util from "./_test-util";
+
+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.expect(output).toBe("# 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.expect(output).toBe(
+			"# 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.expect(output).toBe("<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("tests/test-files/sample1.md");
+		parser.opts.args.push("YES");
+
+		const output = parser.get();
+
+		util.expect(output).toBe("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("tests/test-files/sample1.md");
+
+		const output = parser.get();
+
+		util.expect(output).toBe("hello\n\n");
+	});
+});

package/tests/errors.spec.ts

@@ -0,0 +1,64 @@
+import { MDMError, MDMNonParserError } from "../src/errors";
+import util from "./_test-util";
+
+describe("Error handling", () => {
+	it("should dissallow undefined templates", () => {
+		util.put("#mdtemplate<UNDEF>", "sample1.md");
+
+		const parser = new util.Parser("tests/test-files/sample1.md");
+
+		let answer =
+			'Template "UNDEF" not found!' +
+			"\n...on line 1 in tests/test-files/sample1.md".grey(15);
+
+		util.expect(() => parser.get()).toThrow(MDMError);
+	});
+	it("should dissallow loading a folder without an entry file", () => {
+		util.put("#mdinclude<sample_fld>", "sample1.md");
+		util.putDir("sample_fld");
+
+		function get() {
+			const parser = new util.Parser("tests/test-files/sample1.md");
+			parser.get();
+		}
+
+		let answer =
+			'No entry file found in folder "sample_fld". Looking for "tests/test-files/sample_fld/sample_fld.md"' +
+			"\n...on line 1 in tests/test-files/sample1.md".grey(15);
+
+		util.expect(get).toThrow(MDMError);
+		util.expect(get).toThrow(answer);
+	});
+	it("should dissallow adding more than one hook with the same name", () => {
+		const parser = new util.Parser("tests/test-files/sample1.md");
+
+		parser.add_hook("test", () => {});
+		util.expect(() => parser.add_hook("test", () => {})).toThrow(
+			MDMNonParserError
+		);
+	});
+	describe("Duplicate key errors", () => {
+		it("should dissallow adding more than one template with the same name", () => {
+			/*  */
+			util.put(
+				`module.exports = {main: (new_template, new_command) =>
+					{
+						new_template('test', 'hello');
+						new_template('test', 'hello');
+					}
+				};`,
+				"extensions.js"
+			);
+
+			util.put("", "sample1.md");
+
+			function get() {
+				const parser = new util.Parser("tests/test-files/sample1.md");
+				parser.get();
+			}
+
+			util.expect(get).toThrow(MDMNonParserError);
+			util.expect(get).toThrow('Template "test" already exists');
+		});
+	});
+});

package/tests/html.spec.ts

@@ -0,0 +1,23 @@
+import util from "./_test-util";
+
+describe("HTML Emitting", () => {
+	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.expect(output).toBe(
+			'<h1 id="cool-title">cool title</h1><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("tests/test-files/sample1.md");
+		const output = parser.get();
+
+		util.expect(output).toBe("#mdvar<lul>\n\n");
+	});
+});

package/tests/line.spec.ts

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

package/tests/marked.spec.ts

@@ -0,0 +1,40 @@
+import util from "./_test-util";
+
+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.expect(output).toBe(
+			'<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.expect(output).toBe(
+			'<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.expect(output).toBe(
+			'<blockquote class="one" id="myid">\n<p>hello </p></blockquote>'
+		);
+	});
+});

package/tests/target.spec.ts

@@ -0,0 +1,41 @@
+import util from "./_test-util";
+
+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.expect(html).toBe('<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.expect(html).toBe(
+				'<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.expect(md).toBe("\n\n");
+		});
+		it("Should include #mdref to title elements in markdown", () => {
+			const output = new util.Parser(
+				"# Some Title!\n#mdref<Some Title!>"
+			).get();
+
+			util.expect(output).toBe(
+				"# Some Title!\n[Some Title!](#some-title)\n\n"
+			);
+		});
+	});
+});

package/tests/vars.spec.ts

@@ -0,0 +1,45 @@
+import { MDMError } from "../src/errors";
+import util from "./_test-util";
+
+describe("Use variables", () => {
+	it("should replace var with the value", () => {
+		const output = new util.Parser("#mddef<hi=yo>\n#mdvar<hi>").get();
+
+		util.expect(output).toBe("\nyo\n\n");
+	});
+	it("should use variable shorthand", () => {
+		const output = new util.Parser("#mddef<hi=yo>\n!<hi>").get();
+
+		util.expect(output).toBe("\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("tests/test-files/sample1.md").get();
+
+		util.expect(output).toBe("\nyo\n\n");
+	});
+	it("should throw if undefined variable", () => {
+		const parser = new util.Parser("!<yo>");
+
+		/* should throw an error */
+		function get() {
+			parser.get();
+		}
+		util.expect(get).toThrow();
+	});
+
+	it("should preserve whatever comes after", () => {
+		const output = new util.Parser("#mddef<hi=yo>\n!<hi>,").get();
+		util.expect(output).toBe("\nyo,\n\n");
+	});
+
+	it("should replace underscore with space", () => {
+		const output = new util.Parser(
+			"#mddef<name=Mr_Sir>\n#mdvar<name>"
+		).get();
+
+		util.expect(output).toBe("\nMr Sir\n\n");
+	});
+});

package/tsconfig.json

@@ -1,74 +1,76 @@
 {
-    "include": ["./src/*"],
+	"include": ["./src/**/*"],
 
-    "compilerOptions": {
-        /* Visit https://aka.ms/tsconfig.json to read more about this file */
+	"compilerOptions": {
+		/* Visit https://aka.ms/tsconfig.json to read more about this file */
 
-        /* Bas1c Options */
-        // "incremental": true,                         /* Enable incremental compilation */
-        "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */,
-        "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
-        // "lib": [],                                   /* Specify library files to be included in the compilation. */
-        "allowJs": true /* Allow javascript files to be compiled. */,
-        // "checkJs": true,                             /* Report errors in .js files. */
-        // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
-        "declaration": true /* Generates corresponding '.d.ts' file. */,
-        // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
-        "sourceMap": true,                              /* Generates corresponding '.map' file. */
-        // "outFile": "./",                             /* Concatenate and emit output to single file. */
-        "outDir": "./build" /* Redirect output structure to the directory. */,
-        // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-        // "composite": true,                           /* Enable project compilation */
-        // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
-        // "removeComments": true,                      /* Do not emit comments to output. */
-        // "noEmit": true,                              /* Do not emit outputs. */
-        // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
-        // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-        // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+		/* Bas1c Options */
+		// "incremental": true,                         /* Enable incremental compilation */
+		"target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */,
+		"module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
+		"lib": [
+			"ES2022"
+		] /* Specify library files to be included in the compilation. */,
+		"allowJs": true /* Allow javascript files to be compiled. */,
+		"checkJs": true /* Report errors in .js files. */,
+		// "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
+		"declaration": true /* Generates corresponding '.d.ts' file. */,
+		// "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
+		"sourceMap": true /* Generates corresponding '.map' file. */,
+		// "outFile": "./",                             /* Concatenate and emit output to single file. */
+		"outDir": "./bundle" /* Redirect output structure to the directory. */,
+		"rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
+		// "composite": true,                           /* Enable project compilation */
+		// "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
+		// "removeComments": true,                      /* Do not emit comments to output. */
+		// "noEmit": true,                              /* Do not emit outputs. */
+		// "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
+		"downlevelIteration": true /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */,
+		// "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
 
-        /* Strict Type-Checking Options */
-        // "strict": true,                                 /* Enable all strict type-checking options. */
-        // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
-        // "strictNullChecks": true,                    /* Enable strict null checks. */
-        // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
-        // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-        // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
-        // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
-        // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
+		/* Strict Type-Checking Options */
+		// "strict": true /* Enable all strict type-checking options. */,
+		// "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
+		// "strictNullChecks": true,                    /* Enable strict null checks. */
+		// "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
+		// "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+		// "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
+		// "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
+		// "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
 
-        /* Additional Checks */
-        // "noUnusedLocals": true,                      /* Report errors on unused locals. */
-        // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
-        // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
-        // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
-        // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
-        // "noImplicitOverride": true,                  /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
-        // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
+		/* Additional Checks */
+		// "noUnusedLocals": true,                      /* Report errors on unused locals. */
+		// "noUnusedParameters": true,                  /* Report errors on unused parameters. */
+		// "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
+		// "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
+		// "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
+		// "noImplicitOverride": true,                  /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
+		// "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
 
-        /* Module Resolution Options */
-        "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
-        // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
-        // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-        // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
-        // "typeRoots": [],                             /* List of folders to include type definitions from. */
-        // "types": [],                                 /* Type declaration files to be included in compilation. */
-        // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-        "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
-        // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
-        // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
+		/* Module Resolution Options */
+		"moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
+		// "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
+		// "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+		// "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
+		// "typeRoots": [],                             /* List of folders to include type definitions from. */
+		// "types": [],                                 /* Type declaration files to be included in compilation. */
+		// "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+		"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+		// "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
+		// "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
 
-        /* Source Map Options */
-        // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-        // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
-        // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
-        // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+		/* Source Map Options */
+		// "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+		// "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
+		// "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
+		// "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
 
-        /* Experimental Options */
-        // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
-        // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
+		/* Experimental Options */
+		// "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
+		// "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
 
-        /* Advanced Options */
-        "skipLibCheck": true /* Skip type checking of declaration files. */,
-        "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
-    }
+		/* Advanced Options */
+		"skipLibCheck": true /* Skip type checking of declaration files. */,
+		"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
+	}
 }

package/prettierrc.yaml

@@ -1,4 +0,0 @@
-trailingComma: all
-tabWidth: 4
-singleQuote: true
-arrowParens: always