markdown-maker 1.10.1 → 1.10.3

package/.github/workflows/node.js.yml

@@ -1,35 +1,30 @@
 # This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
 
-name: Mocha
+name: Jest
 
 on: [push, pull_request]
 
 jobs:
-  build:
+    build:
+        runs-on: ubuntu-latest
 
-    runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                node-version: [20.x, 21.x, 22.x]
+                # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
-    strategy:
-      matrix:
-        node-version: [16.x, 18.x, 20.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: yarn install
-      uses: borales/actions-yarn@v3.0.0
-      with:
-        cmd: install # will run `yarn install` command
-    - name: yarn build
-      uses: borales/actions-yarn@v3.0.0
-      with:
-        cmd: build # will run `yarn build` command
-    - name: yarn test
-      uses: borales/actions-yarn@v3.0.0
-      with:
-        cmd: test # will run `yarn test` command
+        steps:
+            - uses: actions/checkout@v2
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v1
+              with:
+                  node-version: ${{ matrix.node-version }}
+            - name: yarn install
+              uses: borales/actions-yarn@v3.0.0
+              with:
+                  cmd: install # will run `yarn install` command
+            - name: yarn test
+              uses: borales/actions-yarn@v3.0.0
+              with:
+                  cmd: test # will run `yarn test` command

package/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+	"recommendations": ["orta.vscode-jest", "github.vscode-github-actions"]
+}

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/.vscode/settings.json

@@ -1,5 +1,10 @@
 {
-    "editor.formatOnPaste": true,
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "prettier.tabWidth": 4
+	"editor.formatOnPaste": true,
+	"editor.defaultFormatter": "esbenp.prettier-vscode",
+	"prettier.tabWidth": 4,
+	"prettier.useEditorConfig": true,
+	"prettier.configPath": "",
+	"prettier.requireConfig": false,
+	"prettier.useTabs": true,
+	"jest.jestCommandLine": "npx jest -i"
 }

package/.vscode/snippets.code-snippets

@@ -1,9 +1,9 @@
 {
-	// Place your markdown-maker workspace snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and 
-	// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope 
-	// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is 
-	// used to trigger the snippet and the body will be expanded and inserted. Possible variables are: 
-	// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders. 
+	// Place your markdown-maker workspace snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and
+	// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope
+	// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is
+	// used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
+	// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders.
 	// Placeholders with the same ids are connected.
 	// Example:
 	// "Print to console": {
@@ -15,7 +15,7 @@
 	// 	],
 	// 	"description": "Log output to console"
 	// }
-	"MD Command" : {
+	"MD Command": {
 		"scope": "javascript,typescript",
 		"prefix": "cummy",
 		"body": [
@@ -27,6 +27,4 @@
 		],
 		"description": "Snippet for a new command"
 	}
-
 }
-

package/jest.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+	transform: { "^.+\\.ts?$": "ts-jest" },
+	testEnvironment: "node",
+	testRegex: "/tests/.*\\.(test|spec)?\\.(ts|tsx)$",
+	moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
+	maxWorkers: 1,
+};

package/package.json

@@ -1,66 +1,43 @@
 {
-    "name": "markdown-maker",
-    "version": "1.10.1",
-    "description": "",
-    "main": "src/cltool.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"
-        ]
-    },
-    "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",
-        "pretest": "npm run bundle",
-        "pretest:yarn": "yarn bundle",
-        "prepare": "npm run build"
-    },
-    "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": {
-        "cloc": "^2.7.0",
-        "mocha": "^8.3.1",
-        "pkg": "^4.4.9",
-        "prettier": "^2.3.0",
-        "typescript": "^4.3.2"
-    }
+	"name": "markdown-maker",
+	"version": "1.10.3",
+	"description": "A superset-compiler for markdown using marked",
+	"main": "src/main.ts",
+	"bin": {
+		"mdparse": "bundle/main.js"
+	},
+	"scripts": {
+		"test": "jest",
+		"bundle": "tsc --project tsconfig.json",
+		"main": "node bundle/main.js",
+		"clean": "rm -rf bundle bin",
+		"pretest": "npm run bundle"
+	},
+	"keywords": [],
+	"author": "blitzher",
+	"license": "MIT",
+	"dependencies": {
+		"argparse": "^2.0.1",
+		"chokidar": "^3.5.1",
+		"colors.ts": "^1.0.20",
+		"marked": "^12.0.2",
+		"node-html-parser": "^6.1.13",
+		"require-runtime": "^2.0.0",
+		"ts-node": "^10.9.2",
+		"ws": "^8.8.1"
+	},
+	"devDependencies": {
+		"@types/argparse": "^2.0.16",
+		"@types/chokidar": "^2.1.3",
+		"@types/colors": "^1.2.1",
+		"@types/jest": "^29.5.12",
+		"@types/node": "^15.6.1",
+		"@types/ws": "^8.5.3",
+		"@types/xregexp": "^4.4.0",
+		"cloc": "^2.7.0",
+		"jest": "^29.7.0",
+		"prettier": "^2.3.0",
+		"ts-jest": "^29.1.2",
+		"typescript": "^4.3.2"
+	}
 }

package/src/cltool.ts

@@ -1,168 +1,152 @@
-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 */
-import Parser from "./parse";
-import { WebSocketServer } from "ws";
+import { TaggedElement, TargetType } from "./types";
+import Parser from "./parser";
+
+const version = process.env.npm_package_version || "0.0.0";
 
 Colors.enable();
-const { ArgumentParser } = require("argparse"); /* for parsing clargs */
-const { version } = require("../package.json"); /* package version number */
-const choki = require("chokidar");
+import { ArgumentParser } from "argparse"; /* for parsing clargs */
+import { HTMLElement } from "node-html-parser";
 
 export const argParser = new ArgumentParser({
-    description: "Markdown bundler, with extra options. Extension file is loaded from ./extensions.js, if it exists",
-    prog: "mdparse",
+	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",
+	help: "file to be parsed. If this is a directory, it looks for entry point in the directory, see --entry",
+});
+argParser.add_argument("--version", {
+	action: "version",
+	version: `v${version}`,
 });
-argParser.add_argument("--version", { action: "version", version });
 argParser.add_argument("-v", "--verbose", {
-    action: "store_true",
-    help: "enable verbose output",
+	action: "store_true",
+	help: "enable verbose output",
 });
 argParser.add_argument("-D", "--debug", {
-    action: "store_true",
-    help: "enable debugging information",
+	action: "store_true",
+	help: "enable debugging information",
 });
 argParser.add_argument("-o", "--output", {
-    help: "destination of bundle, by default is 'dist/bundle.md'",
-    default: "dist/bundle.md",
+	help: "destination of bundle, by default is 'dist/bundle.md'",
+	default: "dist/bundle.md",
 });
 argParser.add_argument("-d", "--max-depth", {
-    help: "maximum recursion depth, by default is 15",
-    default: 15,
-    type: "int",
+	help: "maximum recursion depth, by default is 15",
+	default: 15,
+	type: "int",
 });
 argParser.add_argument("-e", "--entry", {
-    help: "assign entry point in directory, by default is 'main.md'",
-    default: "main.md",
+	help: "assign entry point in directory, by default is 'main.md'",
+	default: "main.md",
 });
 argParser.add_argument("-w", "--watch", {
-    action: "store_true",
-    help: "recompile after a change in target target file or directory.",
+	action: "store_true",
+	help: "recompile after a change in target target file or directory.",
 });
 argParser.add_argument("-u", "--use-underscore", {
-    action: "store_true",
-    help: "set the parser to use '_' as seperator in ids for Table of Content. If the links in the table does not work, this is likely to be the issue.",
+	action: "store_true",
+	help: "set the parser to use '_' as seperator in ids for Table of Content. If the links in the table does not work, this is likely to be the issue.",
 });
 argParser.add_argument("-t", "--toc-level", {
-    help: "the section level of the table of contents, by default is 3",
-    default: 3,
-    type: "int",
+	help: "the section level of the table of contents, by default is 3",
+	default: 3,
+	type: "int",
 });
 argParser.add_argument("-H", "--html", {
-    action: "store_true",
-    help: "compile HTML from the parsed markdown",
+	action: "store_true",
+	help: "compile HTML from the parsed markdown",
 });
 argParser.add_argument("--allow-undefined", "-A", {
-    action: "store_true",
-    help: "allow the use of the \"<thing>\" syntax, without raising an error when 'thing' is not a variable. Mostly useful when writing inline html tags, and other non-strictly markdown related uses",
+	action: "store_true",
+	help: "allow the use of the \"<thing>\" syntax, without raising an error when 'thing' is not a variable. Mostly useful when writing inline html tags, and other non-strictly markdown related uses",
 });
 //#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;
-    };
-
-    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();
+export type CommandLineArgs = {
+	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 IncompleteCommandLineArgs = {
+	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;
+	};
+	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]: (map: { [tag: string]: TaggedElement }) => void;
+	};
+	isFileCallback: (s: string) => false | string;
+};
+
+export type IncompleteParserOptions = {
+	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;
+	hooks?: {
+		[key: string]: (map: { [tag: string]: TaggedElement }) => void;
+	};
+	isFileCallback?: (s: string) => false | string;
+};