wikiparser-node 1.0.0-beta.4 → 1.0.0-beta.5

package/README.md

@@ -1,15 +1,16 @@
 [![npm version](https://badge.fury.io/js/wikiparser-node.svg)](https://www.npmjs.com/package/wikiparser-node)
-[![CodeQL](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/github-code-scanning/codeql)
+[![CodeQL](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/codeql.yml/badge.svg)](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/codeql.yml)
+[![CI](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/node.js.yml/badge.svg)](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/node.js.yml)
 
 # 简介
 
-wikiparser-node 是一款由 Bhsd 开发的基于 [Node.js](https://nodejs.org/en/) 环境的离线[维基文本](https://www.mediawiki.org/wiki/Wikitext)语法解析器，可以解析绝大部分的维基语法并生成[语法树](https://en.wikipedia.org/wiki/Abstract_syntax_tree)，还可以很方便地对语法树进行查询和修改，最后返回修改后的维基文本。
+wikiparser-node 是一款由 Bhsd 开发的基于 [Node.js](https://nodejs.org/) 环境的离线[维基文本](https://www.mediawiki.org/wiki/Wikitext)语法解析器，可以解析几乎全部的维基语法并生成[语法树](https://en.wikipedia.org/wiki/Abstract_syntax_tree)，还可以很方便地对语法树进行查询和修改，最后返回修改后的维基文本。
 
 # 其他版本
 
-## Mini
+## Mini (又名 [wikilint](https://www.npmjs.com/package/wikilint))
 
-仅保留了解析功能和[语法错误分析](https://github.com/bhsd-harry/wikiparser-node/wiki/AstElement#lint)功能的轻量版本，解析生成的语法树不能修改。这个版本被应用于 [eslint-plugin-wikitext](/bhsd-harry/eslint-plugin-wikitext) 插件。
+提供了 [CLI](https://en.wikipedia.org/wiki/Command-line_interface)，但仅保留了解析功能和语法错误分析功能，解析生成的语法树不能修改。这个版本被应用于 [eslint-plugin-wikitext](https://www.npmjs.com/package/eslint-plugin-wikitext) 插件。
 
 ## Browser
 
@@ -19,16 +20,16 @@ wikiparser-node 是一款由 Bhsd 开发的基于 [Node.js](https://nodejs.org/e
 
 ## Node.js
 
-请根据需要需要安装对应的版本（`latest` 或 `mini`），如：
+请根据需要需要安装对应的版本（`wikiparser-node` 或 `wikilint`），如：
 
 ```sh
-npm i wikiparser-node # 默认为latest
+npm i wikiparser-node
 ```
 
 或
 
 ```sh
-npm i wikiparser-node@mini
+npm i wikilint
 ```
 
 ## 浏览器
@@ -45,8 +46,8 @@ npm i wikiparser-node@mini
 <script src="//unpkg.com/wikiparser-node@browser/bundle/bundle.min.js"></script>
 ```
 
-更多浏览器端可用的插件请查阅对应[文档](https://github.com/bhsd-harry/wikiparser-node/wiki/Browser)。
+更多浏览器端可用的插件请查阅对应文档。
 
 # 使用方法
 
-请查阅 [Wiki](https://github.com/bhsd-harry/wikiparser-node/wiki/Parser)。
+请查阅 [Wiki](https://github.com/bhsd-harry/wikiparser-node/wiki)。

package/dist/bin/toc.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+const path = require("path");
+const { argv: [, , filename] } = process;
+if (!filename) {
+    throw new RangeError('请指定文档文件！');
+}
+const fullpath = path.join(__dirname, '..', '..', 'wiki', `${filename}.md`);
+if (!fs.existsSync(fullpath)) {
+    throw new RangeError(`文档 ${filename}.md 不存在！`);
+}
+const content = fs.readFileSync(fullpath, 'utf8');
+if (/^- \[[^\]]+\]\(#[^)]+\)$/mu.test(content)) {
+    throw new Error(`文档 ${filename}.md 中已包含目录！`);
+}
+const toc = content.split('\n').filter(line => line.startsWith('#')).map(line => line.replace(/^(#+)\s+(\S.*)$/u, (_, { length }, title) => `${'\t'.repeat(length - 1)}- [${title}](#${title.toLowerCase().replaceAll(' ', '-').replaceAll('.', '')})`)).join('\n');
+fs.writeFileSync(fullpath, `<details>\n\t<summary>目录</summary>\n\n${toc}\n</details>\n\n${content}`);

package/dist/index.d.ts

@@ -27,15 +27,12 @@ export interface LintError {
     excerpt: string;
 }
 declare interface Parser {
-    /** @browser */
     config: string | Config;
-    /** @browser */
     i18n?: string | Record<string, string>;
     conversionTable: Map<string, string>;
     redirects: Map<string, string>;
     /**
      * 规范化页面标题
-     * @browser
      * @param title 标题（含或不含命名空间前缀）
      * @param defaultNs 命名空间
      * @param include 是否嵌入
@@ -46,7 +43,6 @@ declare interface Parser {
     normalizeTitle(title: string, defaultNs?: number, include?: boolean, config?: Config, halfParsed?: boolean, decode?: boolean, selfLink?: boolean): Title;
     /**
      * 解析wikitext
-     * @browser
      * @param include 是否嵌入
      * @param maxStage 最大解析层级
      */

package/dist/index.js

@@ -2,6 +2,7 @@
 /* eslint n/exports-style: 0 */
 const fs = require("fs");
 const path = require("path");
+const diff_1 = require("./util/diff");
 /**
  * 从根路径require
  * @param file 文件名
@@ -12,6 +13,7 @@ const rootRequire = (file, dir) => require(file.startsWith('/') ? file : `../${f
 const Parser = {
     config: 'default',
     MAX_STAGE: 11,
+    /* NOT FOR BROWSER */
     conversionTable: new Map(),
     redirects: new Map(),
     warning: true,
@@ -120,6 +122,7 @@ const Parser = {
         'imagemap-link': ['image-map-link'],
     },
     promises: [Promise.resolve()],
+    /* NOT FOR BROWSER END */
     /** @implements */
     getConfig() {
         if (typeof this.config === 'string') {
@@ -149,8 +152,8 @@ const Parser = {
         if (halfParsed) {
             return new Title(title, defaultNs, config, decode, selfLink);
         }
-        const { Token } = require('./src');
-        const token = this.run(() => new Token(title, config).parseOnce(0, include).parseOnce()), titleObj = new Title(String(token.firstChild), defaultNs, config, decode, selfLink);
+        const { Token } = require('./src/index');
+        const token = this.run(() => new Token(title, config).parseOnce(0, include).parseOnce()), titleObj = new Title(String(token), defaultNs, config, decode, selfLink);
         this.run(() => {
             for (const key of ['main', 'fragment']) {
                 if (titleObj[key]?.includes('\0')) {
@@ -164,10 +167,10 @@ const Parser = {
     },
     /** @implements */
     parse(wikitext, include, maxStage = Parser.MAX_STAGE, config = Parser.getConfig()) {
-        const { Token } = require('./src');
+        const { Token } = require('./src/index');
         let token;
         this.run(() => {
-            token = new Token(wikitext, config);
+            token = new Token(wikitext.replace(/[\0\x7F]/gu, ''), config);
             try {
                 token.parse(maxStage, include);
             }
@@ -216,6 +219,7 @@ const Parser = {
             throw e;
         }
     },
+    /* NOT FOR BROWSER */
     /** @implements */
     warn(msg, ...args) {
         if (this.warning) {
@@ -243,8 +247,8 @@ const Parser = {
         }
     },
     /** @implements */
-    clearCache() {
-        const entries = [
+    async clearCache() {
+        const promise = (0, diff_1.cmd)('npm', ['run', 'build']), entries = [
             ...Object.entries(this.classes),
             ...Object.entries(this.mixins),
             ...Object.entries(this.parsers),
@@ -255,12 +259,15 @@ const Parser = {
             }
             catch { }
         }
+        await promise;
         for (const [name, filePath] of entries) {
             if (name in global) {
                 // @ts-expect-error noImplicitAny
-                global[name] = require(filePath);
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+                global[name] = require(filePath)[name];
             }
         }
+        this.info('已重新加载Parser');
     },
     /** @implements */
     isInterwiki(title, { interwiki } = Parser.getConfig()) {
@@ -278,9 +285,10 @@ const Parser = {
         const { stage, include, config } = require(`${file}.json`), { Token } = require('./src');
         this.config = config;
         return this.run(() => {
-            const halfParsed = stage < this.MAX_STAGE, token = new Token(wikitext, this.getConfig(), halfParsed);
+            const halfParsed = stage < this.MAX_STAGE, token = new Token(halfParsed ? wikitext : wikitext.replace(/[\0\x7F]/gu, ''), this.getConfig());
             if (halfParsed) {
-                token.setAttribute('stage', stage).parseOnce(stage, include);
+                token.setAttribute('stage', stage);
+                token.parseOnce(stage, include);
             }
             else {
                 token.parse(undefined, include);

package/dist/internal.d.ts

@@ -1,6 +1,6 @@
 export type { AstNodes, } from './lib/node';
 export type * from './lib/text';
-export type * from './src';
+export type * from './src/index';
 export type * from './src/onlyinclude';
 export type * from './src/nowiki/noinclude';
 export type * from './src/tagPair/include';
@@ -18,10 +18,10 @@ export type * from './src/heading';
 export type * from './src/html';
 export type { TdToken } from './src/table/td';
 export type * from './src/table/tr';
-export type * from './src/table';
+export type * from './src/table/index';
 export type * from './src/nowiki/hr';
 export type * from './src/nowiki/doubleUnderscore';
-export type * from './src/link';
+export type * from './src/link/index';
 export type * from './src/link/category';
 export type * from './src/imageParameter';
 export type * from './src/link/file';
@@ -34,9 +34,9 @@ export type * from './src/nowiki/list';
 export type * from './src/converterFlags';
 export type * from './src/converterRule';
 export type * from './src/converter';
-export type * from './src/nowiki';
+export type * from './src/nowiki/index';
 export type * from './src/pre';
-export type * from './src/paramTag';
+export type * from './src/paramTag/index';
 export type * from './src/paramTag/inputbox';
 export type * from './src/nested';
 export type * from './src/gallery';

package/dist/lib/element.d.ts

@@ -4,12 +4,8 @@ import type { AstNodes, AstText, Token } from '../internal';
 /** 类似HTMLElement */
 export declare abstract class AstElement extends AstNode {
     #private;
-    /** @browser */
     name?: string;
-    /**
-     * 子节点总数
-     * @browser
-     */
+    /** 子节点总数 */
     get length(): number;
     /** 全部非文本子节点 */
     get children(): Token[];
@@ -36,24 +32,18 @@ export declare abstract class AstElement extends AstNode {
     constructor();
     /**
      * 可见部分
-     * @browser
      * @param separator 子节点间的连接符
      */
     text(separator?: string): string;
-    /**
-     * 合并相邻的文本子节点
-     * @browser
-     */
+    /** 合并相邻的文本子节点 */
     normalize(): void;
     /**
      * 移除子节点
-     * @browser
      * @param i 移除位置
      */
     removeAt(i: number): AstNodes;
     /**
      * 插入子节点
-     * @browser
      * @param node 待插入的子节点
      * @param i 插入位置
      * @throws `RangeError` 不能插入祖先节点
@@ -61,46 +51,33 @@ export declare abstract class AstElement extends AstNode {
     insertAt<T extends AstNodes>(node: T, i?: number): T;
     /**
      * 最近的祖先节点
-     * @browser
      * @param selector 选择器
      */
     closest(selector: string): Token | undefined;
     /**
      * 在末尾批量插入子节点
-     * @browser
      * @param elements 插入节点
      */
     append(...elements: (AstNodes | string)[]): void;
     /**
      * 批量替换子节点
-     * @browser
      * @param elements 新的子节点
      */
     replaceChildren(...elements: (AstNodes | string)[]): void;
     /**
      * 修改文本子节点
-     * @browser
      * @param str 新文本
      * @param i 子节点位置
      * @throws `RangeError` 对应位置的子节点不是文本节点
      */
     setText(str: string, i?: number): string;
-    /**
-     * 还原为wikitext
-     * @browser
-     * @param omit 忽略的节点类型
-     * @param separator 子节点间的连接符
-     */
-    toString(omit?: Set<string>, separator?: string): string;
     /**
      * Linter
-     * @browser
      * @param start
      */
     lint(start?: number): LintError[];
     /**
      * 以HTML格式打印
-     * @browser
      * @param opt 选项
      */
     print(opt?: PrintOpt): string;

package/dist/lib/element.js

@@ -26,6 +26,7 @@ const lintIgnoredExt = new Set([
     'templatedata',
     'timeline',
 ]);
+/* NOT FOR BROWSER */
 /**
  * 检查某个下标是否符合表达式
  * @param str 表达式
@@ -42,17 +43,15 @@ const matchesLang = ({ attributes }, regex) => {
     const lang = attributes?.['lang'];
     return typeof lang === 'string' && regex.test(lang);
 };
+/* NOT FOR BROWSER END */
 /** 类似HTMLElement */
 class AstElement extends node_1.AstNode {
-    /** @browser */
     name;
-    /**
-     * 子节点总数
-     * @browser
-     */
+    /** 子节点总数 */
     get length() {
         return this.childNodes.length;
     }
+    /* NOT FOR BROWSER */
     /** 全部非文本子节点 */
     get children() {
         return this.childNodes.filter(({ type }) => type !== 'text');
@@ -111,18 +110,15 @@ class AstElement extends node_1.AstNode {
         super();
         this.seal('name');
     }
+    /* NOT FOR BROWSER END */
     /**
      * 可见部分
-     * @browser
      * @param separator 子节点间的连接符
      */
     text(separator) {
         return (0, string_1.text)(this.childNodes, separator);
     }
-    /**
-     * 合并相邻的文本子节点
-     * @browser
-     */
+    /** 合并相邻的文本子节点 */
     normalize() {
         const childNodes = [...this.childNodes];
         for (let i = childNodes.length - 1; i >= 0; i--) {
@@ -142,7 +138,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 移除子节点
-     * @browser
      * @param i 移除位置
      */
     removeAt(i) {
@@ -155,7 +150,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 插入子节点
-     * @browser
      * @param node 待插入的子节点
      * @param i 插入位置
      * @throws `RangeError` 不能插入祖先节点
@@ -181,7 +175,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 最近的祖先节点
-     * @browser
      * @param selector 选择器
      */
     closest(selector) {
@@ -204,7 +197,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 在末尾批量插入子节点
-     * @browser
      * @param elements 插入节点
      */
     append(...elements) {
@@ -214,7 +206,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 批量替换子节点
-     * @browser
      * @param elements 新的子节点
      */
     replaceChildren(...elements) {
@@ -225,7 +216,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 修改文本子节点
-     * @browser
      * @param str 新文本
      * @param i 子节点位置
      * @throws `RangeError` 对应位置的子节点不是文本节点
@@ -240,12 +230,7 @@ class AstElement extends node_1.AstNode {
         }
         throw new RangeError(`第 ${i} 个子节点是 ${name}！`);
     }
-    /**
-     * 还原为wikitext
-     * @browser
-     * @param omit 忽略的节点类型
-     * @param separator 子节点间的连接符
-     */
+    /** @private */
     toString(omit, separator = '') {
         return omit && this.matchesTypes(omit)
             ? ''
@@ -253,7 +238,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * Linter
-     * @browser
      * @param start
      */
     lint(start = this.getAbsoluteIndex()) {
@@ -270,18 +254,18 @@ class AstElement extends node_1.AstNode {
         }
         return errors;
     }
-    /** @private */
-    matchesTypes(types) {
-        return types.has(this.type);
-    }
     /**
      * 以HTML格式打印
-     * @browser
      * @param opt 选项
      */
     print(opt = {}) {
         return String(this) ? `<span class="wpb-${opt.class ?? this.type}">${(0, string_1.print)(this.childNodes, opt)}</span>` : '';
     }
+    /* NOT FOR BROWSER */
+    /** @private */
+    matchesTypes(types) {
+        return types.has(this.type);
+    }
     /**
      * 保存为JSON
      * @param file 文件名
@@ -476,8 +460,9 @@ class AstElement extends node_1.AstNode {
                     if (!parentNode) {
                         return false;
                     }
-                    const { children } = parentNode, i = children.indexOf(this);
-                    return children.slice(0, i).some(child => child.#matchesArray(condition));
+                    const { children } = parentNode;
+                    return children.slice(0, children.indexOf(this))
+                        .some(child => child.#matchesArray(condition));
                 }
                 default: // ' '
                     return this.getAncestors().some(ancestor => ancestor.#matchesArray(condition));
@@ -650,7 +635,7 @@ class AstElement extends node_1.AstNode {
         for (let j = 0; j < length; j++) {
             const child = childNodes[j], childStr = String(child), gap = j === length - 1 ? 0 : this.getGaps(j);
             if (!childStr) {
-                // pass
+                //
             }
             else if (child.type === 'text') {
                 console.log(`${indent}  ${(0, string_1.noWrap)(child.data)}`);

package/dist/lib/node.d.ts

@@ -16,44 +16,21 @@ export interface CaretPosition {
 /** 类似Node */
 export declare abstract class AstNode {
     #private;
-    /** @browser */
     type: TokenTypes | 'text';
-    /** @browser */
     readonly childNodes: AstNodes[];
-    /**
-     * 首位子节点
-     * @browser
-     */
+    /** 首位子节点 */
     get firstChild(): AstNodes | undefined;
-    /**
-     * 末位子节点
-     * @browser
-     */
+    /** 末位子节点 */
     get lastChild(): AstNodes | undefined;
-    /**
-     * 父节点
-     * @browser
-     */
+    /** 父节点 */
     get parentNode(): Token | undefined;
-    /**
-     * 后一个兄弟节点
-     * @browser
-     */
+    /** 后一个兄弟节点 */
     get nextSibling(): AstNodes | undefined;
-    /**
-     * 前一个兄弟节点
-     * @browser
-     */
+    /** 前一个兄弟节点 */
     get previousSibling(): AstNodes | undefined;
-    /**
-     * 行数
-     * @browser
-     */
+    /** 行数 */
     get offsetHeight(): number;
-    /**
-     * 最后一行的列数
-     * @browser
-     */
+    /** 最后一行的列数 */
     get offsetWidth(): number;
     /** 后一个非文本兄弟节点 */
     get nextElementSibling(): Token | undefined;
@@ -74,27 +51,19 @@ export declare abstract class AstNode {
         padding: number;
     };
     constructor();
-    /**
-     * 获取根节点
-     * @browser
-     */
+    /** 获取根节点 */
     getRootNode(): Token | this;
     /**
      * 将字符位置转换为行列号
-     * @browser
      * @param index 字符位置
      */
     posFromIndex(index: number): Position | undefined;
     /**
      * 获取当前节点的相对字符位置，或其第`j`个子节点的相对字符位置
-     * @browser
      * @param j 子节点序号
      */
     getRelativeIndex(j?: number): number;
-    /**
-     * 获取当前节点的绝对位置
-     * @browser
-     */
+    /** 获取当前节点的绝对位置 */
     getAbsoluteIndex(): number;
     /**
      * 是否是全同节点