wikilint 2.0.0-beta.1 → 2.0.0

package/README.md

@@ -1,5 +1,6 @@
 [![npm version](https://badge.fury.io/js/wikilint.svg)](https://www.npmjs.com/package/wikilint)
-[![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)
 
 # wikilint
 This is a minimal version of [wikiparser-node](https://www.npmjs.com/package/wikiparser-node) customized for [eslint-plugin-wikitext](https://www.npmjs.com/package/eslint-plugin-wikitext).
@@ -7,7 +8,7 @@ This is a minimal version of [wikiparser-node](https://www.npmjs.com/package/wik
 You can also directly lint Wikitext articles in the command line using this package:
 
 ```sh
-npx wikilint --config zhwiki --include *.wiki
+npx wikilint --config zhwiki --include --lang zh-hans *.wiki
 ```
 
 ## CLI Options

package/bin/cli.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+'use strict';
+require('../dist/bin/cli.js');

package/dist/index.d.ts

@@ -23,13 +23,10 @@ export interface LintError {
     endCol: number;
 }
 declare interface Parser {
-    /** @browser */
     config: string | Config;
-    /** @browser */
-    i18n?: string | Record<string, string>;
+    i18n: string | Record<string, string> | undefined;
     /**
      * 规范化页面标题
-     * @browser
      * @param title 标题（含或不含命名空间前缀）
      * @param defaultNs 命名空间
      * @param include 是否嵌入
@@ -40,7 +37,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,8 @@
 /* eslint n/exports-style: 0 */
 const fs = require("fs");
 const path = require("path");
+const debug_1 = require("./util/debug");
+const constants_1 = require("./util/constants");
 /**
  * 从根路径require
  * @param file 文件名
@@ -11,14 +13,17 @@ const rootRequire = (file, dir) => require(file.startsWith('/') ? file : `../${f
 // eslint-disable-next-line @typescript-eslint/no-redeclare
 const Parser = {
     config: 'default',
-    MAX_STAGE: 11,
+    i18n: undefined,
     /** @implements */
     getConfig() {
         if (typeof this.config === 'string') {
             this.config = rootRequire(this.config, 'config/');
             return this.getConfig();
         }
-        return { ...this.config, excludes: [] };
+        return {
+            ...this.config,
+            excludes: [],
+        };
     },
     /** @implements */
     msg(msg, arg = '') {
@@ -34,15 +39,15 @@ 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), defaultNs, config, decode, selfLink);
+        const { Token } = require('./src/index');
+        const token = debug_1.Shadow.run(() => new Token(title, config).parseOnce(0, include).parseOnce()), titleObj = new Title(String(token), defaultNs, config, decode, selfLink);
         return titleObj;
     },
     /** @implements */
-    parse(wikitext, include, maxStage = Parser.MAX_STAGE, config = Parser.getConfig()) {
-        const { Token } = require('./src');
+    parse(wikitext, include, maxStage = constants_1.MAX_STAGE, config = Parser.getConfig()) {
+        const { Token } = require('./src/index');
         let token;
-        this.run(() => {
+        debug_1.Shadow.run(() => {
             token = new Token(wikitext.replace(/[\0\x7F]/gu, ''), config);
             try {
                 token.parse(maxStage, include);
@@ -50,7 +55,7 @@ const Parser = {
             catch (e) {
                 if (e instanceof Error) {
                     const file = path.join(__dirname, '..', 'errors', new Date().toISOString()), stage = token.getAttribute('stage');
-                    fs.writeFileSync(file, stage === this.MAX_STAGE ? wikitext : String(token));
+                    fs.writeFileSync(file, stage === constants_1.MAX_STAGE ? wikitext : String(token));
                     fs.writeFileSync(`${file}.err`, e.stack);
                     fs.writeFileSync(`${file}.json`, JSON.stringify({
                         stage, include: token.getAttribute('include'), config: this.config,
@@ -61,18 +66,13 @@ const Parser = {
         });
         return token;
     },
-    /** @implements */
-    run(callback) {
-        const result = callback();
-        return result;
-    },
 };
-const def = {}, immutable = new Set(['MAX_STAGE']), enumerable = new Set(['config', 'normalizeTitle', 'parse']);
+const def = {}, enumerable = new Set([
+    'normalizeTitle',
+    'parse',
+]);
 for (const key in Parser) {
-    if (immutable.has(key)) {
-        def[key] = { enumerable: false, writable: false };
-    }
-    else if (!enumerable.has(key)) {
+    if (!enumerable.has(key)) {
         def[key] = { enumerable: false };
     }
 }

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

@@ -3,33 +3,24 @@ import type { LintError } from '../index';
 import type { AstNodes, Token } from '../internal';
 /** 类似HTMLElement */
 export declare abstract class AstElement extends AstNode {
-    /** @browser */
     name?: string;
-    /**
-     * 子节点总数
-     * @browser
-     */
+    data: undefined;
+    /** 子节点总数 */
     get length(): number;
     /**
      * 可见部分
-     * @browser
      * @param separator 子节点间的连接符
      */
     text(separator?: string): string;
-    /**
-     * 合并相邻的文本子节点
-     * @browser
-     */
+    /** 合并相邻的文本子节点 */
     normalize(): void;
     /**
      * 移除子节点
-     * @browser
      * @param i 移除位置
      */
     removeAt(i: number): AstNodes;
     /**
      * 插入子节点
-     * @browser
      * @param node 待插入的子节点
      * @param i 插入位置
      * @throws `RangeError` 不能插入祖先节点
@@ -37,40 +28,28 @@ 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[];

package/dist/lib/element.js

@@ -22,46 +22,36 @@ const lintIgnoredExt = new Set([
 ]);
 /** 类似HTMLElement */
 class AstElement extends node_1.AstNode {
-    /** @browser */
-    name;
-    /**
-     * 子节点总数
-     * @browser
-     */
+    /** 子节点总数 */
     get length() {
         return this.childNodes.length;
     }
     /**
      * 可见部分
-     * @browser
      * @param separator 子节点间的连接符
      */
     text(separator) {
         return (0, string_1.text)(this.childNodes, separator);
     }
-    /**
-     * 合并相邻的文本子节点
-     * @browser
-     */
+    /** 合并相邻的文本子节点 */
     normalize() {
         const { childNodes } = this;
         for (let i = childNodes.length - 1; i >= 0; i--) {
-            const cur = childNodes[i], prev = childNodes[i - 1];
-            if (cur.type !== 'text' || this.getGaps(i - 1)) {
+            const { type, data } = childNodes[i], prev = childNodes[i - 1];
+            if (type !== 'text' || this.getGaps(i - 1)) {
                 //
             }
-            else if (cur.data === '') {
+            else if (data === '') {
                 childNodes.splice(i, 1);
             }
             else if (prev?.type === 'text') {
-                prev.setAttribute('data', prev.data + cur.data);
+                prev.setAttribute('data', prev.data + data);
                 childNodes.splice(i, 1);
             }
         }
     }
     /**
      * 移除子节点
-     * @browser
      * @param i 移除位置
      */
     removeAt(i) {
@@ -70,7 +60,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 插入子节点
-     * @browser
      * @param node 待插入的子节点
      * @param i 插入位置
      * @throws `RangeError` 不能插入祖先节点
@@ -83,7 +72,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 最近的祖先节点
-     * @browser
      * @param selector 选择器
      */
     closest(selector) {
@@ -101,7 +89,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 在末尾批量插入子节点
-     * @browser
      * @param elements 插入节点
      */
     append(...elements) {
@@ -111,7 +98,6 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 批量替换子节点
-     * @browser
      * @param elements 新的子节点
      */
     replaceChildren(...elements) {
@@ -120,28 +106,22 @@ class AstElement extends node_1.AstNode {
     }
     /**
      * 修改文本子节点
-     * @browser
      * @param str 新文本
      * @param i 子节点位置
      * @throws `RangeError` 对应位置的子节点不是文本节点
      */
     setText(str, i = 0) {
-        const oldText = this.childNodes[i], { data } = oldText;
+        const oldText = this.childNodes.at(i);
+        const { data } = oldText;
         oldText.replaceData(str);
         return data;
     }
-    /**
-     * 还原为wikitext
-     * @browser
-     * @param omit 忽略的节点类型
-     * @param separator 子节点间的连接符
-     */
+    /** @private */
     toString(omit, separator = '') {
         return this.childNodes.map(child => child.toString()).join(separator);
     }
     /**
      * Linter
-     * @browser
      * @param start
      */
     lint(start = this.getAbsoluteIndex()) {
@@ -151,7 +131,7 @@ class AstElement extends node_1.AstNode {
             return [];
         }
         const errors = [];
-        for (let i = 0, cur = start + this.getPadding(); i < this.length; i++) {
+        for (let i = 0, cur = start + this.getAttribute('padding'); i < this.length; i++) {
             const child = this.childNodes[i];
             errors.push(...child.lint(cur));
             cur += String(child).length + this.getGaps(i);

package/dist/lib/node.d.ts

@@ -16,65 +16,35 @@ export interface CaretPosition {
 /** 类似Node */
 export declare abstract class AstNode {
     #private;
-    /** @browser */
     type: TokenTypes | 'text';
-    /** @browser */
+    data?: string | undefined;
     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;
-    /**
-     * 获取根节点
-     * @browser
-     */
+    /** 获取根节点 */
     getRootNode(): Token | this;
     /**
      * 将字符位置转换为行列号
-     * @browser
      * @param index 字符位置
      */
     posFromIndex(index: number): Position | undefined;
     /**
      * 获取当前节点的相对字符位置，或其第`j`个子节点的相对字符位置
-     * @browser
      * @param j 子节点序号
      */
     getRelativeIndex(j?: number): number;
-    /**
-     * 获取当前节点的绝对位置
-     * @browser
-     */
+    /** 获取当前节点的绝对位置 */
     getAbsoluteIndex(): number;
 }

package/dist/lib/node.js

@@ -3,70 +3,44 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AstNode = void 0;
 /** 类似Node */
 class AstNode {
-    /** @browser */
-    type;
-    /** @browser */
     childNodes = [];
-    /** @browser */
     #parentNode;
-    /**
-     * 首位子节点
-     * @browser
-     */
+    /** 首位子节点 */
     get firstChild() {
         return this.childNodes[0];
     }
-    /**
-     * 末位子节点
-     * @browser
-     */
+    /** 末位子节点 */
     get lastChild() {
         return this.childNodes.at(-1);
     }
-    /**
-     * 父节点
-     * @browser
-     */
+    /** 父节点 */
     get parentNode() {
         return this.#parentNode;
     }
-    /**
-     * 后一个兄弟节点
-     * @browser
-     */
+    /** 后一个兄弟节点 */
     get nextSibling() {
         const childNodes = this.#parentNode?.childNodes;
         return childNodes && childNodes[childNodes.indexOf(this) + 1];
     }
-    /**
-     * 前一个兄弟节点
-     * @browser
-     */
+    /** 前一个兄弟节点 */
     get previousSibling() {
         const childNodes = this.#parentNode?.childNodes;
         return childNodes && childNodes[childNodes.indexOf(this) - 1];
     }
-    /**
-     * 行数
-     * @browser
-     */
+    /** 行数 */
     get offsetHeight() {
         return this.#getDimension().height;
     }
-    /**
-     * 最后一行的列数
-     * @browser
-     */
+    /** 最后一行的列数 */
     get offsetWidth() {
         return this.#getDimension().width;
     }
     /** @private */
-    hasAttribute(key) {
-        return key in this;
-    }
-    /** @private */
     getAttribute(key) {
-        return this.hasAttribute(key)
+        if (key === 'padding') {
+            return 0;
+        }
+        return key in this
             // @ts-expect-error noImplicitAny
             ? String(this[key])
             : undefined;
@@ -80,12 +54,8 @@ class AstNode {
             // @ts-expect-error noImplicitAny
             this[key] = value;
         }
-        return this;
     }
-    /**
-     * 获取根节点
-     * @browser
-     */
+    /** 获取根节点 */
     getRootNode() {
         let { parentNode } = this;
         while (parentNode?.parentNode) {
@@ -95,37 +65,33 @@ class AstNode {
     }
     /**
      * 将字符位置转换为行列号
-     * @browser
      * @param index 字符位置
      */
     posFromIndex(index) {
         const str = String(this);
         if (index >= -str.length && index <= str.length) {
             const lines = str.slice(0, index).split('\n');
-            return { top: lines.length - 1, left: lines.at(-1).length };
+            return {
+                top: lines.length - 1,
+                left: lines.at(-1).length,
+            };
         }
         return undefined;
     }
-    /**
-     * 获取行数和最后一行的列数
-     * @browser
-     */
+    /** 获取行数和最后一行的列数 */
     #getDimension() {
         const lines = String(this).split('\n');
-        return { height: lines.length, width: lines.at(-1).length };
-    }
-    /** @private */
-    getPadding() {
-        return 0;
+        return {
+            height: lines.length,
+            width: lines.at(-1).length,
+        };
     }
     /** @private */
-    // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
     getGaps(i) {
         return 0;
     }
     /**
      * 获取当前节点的相对字符位置，或其第`j`个子节点的相对字符位置
-     * @browser
      * @param j 子节点序号
      */
     getRelativeIndex(j) {
@@ -136,7 +102,7 @@ class AstNode {
          * @param parent 父节点
          */
         const getIndex = (end, parent) => childNodes.slice(0, end).reduce((acc, cur, i) => acc + String(cur).length + parent.getGaps(i), 0)
-            + parent.getPadding();
+            + parent.getAttribute('padding');
         if (j === undefined) {
             const { parentNode } = this;
             if (parentNode) {
@@ -148,10 +114,7 @@ class AstNode {
         ({ childNodes } = this);
         return getIndex(j, this);
     }
-    /**
-     * 获取当前节点的绝对位置
-     * @browser
-     */
+    /** 获取当前节点的绝对位置 */
     getAbsoluteIndex() {
         const { parentNode } = this;
         return parentNode ? parentNode.getAbsoluteIndex() + this.getRelativeIndex() : 0;

package/dist/lib/text.d.ts

@@ -3,35 +3,20 @@ import type { LintError } from '../index';
 /** 文本节点 */
 export declare class AstText extends AstNode {
     #private;
-    /** @browser */
     readonly type = "text";
     name: undefined;
-    /** @browser */
     data: string;
-    /**
-     * @browser
-     * @param text 包含文本
-     */
+    /** @param text 包含文本 */
     constructor(text: string);
-    /**
-     * 输出字符串
-     * @browser
-     */
-    toString(): string;
-    /**
-     * 可见部分
-     * @browser
-     */
+    /** 可见部分 */
     text(): string;
     /**
      * Linter
-     * @browser
      * @param start
      */
     lint(start?: number): LintError[];
     /**
      * 替换字符串
-     * @browser
      * @param text 替换的字符串
      */
     replaceData(text: string): void;