wikiparser-node 1.0.0-beta.4 → 1.0.1-b

package/extensions/dist/editor.js

@@ -0,0 +1,172 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+(() => {
+    const { wikiparse } = window, { MAX_STAGE } = wikiparse;
+    /** 用于打印AST */
+    class Printer {
+        /* eslint-enable es-x/no-class-fields */
+        /**
+         * @param preview 置于下层的代码高亮
+         * @param textbox 置于上层的文本框
+         * @param include 是否嵌入
+         */
+        constructor(preview, textbox, include) {
+            this.id = wikiparse.id++;
+            this.include = Boolean(include);
+            this.preview = preview;
+            this.textbox = textbox;
+            this.root = [];
+            this.running = undefined;
+            this.viewportChanged = false;
+            this.ticks = [0, undefined];
+        }
+        /** 倒计时 */
+        tick() {
+            setTimeout(() => {
+                const { ticks } = this;
+                if (ticks[0] > 0) {
+                    ticks[0] -= 500;
+                    this[ticks[0] <= 0 ? ticks[1] : 'tick']();
+                }
+            }, 500);
+        }
+        /**
+         * 用于debounce
+         * @param delay 延迟
+         * @param method 方法
+         */
+        queue(delay, method) {
+            const { ticks } = this, [state] = ticks;
+            if (state <= 0 || method === 'coarsePrint' || ticks[1] !== 'coarsePrint') {
+                ticks[0] = delay;
+                ticks[1] = method;
+                if (state <= 0) {
+                    this.tick();
+                }
+            }
+        }
+        /** 渲染 */
+        paint() {
+            this.preview.innerHTML = `<span class="wpb-root">${this.root.map(([, , printed]) => printed).join('')}</span> `;
+            this.preview.scrollTop = this.textbox.scrollTop;
+            this.preview.classList.remove('active');
+            this.textbox.style.color = 'transparent';
+        }
+        /** 初步解析 */
+        coarsePrint() {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (this.running) {
+                    return undefined;
+                }
+                const { include, textbox: { value } } = this, parsed = yield wikiparse.print(value, include, 2, this.id);
+                if (this.include !== include || this.textbox.value !== value) {
+                    this.running = undefined;
+                    this.running = this.coarsePrint();
+                    return this.running;
+                }
+                this.root = parsed;
+                this.paint();
+                this.running = undefined;
+                this.running = this.finePrint();
+                return this.running;
+            });
+        }
+        /** 根据可见范围精细解析 */
+        finePrint() {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (this.running) {
+                    this.viewportChanged = true;
+                    return undefined;
+                }
+                this.viewportChanged = false;
+                const { root, preview: { scrollHeight, offsetHeight: parentHeight, scrollTop, children: [rootNode] }, include, textbox: { value }, } = this;
+                let text = value, start = 0, { length: end } = root;
+                if (scrollHeight > parentHeight) {
+                    const childNodes = [...rootNode.childNodes], headings = childNodes.filter(({ className }) => className === 'wpb-heading'), { length } = headings;
+                    if (length > 0) {
+                        let i = headings.findIndex(({ offsetTop, offsetHeight }) => offsetTop + offsetHeight > scrollTop);
+                        i = i === -1 ? length : i;
+                        let j = headings.slice(i).findIndex(({ offsetTop }) => offsetTop >= scrollTop + parentHeight);
+                        j = j === -1 ? length : i + j;
+                        start = i ? childNodes.indexOf(headings[i - 1]) : 0;
+                        while (i <= j && root[start][0] === MAX_STAGE) {
+                            start = childNodes.indexOf(headings[i++]);
+                        }
+                        end = j === length ? end : childNodes.indexOf(headings[j]);
+                        while (i <= j && root[end - 1][0] === MAX_STAGE) {
+                            end = childNodes.indexOf(headings[--j]);
+                        }
+                        text = root.slice(start, end).map(([, str]) => str).join('');
+                    }
+                }
+                if (start === end) {
+                    this.running = undefined;
+                    return undefined;
+                }
+                const parsed = yield wikiparse.print(text, include, MAX_STAGE, this.id);
+                if (this.include === include && this.textbox.value === value) {
+                    this.root.splice(start, end - start, ...parsed);
+                    this.paint();
+                    this.running = undefined;
+                    if (this.viewportChanged) {
+                        this.running = this.finePrint();
+                    }
+                }
+                else {
+                    this.running = undefined;
+                    this.running = this.coarsePrint();
+                }
+                return this.running;
+            });
+        }
+    }
+    /**
+     * 高亮textarea
+     * @param textbox textarea元素
+     * @param include 是否嵌入
+     * @throws `TypeError` 不是textarea
+     */
+    const edit = (textbox, include) => {
+        if (!(textbox instanceof HTMLTextAreaElement)) {
+            throw new TypeError('wikiparse.edit方法仅可用于textarea元素！');
+        }
+        const preview = document.createElement('div'), container = document.createElement('div'), printer = new Printer(preview, textbox, include);
+        preview.id = 'wikiPretty';
+        preview.classList.add('wikiparser', 'active');
+        container.classList.add('wikiparse-container');
+        textbox.replaceWith(container);
+        textbox.classList.add('wikiparsed');
+        container.append(preview, textbox);
+        textbox.addEventListener('input', e => {
+            if (!e.isComposing) {
+                printer.queue(2000, 'coarsePrint');
+            }
+            textbox.style.color = '';
+            preview.classList.add('active');
+        });
+        textbox.addEventListener('scroll', () => {
+            if (preview.scrollHeight > preview.offsetHeight && !preview.classList.contains('active')) {
+                preview.scrollTop = textbox.scrollTop;
+                printer.queue(500, 'finePrint');
+            }
+        });
+        textbox.addEventListener('keydown', e => {
+            if ((e.ctrlKey || e.metaKey) && e.key === 'k') {
+                e.preventDefault();
+                printer.ticks[0] = 0;
+                printer.running = printer.coarsePrint();
+            }
+        });
+        printer.running = printer.coarsePrint();
+        return printer;
+    };
+    wikiparse.Printer = Printer;
+    wikiparse.edit = edit;
+})();

package/extensions/dist/highlight.js

@@ -0,0 +1,46 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+(() => {
+    const { wikiparse } = window;
+    /**
+     * 高亮代码块
+     * @param ele 代码块
+     * @param linenums 是否添加行号
+     * @param start 起始行号
+     */
+    const highlight = (ele, linenums, start = 1) => __awaiter(void 0, void 0, void 0, function* () {
+        if (ele.classList.contains('highlighted')) {
+            return;
+        }
+        const html = (yield wikiparse.print(ele.innerText)).map(([, , printed]) => printed).join('');
+        ele.classList.add('highlighted');
+        if (linenums) {
+            // 添加行号。这里不使用<table>排版，而是使用<ol>
+            const lines = html.split('\n').map((line, i) => {
+                const li = document.createElement('li');
+                li.id = `L${i + start}`;
+                li.innerHTML = line;
+                return li;
+            });
+            if (!lines[lines.length - 1].textContent) {
+                lines.pop();
+            }
+            const ol = document.createElement('ol');
+            ol.start = start;
+            ol.style.paddingLeft = `${(lines.length + start - 1).toString().length + 2.5}ch`;
+            ol.append(...lines);
+            ele.replaceChildren(ol);
+        }
+        else {
+            ele.innerHTML = html;
+        }
+    });
+    wikiparse.highlight = highlight;
+})();

package/extensions/dist/lint.js

@@ -0,0 +1,43 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+(() => {
+    const { wikiparse } = window;
+    /** 用于语法分析 */
+    class Linter {
+        /* eslint-enable es-x/no-class-fields */
+        /** @param include 是否嵌入 */
+        constructor(include) {
+            this.id = wikiparse.id++;
+            this.include = Boolean(include);
+            this.wikitext = undefined;
+            this.running = undefined;
+        }
+        /**
+         * 提交语法分析
+         * @param wikitext 待分析的文本
+         */
+        queue(wikitext) {
+            this.wikitext = wikitext;
+            this.running = this.lint(wikitext);
+            return this.running;
+        }
+        /**
+         * 执行语法分析
+         * @param wikitext 待分析的文本
+         */
+        lint(wikitext) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const { include } = this, errors = yield wikiparse.lint(wikitext, include, this.id);
+                return this.include === include && this.wikitext === wikitext ? errors : this.running;
+            });
+        }
+    }
+    wikiparse.Linter = Linter;
+})();

package/extensions/editor.css

@@ -0,0 +1,63 @@
+.wikiparse-container {
+	position: relative;
+	-webkit-text-size-adjust: none;
+}
+.wikiparsed {
+	position: relative;
+	display: block;
+	box-sizing: border-box;
+	width: 100%;
+	resize: vertical;
+	font-family: monospace;
+	background: none !important;
+	caret-color: #000;
+}
+#wikiPretty {
+	position: absolute;
+	inset: 0;
+	background-color: #fff;
+	-webkit-user-select: none;
+	user-select: none;
+}
+#wikiPretty + .wikiparsed, #wikiPretty {
+	outline: none;
+	border: 1.5px solid #dedede !important;
+	border-radius: 0;
+	padding: .4em;
+	line-height: 1.4 !important;
+	font-size: inherit;
+	tab-size: 4;
+	overflow-y: auto;
+	word-break: normal;
+}
+
+/* compromise for font-weight: bold */
+.wpb-ext, .wpb-html,
+.wpb-arg,
+.wpb-template,
+.wpb-magic-word,
+.wpb-heading-title,
+.wpb-table, .wpb-tr, .wpb-td,
+.wpb-double-underscore, .wpb-hr, .wpb-quote, .wpb-list, .wpb-dd
+.wpb-converter {
+	-webkit-text-stroke-width: .1ex;
+}
+.wpb-hidden, .wpb-table-inter, .wpb-table-inter span,
+.wpb-noinclude, .wpb-include, .wpb-comment,
+.wpb-ext-attrs, .wpb-html-attrs,
+.wpb-ext-inner,
+.wpb-arg-default,
+.wpb-invoke-module, .wpb-invoke-function,
+.wpb-parameter,
+.wpb-table-attrs, .wpb-td-inner,
+.wpb-converter-rule {
+	-webkit-text-stroke-width: 0;
+}
+#wikiPretty span {
+	font-weight: normal;
+}
+
+#wikiPretty.active span {
+	color: transparent;
+	background: none;
+}

package/extensions/ui.css

@@ -0,0 +1,119 @@
+.wikiparser {
+	white-space: pre-wrap;
+	overflow-wrap: break-word;
+	font-family: monospace;
+}
+
+.wpb-error {
+	text-decoration: underline wavy #f00 1px;
+}
+.wpb-hidden, .wpb-table-inter, .wpb-table-inter span {
+	color: #f00;
+	font-weight: normal;
+	text-decoration: underline wavy 1px;
+}
+
+.wpb-noinclude, .wpb-include, .wpb-comment {
+	color: #72777d;
+	font-weight: normal;
+}
+.wpb-comment {
+	font-style: italic;
+}
+
+.wpb-ext, .wpb-html {
+	color: #14866d;
+	font-weight: bold;
+}
+.wpb-ext-attrs, .wpb-html-attrs {
+	font-weight: normal;
+}
+.wpb-ext-attr > .wpb-attr-value, .wpb-html-attr > .wpb-attr-value {
+	color: #179b1c;
+}
+.wpb-ext-inner {
+	color: initial;
+	font-weight: normal;
+	background-color: rgba(0, 0, 0, .03);
+}
+
+.wpb-arg {
+	color: #ac6600;
+	font-weight: bold;
+}
+.wpb-arg-default {
+	color: #ad9300;
+	font-weight: normal;
+}
+
+.wpb-template {
+	color: #80c;
+	font-weight: bold;
+	background-color: rgba(119, 0, 170, .03);
+}
+.wpb-magic-word {
+	color: #d33;
+	font-weight: bold;
+	background-color: rgba(170, 17, 17, .03);
+}
+.wpb-invoke-module, .wpb-invoke-function {
+	color: #dd5d33;
+	font-weight: normal;
+}
+.wpb-parameter {
+	color: initial;
+	font-weight: normal;
+}
+.wpb-template > .wpb-parameter > .wpb-parameter-key,
+.wpb-invoke-function ~ .wpb-parameter > .wpb-parameter-key {
+	color: #b0c;
+}
+
+.wpb-heading, .wpb-image-parameter {
+	color: #0076dd;
+}
+.wpb-heading-title {
+	color: initial;
+	font-weight: bold;
+}
+
+.wpb-table, .wpb-tr, .wpb-td {
+	color: #d08;
+	font-weight: bold;
+}
+.wpb-table-attrs {
+	font-weight: normal;
+}
+.wpb-table-attr > .wpb-attr-value {
+	color: #f500d4;
+}
+.wpb-td-inner {
+	color: initial;
+	font-weight: normal;
+}
+
+.wpb-double-underscore, .wpb-hr, .wpb-quote, .wpb-list, .wpb-dd {
+	color: #0076dd;
+	font-weight: bold;
+	background-color: #eee;
+}
+
+.wpb-link, .wpb-category, .wpb-file, .wpb-gallery-image, .wpb-imagemap-image,
+.wpb-ext-link, .wpb-free-ext-link {
+	color: #000aaa;
+	background-color: rgba(34, 17, 153, .03);
+}
+.wpb-link-text, .wpb-image-caption, .wpb-ext-link-text {
+	color: initial;
+}
+
+.wpb-converter {
+	color: #b68;
+	font-weight: bold;
+}
+.wpb-converter-rule {
+	font-weight: normal;
+}
+.wpb-converter-rule-from, .wpb-converter-rule-to, .wpb-converter-noconvert {
+	color: initial;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wikiparser-node",
-	"version": "1.0.0-beta.4",
+	"version": "1.0.1-b",
 	"description": "A Node.js parser for MediaWiki markup with AST",
 	"keywords": [
 		"mediawiki",
@@ -14,36 +14,45 @@
 	"license": "GPL-3.0",
 	"author": "Bhsd",
 	"files": [
-		"/errors/README",
-		"/printed/README",
+		"/bundle/bundle.min.js",
+		"/extensions/dist/",
+		"/extensions/*.css",
+		"!/extensions/dist/gh-page.js",
+		"!/extensions/gh-page.css",
 		"/config/",
 		"/i18n/",
-		"/dist/"
+		"!/config/.schema.json"
 	],
-	"main": "./dist/index.js",
+	"browser": "/bundle/bundle.min.js",
+	"main": "./bundle/bundle.js",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/bhsd-harry/wikiparser-node.git"
 	},
 	"scripts": {
-		"prepublishOnly": "rm -rf dist/; tsc; rm dist/internal.js; rm dist/[mpu]*/*.d.ts; grep -rl --include='*.d.ts' '@private' dist/ | xargs gsed -i '/@private/,+1d'",
-		"build": "rm -rf dist/; tsc; grep -rl --include='*.js' '@ts' dist/ | xargs gsed -i '/@ts/d'; eslint --fix dist/",
+		"prepublishOnly": "webpack build --mode production && npm run build:ext",
+		"build:core": "rm bundle/*.js; webpack build --mode development; webpack build --mode production",
+		"build:ext": "rm -rf extensions/dist/; tsc --project extensions/tsconfig.json; ls extensions/dist/*.js | xargs gsed -i '/export {};/d'",
+		"build:test": "rm -rf dist/; tsc; gsed -i 's|./config/minimum|../config/minimum|' dist/index.js",
+		"build": "npm run build:core && npm run build:ext",
 		"diff": "git diff --ignore-all-space --color-moved",
-		"doc": "node ./bin/doc.js",
-		"toc": "node ./bin/toc.js",
-		"lint:ts": "eslint --cache --ignore-pattern '/dist/' .",
+		"lint:ts": "eslint --cache --ignore-pattern 'dist/' .",
 		"lint:json": "ajv -s config/.schema.json -d 'config/*.json' --strict=true --strict-required=false",
-		"lint": "npm run lint:ts && npm run lint:json",
-		"test:real": "node test/real.js",
-		"test:single": "node --prof test/single.js && node --prof-process isolate-0x*-v8.log > test/processed.txt && rm isolate-0x*-v8.log"
+		"lint:css": "stylelint extensions/*.css",
+		"lint": "npm run lint:ts && npm run lint:json && npm run lint:css",
+		"test:real": "node dist/test/real.js",
+		"test:single": "node dist/test/single.js"
 	},
 	"devDependencies": {
 		"@cypress/request": "^3.0.1",
 		"@types/node": "^20.9.0",
-		"@typescript-eslint/eslint-plugin": "^5.62.0",
-		"@typescript-eslint/parser": "^5.62.0",
+		"@types/request": "^2.48.12",
+		"@typescript-eslint/eslint-plugin": "^6.12.0",
+		"@typescript-eslint/parser": "^6.12.0",
 		"ajv-cli": "^5.0.0",
+		"esbuild-loader": "^4.0.2",
 		"eslint": "^8.53.0",
+		"eslint-plugin-es-x": "^7.3.0",
 		"eslint-plugin-eslint-comments": "^3.2.0",
 		"eslint-plugin-jsdoc": "^46.8.2",
 		"eslint-plugin-json-es": "^1.5.7",
@@ -51,7 +60,11 @@
 		"eslint-plugin-promise": "^6.1.1",
 		"eslint-plugin-regexp": "^2.1.1",
 		"eslint-plugin-unicorn": "^49.0.0",
-		"typescript": "^5.0.3"
+		"stylelint": "^15.11.0",
+		"stylelint-config-recommended": "^10.0.1",
+		"typescript": "^5.0.3",
+		"webpack-cli": "^5.1.4",
+		"webpack": "^5.89.0"
 	},
 	"engines": {
 		"node": "^20.9.0"

package/config/.schema.json

@@ -1,160 +0,0 @@
-{
-	"type": "object",
-	"properties": {
-		"ext": {
-			"description": "extension tags",
-			"type": "array",
-			"items": {
-				"type": "string",
-				"pattern": "^[a-z\\d_]+$"
-			}
-		},
-		"html": {
-			"description": "valid HTML tags",
-			"type": "array",
-			"items": {
-				"type": "array",
-				"items": {
-					"type": "string",
-					"pattern": "^[a-z\\d]+$"
-				}
-			},
-			"minItems": 3,
-			"maxItems": 3
-		},
-		"namespaces": {
-			"description": "formatted namespaces",
-			"type": "object",
-			"patternProperties": {
-				"^-?\\d+$": {
-					"type": "string"
-				}
-			},
-			"required": [
-				"6",
-				"10"
-			],
-			"additionalProperties": false
-		},
-		"nsid": {
-			"description": "namespace IDs",
-			"type": "object",
-			"additionalProperties": {
-				"type": "integer"
-			}
-		},
-		"parserFunction": {
-			"type": "array",
-			"items": [
-				{
-					"description": "case-insensitive parser functions",
-					"type": "object",
-					"additionalProperties": {
-						"type": "string"
-					}
-				},
-				{
-					"description": "case-sensitive parser functions",
-					"type": "array",
-					"items": {
-						"type": "string"
-					}
-				},
-				{
-					"description": "msg and raw",
-					"type": "array",
-					"items": {
-						"type": "string"
-					}
-				},
-				{
-					"description": "subst and safesubst",
-					"type": "array",
-					"items": {
-						"type": "string"
-					}
-				}
-			],
-			"minItems": 4,
-			"maxItems": 4
-		},
-		"doubleUnderscore": {
-			"description": "behavior switches",
-			"type": "array",
-			"items": {
-				"type": "array",
-				"items": {
-					"type": "string"
-				}
-			},
-			"minItems": 2,
-			"maxItems": 2
-		},
-		"protocol": {
-			"description": "external link protocols",
-			"type": "string",
-			"pattern": "^[a-z:/]+(?:\\|[a-z:/]+)*$"
-		},
-		"interwiki": {
-			"type": "array",
-			"items": {
-				"type": "string"
-			}
-		},
-		"img": {
-			"description": "image-related magic words",
-			"type": "object",
-			"additionalProperties": {
-				"type": "string",
-				"pattern": "^[-a-z]+$"
-			}
-		},
-		"variants": {
-			"description": "variants for language conversion",
-			"type": "array",
-			"items": {
-				"type": "string",
-				"pattern": "^[-a-z]+$"
-			}
-		},
-		"conversionTable": {
-			"description": "table of unidirectional conversions",
-			"type": "array",
-			"items": {
-				"type": "array",
-				"items": {
-					"type": "string",
-					"pattern": "^[^ <>[\\]{}|]+$"
-				},
-				"minItems": 2,
-				"maxItems": 2
-			}
-		},
-		"redirects": {
-			"description": "table of redirects",
-			"type": "array",
-			"items": {
-				"type": "array",
-				"items": {
-					"type": "string",
-					"pattern": "^[^ <>[\\]{}|]+$"
-				},
-				"minItems": 2,
-				"maxItems": 2
-			}
-		}
-	},
-	"required": [
-		"ext",
-		"html",
-		"namespaces",
-		"nsid",
-		"parserFunction",
-		"doubleUnderscore",
-		"protocol",
-		"interwiki",
-		"img",
-		"variants"
-	],
-	"additionalProperties": false
-}