wikilint 2.16.3 → 2.16.5

package/dist/lib/node.d.ts

@@ -13,57 +13,89 @@ export interface CaretPosition {
     readonly offsetNode: AstNodes;
     readonly offset: number;
 }
-/** 类似Node */
+/**
+ * Node-like
+ *
+ * 类似Node
+ */
 export declare abstract class AstNode implements AstNodeBase {
     #private;
     data?: string | undefined;
     readonly childNodes: readonly AstNodes[];
     abstract get type(): TokenTypes | 'text';
     abstract set type(value: TokenTypes | "text");
-    /** 可见部分 */
+    /**
+     * Get the visible text
+     *
+     * 可见部分
+     */
     text(): string;
     lint(): LintError[];
-    /** 首位子节点 */
+    /** first child node / 首位子节点 */
     get firstChild(): AstNodes | undefined;
-    /** 末位子节点 */
+    /** last child node / 末位子节点 */
     get lastChild(): AstNodes | undefined;
-    /** 父节点 */
+    /** parent node / 父节点 */
     get parentNode(): Token | undefined;
-    /** 后一个兄弟节点 */
+    /** next sibling node / 后一个兄弟节点 */
     get nextSibling(): AstNodes | undefined;
-    /** 前一个兄弟节点 */
+    /** previous sibling node / 前一个兄弟节点 */
     get previousSibling(): AstNodes | undefined;
-    /** 行数 */
+    /** number of lines / 行数 */
     get offsetHeight(): number;
-    /** 最后一行的列数 */
+    /** number of columns of the last line / 最后一行的列数 */
     get offsetWidth(): number;
-    /** 获取根节点 */
+    /**
+     * Get the root node
+     *
+     * 获取根节点
+     */
     getRootNode(): Token | this;
     /**
+     * Convert the position to the character index
+     *
      * 将行列号转换为字符位置
-     * @param top 行号
-     * @param left 列号
+     * @param top line number / 行号
+     * @param left column number / 列号
      */
     indexFromPos(top: number, left: number): number | undefined;
     /**
+     * Convert the character indenx to the position
+     *
      * 将字符位置转换为行列号
-     * @param index 字符位置
+     * @param index character index / 字符位置
      */
     posFromIndex(index: number): Position | undefined;
     /**
+     * Get the relative character index of the current node, or its `j`-th child node
+     *
      * 获取当前节点的相对字符位置，或其第`j`个子节点的相对字符位置
-     * @param j 子节点序号
+     * @param j rank of the child node / 子节点序号
      */
     getRelativeIndex(j?: number): number;
-    /** 获取当前节点的绝对位置 */
+    /**
+     * Get the absolute character index of the current node
+     *
+     * 获取当前节点的绝对位置
+     */
     getAbsoluteIndex(): number;
-    /** 获取当前节点的行列位置和大小 */
+    /**
+     * Get the position and dimension of the current node
+     *
+     * 获取当前节点的行列位置和大小
+     */
     getBoundingClientRect(): Dimension & Position;
     /**
+     * Whether to be of a certain type
+     *
      * 是否是某种类型的节点
-     * @param type 节点类型
+     * @param type token type / 节点类型
+     */
+    is<T extends Token>(type: TokenTypes): this is T;
+    /**
+     * Get the text and the start/end positions of all lines
+     *
+     * 获取所有行的wikitext和起止位置
      */
-    is<T extends Token>(type: string): this is T;
-    /** 获取所有行的wikitext和起止位置 */
     getLines(): [string, number, number][];
 }

package/dist/lib/node.js

@@ -3,14 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AstNode = void 0;
 /* eslint-disable @typescript-eslint/no-base-to-string */
 const lint_1 = require("../util/lint");
+const debug_1 = require("../util/debug");
 /**
- * 获取子节点相对于父节点的字符位置
- * @param j 子节点序号
- * @param parent 父节点
+ * Node-like
+ *
+ * 类似Node
  */
-const getIndex = (j, parent) => parent.childNodes.slice(0, j).reduce((acc, cur, i) => acc + cur.toString().length + parent.getGaps(i), 0)
-    + parent.getAttribute('padding');
-/** 类似Node */
 class AstNode {
     childNodes = [];
     #parentNode;
@@ -19,35 +17,41 @@ class AstNode {
     #lines;
     #root;
     #aIndex;
-    /** 首位子节点 */
+    #rIndex = {};
+    /** first child node / 首位子节点 */
     get firstChild() {
         return this.childNodes[0];
     }
-    /** 末位子节点 */
+    /** last child node / 末位子节点 */
     get lastChild() {
         return this.childNodes[this.childNodes.length - 1];
     }
-    /** 父节点 */
+    /** parent node / 父节点 */
     get parentNode() {
         return this.#parentNode;
     }
-    /** 后一个兄弟节点 */
+    /** next sibling node / 后一个兄弟节点 */
     get nextSibling() {
         return this.#nextSibling;
     }
-    /** 前一个兄弟节点 */
+    /** previous sibling node / 前一个兄弟节点 */
     get previousSibling() {
         return this.#previousSibling;
     }
-    /** 行数 */
+    /** number of lines / 行数 */
     get offsetHeight() {
         return this.#getDimension().height;
     }
-    /** 最后一行的列数 */
+    /** number of columns of the last line / 最后一行的列数 */
     get offsetWidth() {
         return this.#getDimension().width;
     }
     /** @private */
+    getChildNodes() {
+        const { childNodes } = this;
+        return Object.isFrozen(childNodes) ? [...childNodes] : childNodes;
+    }
+    /** @private */
     getAttribute(key) {
         return (key === 'padding' ? 0 : this[key]);
     }
@@ -67,38 +71,51 @@ class AstNode {
             case 'previousSibling':
                 this.#previousSibling = value;
                 break;
+            case 'aIndex':
+                this.#aIndex = [debug_1.Shadow.rev, value];
+                break;
             default:
                 this[key] = value; // eslint-disable-line @typescript-eslint/no-explicit-any
         }
     }
-    /** 获取根节点 */
+    /**
+     * Get the root node
+     *
+     * 获取根节点
+     */
     getRootNode() {
         return (0, lint_1.cache)(this.#root, () => this.parentNode?.getRootNode() ?? this, value => {
             const [, root] = value;
-            if (root.type === 'root' && root.getAttribute('built')) {
+            if (root.type === 'root') {
                 this.#root = value;
             }
         });
     }
     /**
+     * Convert the position to the character index
+     *
      * 将行列号转换为字符位置
-     * @param top 行号
-     * @param left 列号
+     * @param top line number / 行号
+     * @param left column number / 列号
      */
     indexFromPos(top, left) {
-        if (top < 0 || left < 0) {
-            return undefined;
-        }
-        const lines = this.getLines();
-        if (top >= lines.length) {
-            return undefined;
+        LSP: { // eslint-disable-line no-unused-labels
+            if (top < 0 || left < 0) {
+                return undefined;
+            }
+            const lines = this.getLines();
+            if (top >= lines.length) {
+                return undefined;
+            }
+            const [, start, end] = lines[top], index = start + left;
+            return index > end ? undefined : index;
         }
-        const [, start, end] = lines[top], index = start + left;
-        return index > end ? undefined : index;
     }
     /**
+     * Convert the character indenx to the position
+     *
      * 将字符位置转换为行列号
-     * @param index 字符位置
+     * @param index character index / 字符位置
      */
     posFromIndex(index) {
         const { length } = String(this);
@@ -119,17 +136,35 @@ class AstNode {
         return 0;
     }
     /**
+     * Get the relative character index of the current node, or its `j`-th child node
+     *
      * 获取当前节点的相对字符位置，或其第`j`个子节点的相对字符位置
-     * @param j 子节点序号
+     * @param j rank of the child node / 子节点序号
      */
     getRelativeIndex(j) {
         if (j === undefined) {
             const { parentNode } = this;
-            return parentNode ? getIndex(parentNode.childNodes.indexOf(this), parentNode) : 0;
+            return parentNode
+                ? parentNode.getRelativeIndex(parentNode.childNodes.indexOf(this))
+                : 0;
         }
-        return getIndex(j, this);
+        return (0, lint_1.cache)(this.#rIndex[j], () => {
+            const { childNodes } = this, n = j + (j < 0 ? childNodes.length : 0);
+            let acc = this.getAttribute('padding');
+            for (let i = 0; i < n; i++) {
+                this.#rIndex[i] = [debug_1.Shadow.rev, acc];
+                acc += childNodes[i].toString().length + this.getGaps(i);
+            }
+            return acc;
+        }, value => {
+            this.#rIndex[j] = value;
+        });
     }
-    /** 获取当前节点的绝对位置 */
+    /**
+     * Get the absolute character index of the current node
+     *
+     * 获取当前节点的绝对位置
+     */
     getAbsoluteIndex() {
         return (0, lint_1.cache)(this.#aIndex, () => {
             const { parentNode } = this;
@@ -138,9 +173,14 @@ class AstNode {
             this.#aIndex = value;
         });
     }
-    /** 获取当前节点的行列位置和大小 */
+    /**
+     * Get the position and dimension of the current node
+     *
+     * 获取当前节点的行列位置和大小
+     */
     getBoundingClientRect() {
-        return { ...this.#getDimension(), ...this.getRootNode().posFromIndex(this.getAbsoluteIndex()) };
+        // eslint-disable-next-line no-unused-labels
+        LSP: return { ...this.#getDimension(), ...this.getRootNode().posFromIndex(this.getAbsoluteIndex()) };
     }
     /** @private */
     seal(key, permanent) {
@@ -150,13 +190,19 @@ class AstNode {
         });
     }
     /**
+     * Whether to be of a certain type
+     *
      * 是否是某种类型的节点
-     * @param type 节点类型
+     * @param type token type / 节点类型
      */
     is(type) {
         return this.type === type;
     }
-    /** 获取所有行的wikitext和起止位置 */
+    /**
+     * Get the text and the start/end positions of all lines
+     *
+     * 获取所有行的wikitext和起止位置
+     */
     getLines() {
         return (0, lint_1.cache)(this.#lines, () => {
             const results = [];

package/dist/lib/text.d.ts

@@ -1,6 +1,10 @@
 import { AstNode } from './node';
 import type { LintError } from '../base';
-/** 文本节点 */
+/**
+ * text node
+ *
+ * 文本节点
+ */
 export declare class AstText extends AstNode {
     #private;
     readonly name: undefined;
@@ -9,8 +13,10 @@ export declare class AstText extends AstNode {
     /** @param text 包含文本 */
     constructor(text: string);
     /**
+     * Replace the text
+     *
      * 替换字符串
-     * @param text 替换的字符串
+     * @param text new text / 替换的字符串
      */
     replaceData(text: string): void;
 }

package/dist/lib/text.js

@@ -57,7 +57,11 @@ try {
 catch /* istanbul ignore next */ {
     wordRegex = /\w/u;
 }
-/** 文本节点 */
+/**
+ * text node
+ *
+ * 文本节点
+ */
 class AstText extends node_1.AstNode {
     data = '';
     get type() {
@@ -134,7 +138,8 @@ class AstText extends node_1.AstNode {
             const { 0: char, length } = error, magicLink = char === 'r' || char === 'p' || char === 'i';
             if (char === '<' && !tags.has(tag.toLowerCase())
                 || char === '[' && type === 'ext-link-text' && (/&(?:rbrack|#93|#x5[Dd];);/u.test(data.slice(index + 1))
-                    || nextSibling?.is('ext') && nextName === 'nowiki' && nextSibling.innerText?.includes(']'))
+                    || nextSibling?.is('ext') && nextName === 'nowiki'
+                        && nextSibling.innerText?.includes(']'))
                 || magicLink && (!parentNode.getAttribute('plain') || noLinkTypes.has(type))) {
                 continue;
             }
@@ -221,8 +226,10 @@ class AstText extends node_1.AstNode {
         this.setAttribute('data', text);
     }
     /**
+     * Replace the text
+     *
      * 替换字符串
-     * @param text 替换的字符串
+     * @param text new text / 替换的字符串
      */
     replaceData(text) {
         this.#setData(text);

package/dist/lib/title.d.ts

@@ -1,21 +1,24 @@
 import type { Config } from '../base';
-/** MediaWiki页面标题对象 */
+/**
+ * title object of a MediaWiki page
+ *
+ * MediaWiki页面标题对象
+ */
 export declare class Title {
     #private;
-    interwiki: string;
     readonly valid: boolean;
-    /** 命名空间 */
+    /** namespace number / 命名空间 */
     get ns(): number;
     /** 片段标识符 */
     get fragment(): string | undefined;
-    /** 不含命名空间的标题主体部分 */
+    /** main part without the namespace / 不含命名空间的标题主体部分 */
     get main(): string;
     set main(title: string);
-    /** 命名空间前缀 */
+    /** namespace prefix / 命名空间前缀 */
     get prefix(): string;
-    /** 完整标题 */
+    /** full title / 完整标题 */
     get title(): string;
-    /** 扩展名 */
+    /** file extension / 扩展名 */
     get extension(): string | undefined;
     /**
      * @see MediaWikiTitleCodec::splitTitleString
@@ -25,7 +28,18 @@ export declare class Title {
      * @param decode 是否需要解码
      * @param selfLink 是否允许selfLink
      */
-    constructor(title: string, defaultNs: number, config: Config, decode: boolean, selfLink: boolean);
-    /** 检测是否是重定向 */
+    constructor(title: string, defaultNs: number, config: Config, temporary: boolean, decode: boolean, selfLink: boolean);
+    /**
+     * Check if the title is a redirect
+     *
+     * 检测是否是重定向
+     */
     getRedirection(): [boolean, string];
+    /**
+     * Get the URL of the title
+     *
+     * 生成URL
+     * @param articlePath article path / 条目路径
+     */
+    getUrl(articlePath?: string): string;
 }

package/dist/lib/title.js

@@ -2,17 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Title = void 0;
 const string_1 = require("../util/string");
-/** MediaWiki页面标题对象 */
+/**
+ * title object of a MediaWiki page
+ *
+ * MediaWiki页面标题对象
+ */
 class Title {
     #main;
     #namespaces;
+    #path;
     #ns;
     #fragment;
-    interwiki = '';
     valid;
     /** @private */
     encoded = false;
-    /** 命名空间 */
+    /** namespace number / 命名空间 */
     get ns() {
         return this.#ns;
     }
@@ -20,7 +24,7 @@ class Title {
     get fragment() {
         return this.#fragment;
     }
-    /** 不含命名空间的标题主体部分 */
+    /** main part without the namespace / 不含命名空间的标题主体部分 */
     get main() {
         return this.#main;
     }
@@ -28,16 +32,16 @@ class Title {
         title = title.replace(/_/gu, ' ').trim();
         this.#main = title && title[0].toUpperCase() + title.slice(1);
     }
-    /** 命名空间前缀 */
+    /** namespace prefix / 命名空间前缀 */
     get prefix() {
         const namespace = this.#namespaces[this.ns];
         return namespace + (namespace && ':');
     }
-    /** 完整标题 */
+    /** full title / 完整标题 */
     get title() {
         return this.getRedirection()[1];
     }
-    /** 扩展名 */
+    /** file extension / 扩展名 */
     get extension() {
         const { main } = this, i = main.lastIndexOf('.');
         return i === -1 ? undefined : main.slice(i + 1).toLowerCase();
@@ -50,7 +54,7 @@ class Title {
      * @param decode 是否需要解码
      * @param selfLink 是否允许selfLink
      */
-    constructor(title, defaultNs, config, decode, selfLink) {
+    constructor(title, defaultNs, config, temporary, decode, selfLink) {
         const subpage = title.trim().startsWith('../');
         if (decode && title.includes('%')) {
             try {
@@ -92,25 +96,30 @@ class Title {
             this.#fragment = fragment.replace(/ /gu, '_');
             title = title.slice(0, i).trim();
         }
-        this.valid = Boolean(title || this.interwiki || selfLink && this.ns === 0 && this.#fragment !== undefined)
+        this.valid = Boolean(title
+            || selfLink && this.ns === 0 && this.#fragment !== undefined)
             && (0, string_1.decodeHtml)(title) === title
             && !/^:|\0\d+[eh!+-]\x7F|[<>[\]{}|\n]|%[\da-f]{2}|(?:^|\/)\.{1,2}(?:$|\/)/iu.test(subpage ? /^(?:\.\.\/)+(.*)/u.exec(title)[1] : title);
         this.main = title;
-        Object.defineProperties(this, {
-            encoded: { enumerable: false, writable: false },
-        });
         this.#namespaces = config.namespaces;
+        this.#path = config.articlePath || '/wiki/$1';
+        if (!this.#path.includes('$1')) {
+            this.#path += `${this.#path.endsWith('/') ? '' : '/'}$1`;
+        }
+        if (!temporary) {
+            Object.defineProperties(this, {
+                encoded: { enumerable: false, writable: false },
+            });
+        }
     }
-    /** @private */
-    toString(display) {
-        return (display ? this.title.replace(/_/gu, ' ') : this.title)
-            + (this.#fragment === undefined
-                ? ''
-                : `#${this.#fragment}`);
-    }
-    /** 检测是否是重定向 */
+    /**
+     * Check if the title is a redirect
+     *
+     * 检测是否是重定向
+     */
     getRedirection() {
-        const prefix = this.interwiki + (this.interwiki && ':') + this.prefix;
+        // eslint-disable-next-line @typescript-eslint/prefer-destructuring
+        const prefix = this.prefix;
         // eslint-disable-next-line prefer-const
         let title = (prefix + this.main).replace(/ /gu, '_');
         return [false, title];
@@ -119,5 +128,31 @@ class Title {
     setFragment(fragment) {
         this.#fragment = fragment;
     }
+    /**
+     * Get the URL of the title
+     *
+     * 生成URL
+     * @param articlePath article path / 条目路径
+     */
+    getUrl(articlePath) {
+        LSP: { // eslint-disable-line no-unused-labels
+            if (typeof articlePath === 'string') {
+                this.#path = articlePath || '/wiki/$1';
+                if (!this.#path.includes('$1')) {
+                    this.#path += `${this.#path.endsWith('/') ? '' : '/'}$1`;
+                }
+            }
+            const { title, fragment } = this;
+            if (title) {
+                return this.#path.replace('$1', encodeURIComponent(title)
+                    + (fragment === undefined
+                        ? ''
+                        : `#${encodeURIComponent(
+                        // eslint-disable-next-line @stylistic/comma-dangle
+                        fragment)}`));
+            }
+            return fragment === undefined ? '' : `#${encodeURIComponent(fragment)}`;
+        }
+    }
 }
 exports.Title = Title;

package/dist/mixin/attributesParent.d.ts

@@ -1,13 +1,13 @@
 export interface AttributesParentBase {
     /**
-     * 获取AttributesToken子节点的属性
-     * @param key 属性键
+     * Get the attribute
+     *
+     * 获取指定属性
+     * @param key attribute name / 属性键
      */
     getAttr(key: string): string | true | undefined;
 }
 /**
  * 子节点含有AttributesToken的类
  * @param i AttributesToken子节点的位置
- * @param constructor 基类
- * @param _ context
  */

package/dist/mixin/attributesParent.js

@@ -5,19 +5,17 @@ const debug_1 = require("../util/debug");
 /**
  * 子节点含有AttributesToken的类
  * @param i AttributesToken子节点的位置
- * @param constructor 基类
- * @param _ context
  */
 const attributesParent = (i = 0) => (constructor, _) => {
     /** 子节点含有AttributesToken的类 */
     class AttributesParent extends constructor {
         /** AttributesToken子节点 */
-        get #attributesChild() {
+        #getAttributesChild() {
             return this.childNodes[i];
         }
         /** @implements */
         getAttr(key) {
-            return this.#attributesChild.getAttr(key);
+            return this.#getAttributesChild().getAttr(key);
         }
     }
     (0, debug_1.mixin)(AttributesParent, constructor);

package/dist/mixin/hidden.d.ts

@@ -2,6 +2,4 @@
  * 解析后不可见的类
  * @param linter 是否覆写 lint 方法
  * @param html 是否覆写 toHtml 方法
- * @param constructor 基类
- * @param _ context
  */

package/dist/mixin/hidden.js

@@ -6,8 +6,6 @@ const debug_1 = require("../util/debug");
  * 解析后不可见的类
  * @param linter 是否覆写 lint 方法
  * @param html 是否覆写 toHtml 方法
- * @param constructor 基类
- * @param _ context
  */
 const hiddenToken = (linter = true, html = true) => (constructor, _) => {
     /** 解析后不可见的类 */

package/dist/parser/braces.js

@@ -30,7 +30,8 @@ const parseBraces = (wikitext, config, accum) => {
     let moreBraces = lastBraces + wikitext.length !== -1;
     let regex = new RegExp(source + (moreBraces ? openBraces : ''), 'gmu'), mt = regex.exec(wikitext), lastIndex;
     while (mt
-        || lastIndex !== undefined && lastIndex <= wikitext.length && stack[stack.length - 1]?.[0]?.startsWith('=')) {
+        || lastIndex !== undefined && lastIndex <= wikitext.length
+            && stack[stack.length - 1]?.[0]?.startsWith('=')) {
         if (mt?.[1]) {
             const [, { length }] = mt;
             mt[0] = mt[0].slice(length);
@@ -80,7 +81,8 @@ const parseBraces = (wikitext, config, accum) => {
                 const argParts = parts.map(part => part.join('=')), str = argParts.length > 1 && (0, string_1.removeComment)(argParts[1]).trim();
                 // @ts-expect-error abstract class
                 new arg_1.ArgToken(argParts, config, accum);
-                if (str && str.endsWith(':') && subst.includes(str.slice(0, -1).toLowerCase())) {
+                if (str && str.endsWith(':')
+                    && subst.includes(str.slice(0, -1).toLowerCase())) {
                     ch = 's';
                 }
             }