wikiparser-node 1.16.4 → 1.16.6

package/dist/lib/text.js

@@ -8,7 +8,6 @@ const node_1 = require("./node");
 /* NOT FOR BROWSER */
 const constants_1 = require("../util/constants");
 const debug_1 = require("../util/debug");
-const html_1 = require("../util/html");
 /* NOT FOR BROWSER END */
 const sp = String.raw `[${string_1.zs}\t]*`, source = String.raw `<\s*(?:/\s*)?([a-z]\w*)|\{+|\}+|\[{2,}|\[(?![^[]*?\])|((?:^|\])[^[]*?)\]+|(?:rfc|pmid)(?=[-:：]?${sp}\d)|isbn(?=[-:：]?${sp}(?:\d(?:${sp}|-)){6})`;
 // eslint-disable-next-line @typescript-eslint/no-unused-expressions, es-x/no-regexp-unicode-property-escapes
@@ -91,14 +90,18 @@ try {
 catch /* istanbul ignore next */ {
     wordRegex = /\w/u;
 }
-/** 文本节点 */
+/**
+ * text node
+ *
+ * 文本节点
+ */
 class AstText extends node_1.AstNode {
     data = '';
     get type() {
         return 'text';
     }
     /* NOT FOR BROWSER */
-    /** 文本长度 */
+    /** text length / 文本长度 */
     get length() {
         return this.data.length;
     }
@@ -181,7 +184,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;
             }
@@ -275,8 +279,10 @@ class AstText extends node_1.AstNode {
         }
     }
     /**
+     * Replace the text
+     *
      * 替换字符串
-     * @param text 替换的字符串
+     * @param text new text / 替换的字符串
      */
     replaceData(text) {
         this.#setData(text);
@@ -286,44 +292,59 @@ class AstText extends node_1.AstNode {
         return (0, string_1.escape)(this.data);
     }
     /* NOT FOR BROWSER */
-    /** 复制 */
+    /**
+     * Clone the node
+     *
+     * 复制
+     */
     cloneNode() {
         return new AstText(this.data);
     }
     /**
+     * Insert text at the end
+     *
      * 在后方添加字符串
-     * @param text 添加的字符串
+     * @param text text to be inserted / 添加的字符串
      */
     appendData(text) {
         this.#setData(this.data + text);
     }
     /**
+     * Delete text
+     *
      * 删减字符串
-     * @param offset 起始位置
-     * @param count 删减字符数
+     * @param offset start position / 起始位置
+     * @param count number of characters to be deleted / 删减字符数
      */
     deleteData(offset, count = Infinity) {
-        this.#setData(this.data.slice(0, offset) + (offset < 0 && offset + count >= 0 ? '' : this.data.slice(offset + count)));
+        this.#setData(this.data.slice(0, offset)
+            + (offset < 0 && offset + count >= 0 ? '' : this.data.slice(offset + count)));
     }
     /**
+     * Insert text
+     *
      * 插入字符串
-     * @param offset 插入位置
-     * @param text 待插入的字符串
+     * @param offset position to be inserted at / 插入位置
+     * @param text text to be inserted / 待插入的字符串
      */
     insertData(offset, text) {
         this.#setData(this.data.slice(0, offset) + text + this.data.slice(offset));
     }
     /**
+     * Get the substring
+     *
      * 提取子串
-     * @param offset 起始位置
-     * @param count 字符数
+     * @param offset start position / 起始位置
+     * @param count number of characters / 字符数
      */
     substringData(offset, count) {
         return this.data.substr(offset, count);
     }
     /**
+     * Split the text node into two parts
+     *
      * 将文本子节点分裂为两部分
-     * @param offset 分裂位置
+     * @param offset position to be splitted at / 分裂位置
      * @throws `RangeError` 错误的断开位置
      * @throws `Error` 没有父节点
      */
@@ -353,10 +374,15 @@ class AstText extends node_1.AstNode {
         }
         return j;
     }
-    /** 转义 `=` */
+    /**
+     * Escape `=`
+     *
+     * 转义 `=`
+     */
     escape() {
         const { TranscludeToken } = require('../src/transclude');
-        for (let i = this.data.lastIndexOf('='); i >= 0; i = this.data.lastIndexOf('=', i - 1)) {
+        let i = this.data.lastIndexOf('=');
+        for (; i >= 0; i = this.data.lastIndexOf('=', i - 1)) {
             if (i < this.length - 1) {
                 this.splitText(i + 1);
             }
@@ -367,12 +393,14 @@ class AstText extends node_1.AstNode {
         }
     }
     /**
+     * Generate HTML
+     *
      * 生成HTML
-     * @param nowrap 是否不换行
+     * @param nowrap whether to disable line-wrapping / 是否不换行
      */
     toHtml(nowrap) {
         const { data } = this;
-        return (0, html_1.font)(this, (0, string_1.sanitize)(nowrap ? data.replaceAll('\n', ' ') : data));
+        return (0, string_1.sanitize)(nowrap ? data.replaceAll('\n', ' ') : data);
     }
     /** @private */
     removeBlankLines() {

package/dist/lib/title.d.ts

@@ -1,21 +1,25 @@
 import type { Config } from '../base';
-/** MediaWiki页面标题对象 */
+/**
+ * title object of a MediaWiki page
+ *
+ * MediaWiki页面标题对象
+ */
 export declare class Title {
     #private;
-    interwiki: string;
     readonly valid: boolean;
-    /** 命名空间 */
+    interwiki: string;
+    /** 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;
     set extension(extension: string | undefined);
     /** @throws `RangeError` undefined namespace */
@@ -29,24 +33,54 @@ 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 条目路径
+     * @param articlePath article path / 条目路径
      */
     getUrl(articlePath?: string): string;
-    /** 执行单向转换 */
+    /**
+     * Perform unidirectional language conversion
+     *
+     * 执行单向转换
+     */
     autoConvert(): void;
-    /** 转换为主页面 */
+    /**
+     * Get the title of its subject page
+     *
+     * 转换为主页面
+     */
     toSubjectPage(): void;
-    /** 转换为讨论页面 */
+    /**
+     * Get the title of its talk page
+     *
+     * 转换为讨论页面
+     */
     toTalkPage(): void;
-    /** 是否是讨论页 */
+    /**
+     * Check if the title is a talk page
+     *
+     * 是否是讨论页
+     */
     isTalkPage(): boolean;
-    /** 转换为上一级页面 */
+    /**
+     * Get the title of its base page
+     *
+     * 转换为上一级页面
+     */
     toBasePage(): void;
-    /** 转换为根页面 */
+    /**
+     * Get the title of its root page
+     *
+     * 转换为根页面
+     */
     toRootPage(): void;
 }

package/dist/lib/title.js

@@ -6,25 +6,29 @@ const string_1 = require("../util/string");
 const constants_1 = require("../util/constants");
 const index_1 = require("../index");
 /* NOT FOR BROWSER END */
-/** MediaWiki页面标题对象 */
+/**
+ * title object of a MediaWiki page
+ *
+ * MediaWiki页面标题对象
+ */
 class Title {
     #main;
     #namespaces;
     #path;
     #ns;
     #fragment;
-    interwiki = '';
     valid;
     /** @private */
     encoded = false;
     /* NOT FOR BROWSER */
     #redirectFragment;
+    interwiki = '';
     /** @private */
     conversionTable = new Map();
     /** @private */
     redirects = new Map();
     /* NOT FOR BROWSER END */
-    /** 命名空间 */
+    /** namespace number / 命名空间 */
     get ns() {
         return this.#ns;
     }
@@ -32,7 +36,7 @@ class Title {
     get fragment() {
         return this.#fragment;
     }
-    /** 不含命名空间的标题主体部分 */
+    /** main part without the namespace / 不含命名空间的标题主体部分 */
     get main() {
         return this.#main;
     }
@@ -40,16 +44,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();
@@ -80,7 +84,8 @@ class Title {
                 catch { }
             }
             // eslint-disable-next-line es-x/no-string-prototype-trimstart-trimend
-            this.#fragment = (0, string_1.decodeHtml)(fragment).replace(/[_ ]+/gu, ' ').trimEnd().replaceAll(' ', '_');
+            this.#fragment = (0, string_1.decodeHtml)(fragment).replace(/[_ ]+/gu, ' ').trimEnd()
+                .replaceAll(' ', '_');
         }
     }
     /* NOT FOR BROWSER END */
@@ -92,7 +97,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 {
@@ -141,35 +146,35 @@ 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
+            || this.interwiki
+            || 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 },
-            /* NOT FOR BROWSER */
-            valid: { writable: false },
-            conversionTable: { enumerable: false },
-            redirects: { enumerable: 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 },
+                /* NOT FOR BROWSER */
+                valid: { writable: false },
+                conversionTable: { enumerable: false },
+                redirects: { enumerable: false },
+            });
+        }
     }
-    /** @private */
-    toString(display) {
-        return (display ? this.title.replace(/_/gu, ' ') : this.title)
-            + (this.#fragment === undefined
-                && this.#redirectFragment === undefined
-                ? ''
-                : `#${this.#fragment
-                    ?? this.#redirectFragment}`);
-    }
-    /** 检测是否是重定向 */
+    /**
+     * Check if the title is a redirect
+     *
+     * 检测是否是重定向
+     */
     getRedirection() {
-        const prefix = this.interwiki + (this.interwiki && ':') + this.prefix;
+        const prefix = this.interwiki + (this.interwiki && ':') + // eslint-disable-line @stylistic/operator-linebreak
+            this.prefix;
         let title = (prefix + this.main).replace(/ /gu, '_');
         /* NOT FOR BROWSER */
         let redirected = this.#redirect(title);
@@ -190,8 +195,10 @@ class Title {
         this.#fragment = fragment;
     }
     /**
+     * Get the URL of the title
+     *
      * 生成URL
-     * @param articlePath 条目路径
+     * @param articlePath article path / 条目路径
      */
     getUrl(articlePath) {
         LSP: { // eslint-disable-line no-unused-labels
@@ -214,6 +221,15 @@ class Title {
         }
     }
     /* NOT FOR BROWSER */
+    /** @private */
+    toString(display) {
+        return (display ? this.title.replace(/_/gu, ' ') : this.title)
+            + (this.#fragment === undefined
+                && this.#redirectFragment === undefined
+                ? ''
+                : `#${this.#fragment
+                    ?? this.#redirectFragment}`);
+    }
     /**
      * 处理重定向
      * @param title 原标题
@@ -232,7 +248,11 @@ class Title {
         }
         return '';
     }
-    /** 执行单向转换 */
+    /**
+     * Perform unidirectional language conversion
+     *
+     * 执行单向转换
+     */
     autoConvert() {
         const { conversionTable } = this;
         if (conversionTable.size > 0) {
@@ -240,33 +260,54 @@ class Title {
             this.main = this.main.replace(regex, p => conversionTable.get(p));
         }
     }
-    /** 转换为主页面 */
+    /**
+     * Get the title of its subject page
+     *
+     * 转换为主页面
+     */
     toSubjectPage() {
         if (this.isTalkPage()) {
             this.#ns--;
         }
     }
-    /** 转换为讨论页面 */
+    /**
+     * Get the title of its talk page
+     *
+     * 转换为讨论页面
+     */
     toTalkPage() {
         if (!this.isTalkPage()) {
             this.#ns++;
         }
     }
-    /** 是否是讨论页 */
+    /**
+     * Check if the title is a talk page
+     *
+     * 是否是讨论页
+     */
     isTalkPage() {
         return this.ns % 2 === 1;
     }
-    /** 转换为上一级页面 */
+    /**
+     * Get the title of its base page
+     *
+     * 转换为上一级页面
+     */
     toBasePage() {
         this.main = this.main.replace(/\/[^/]*$/u, '');
     }
-    /** 转换为根页面 */
+    /**
+     * Get the title of its root page
+     *
+     * 转换为根页面
+     */
     toRootPage() {
         this.main = this.main.replace(/\/.*/u, '');
     }
     /** @private */
     getTitleAttr() {
-        return this.title.replace(/^Media:/u, '').replace(/["_]/gu, p => p === '"' ? '&quot;' : ' ');
+        return this.title.replace(/^Media:/u, '')
+            .replace(/["_]/gu, p => p === '"' ? '&quot;' : ' ');
     }
 }
 exports.Title = Title;

package/dist/mixin/attributesParent.d.ts

@@ -1,49 +1,65 @@
 export interface AttributesParentBase {
-    /** getAttrs()方法的getter写法 */
+    /** all attributes / 全部属性 */
     attributes: Record<string, string | true>;
-    /** 以字符串表示的class属性 */
+    /** class attribute in string / 以字符串表示的class属性 */
     className: string;
-    /** 以Set表示的class属性 */
+    /** class attribute in Set / 以Set表示的class属性 */
     readonly classList: Set<string>;
-    /** id属性 */
+    /** id attribute / id属性 */
     id: string;
     /**
-     * 获取AttributesToken子节点的属性
-     * @param key 属性键
+     * Get the attribute
+     *
+     * 获取指定属性
+     * @param key attribute name / 属性键
      */
     getAttr(key: string): string | true | undefined;
     /**
-     * AttributesToken子节点是否具有某属性
-     * @param key 属性键
+     * Check if the token has a certain attribute
+     *
+     * 是否具有某属性
+     * @param key attribute name / 属性键
      */
     hasAttr(key: string): boolean;
-    /** 列举AttributesToken子节点的属性键 */
+    /**
+     * Get all attribute names
+     *
+     * 获取全部的属性名
+     */
     getAttrNames(): Set<string>;
-    /** 获取AttributesToken子节点的全部标签属性 */
+    /**
+     * Get all attributes
+     *
+     * 获取全部属性
+     */
     getAttrs(): Record<string, string | true>;
     /**
-     * 对AttributesToken子节点设置属性
-     * @param key 属性键
-     * @param value 属性值
-     * @param prop 属性对象
+     * Set the attribute
+     *
+     * 设置指定属性
+     * @param key attribute name / 属性键
+     * @param value attribute value / 属性值
+     * @param prop attribute object / 属性对象
      */
     setAttr(key: string, value: string | boolean): void;
     setAttr(prop: Record<string, string | boolean>): void;
     /**
-     * 移除AttributesToken子节点的某属性
-     * @param key 属性键
+     * Remove an attribute
+     *
+     * 移除指定属性
+     * @param key attribute name / 属性键
      */
     removeAttr(key: string): void;
     /**
-     * 开关AttributesToken子节点的某属性
-     * @param key 属性键
-     * @param force 强制开启或关闭
+     * Toggle the specified attribute
+     *
+     * 开关指定属性
+     * @param key attribute name / 属性键
+     * @param force whether to force enabling or disabling / 强制开启或关闭
      */
     toggleAttr(key: string, force?: boolean): void;
 }
 /**
  * 子节点含有AttributesToken的类
  * @param i AttributesToken子节点的位置
- * @param constructor 基类
- * @param _ context
  */

package/dist/mixin/attributesParent.js

@@ -7,8 +7,6 @@ const constants_1 = require("../util/constants");
 /**
  * 子节点含有AttributesToken的类
  * @param i AttributesToken子节点的位置
- * @param constructor 基类
- * @param _ context
  */
 const attributesParent = (i = 0) => (constructor, _) => {
     /** 子节点含有AttributesToken的类 */

package/dist/mixin/flagsParent.d.ts

@@ -1,38 +1,64 @@
 import type { ConverterFlagsToken } from '../src/converterFlags';
 export interface FlagsParentBase {
-    /** 所有转换类型标记 */
+    /** all language conversion flags / 所有转换类型标记 */
     flags: Set<string>;
-    /** 获取所有转换类型标记 */
+    /**
+     * Get all language conversion flags
+     *
+     * 获取所有转换类型标记
+     */
     getAllFlags(): Set<string>;
-    /** 获取有效的转换类型标记 */
+    /**
+     * Get effective language conversion flags
+     *
+     * 获取有效的转换类型标记
+     */
     getEffectiveFlags(): Set<string>;
-    /** 获取未知的转换类型标记 */
+    /**
+     * Get unknown language conversion flags
+     *
+     * 获取未知的转换类型标记
+     */
     getUnknownFlags(): Set<string>;
-    /** 获取指定语言变体的转换标记 */
+    /**
+     * Get language coversion flags that specify a language variant
+     *
+     * 获取指定语言变体的转换标记
+     */
     getVariantFlags(): Set<string>;
     /**
+     * Check if a language conversion flag is present
+     *
      * 是否具有某转换类型标记
-     * @param flag 转换类型标记
+     * @param flag language conversion flag / 转换类型标记
      */
     hasFlag(flag: string): boolean;
     /**
+     * Check if an effective language conversion flag is present
+     *
      * 是否具有某有效的转换类型标记
-     * @param flag 转换类型标记
+     * @param flag language conversion flag / 转换类型标记
      */
     hasEffectiveFlag(flag: string): boolean;
     /**
-     * 移除转换类型标记
-     * @param flag 转换类型标记
+     * Remove a language conversion flag
+     *
+     * 移除某转换类型标记
+     * @param flag language conversion flag / 转换类型标记
      */
     removeFlag(flag: string): void;
     /**
+     * Set a language conversion flag
+     *
      * 设置转换类型标记
-     * @param flag 转换类型标记
+     * @param flag language conversion flag / 转换类型标记
      */
     setFlag(flag: string): void;
     /**
-     * 开关某转换类型标记
-     * @param flag 转换类型标记
+     * Toggle a language conversion flag
+     *
+     * 开关转换类型标记
+     * @param flag language conversion flag / 转换类型标记
      */
     toggleFlag(flag: string): void;
 }

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

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