wikiparser-node 1.16.4 → 1.16.5

package/dist/src/table/tr.js

@@ -7,8 +7,10 @@ const trBase_1 = require("./trBase");
 const constants_1 = require("../../util/constants");
 /* NOT FOR BROWSER END */
 /**
+ * table row that contains the newline at the beginning but not at the end
+ *
  * 表格行，含开头的换行，不含结尾的换行
- * @classdesc `{childNodes: [SyntaxToken, AttributesToken, ?Token, ...TdToken]}`
+ * @classdesc `{childNodes: [SyntaxToken, AttributesToken, ?Token, ...TdToken[]]}`
  */
 class TrToken extends trBase_1.TrBaseToken {
     /* NOT FOR BROWSER END */
@@ -20,9 +22,7 @@ class TrToken extends trBase_1.TrBaseToken {
      * @param attr 表格属性
      */
     constructor(syntax, attr, config, accum) {
-        super(/^\n[^\S\n]*(?:\|-+|\{\{\s*!\s*\}\}-+|\{\{\s*!-\s*\}\}-*)$/u, syntax, 'tr', attr, config, accum, {
-            Token: 2, SyntaxToken: 0, AttributesToken: 1, TdToken: '2:',
-        });
+        super(/^\n[^\S\n]*(?:\|-+|\{\{\s*!\s*\}\}-+|\{\{\s*!-\s*\}\}-*)$/u, syntax, 'tr', attr, config, accum, { Token: 2, SyntaxToken: 0, AttributesToken: 1, TdToken: '2:' });
     }
     /* NOT FOR BROWSER */
     /** @private */
@@ -47,11 +47,19 @@ class TrToken extends trBase_1.TrBaseToken {
         }
         return undefined;
     }
-    /** 获取下一行 */
+    /**
+     * Get the next row
+     *
+     * 获取下一行
+     */
     getNextRow() {
         return this.#getSiblingRow((childNodes, index) => childNodes.slice(index + 1));
     }
-    /** 获取前一行 */
+    /**
+     * Get the previous row
+     *
+     * 获取前一行
+     */
     getPreviousRow() {
         return this.#getSiblingRow((childNodes, index) => childNodes.slice(0, index).reverse());
     }

package/dist/src/table/trBase.d.ts

@@ -11,39 +11,55 @@ export interface TableCoords {
     readonly y?: undefined;
     readonly start?: boolean;
 }
-/** 表格行或表格 */
+/**
+ * table row or table
+ *
+ * 表格行或表格
+ */
 export declare abstract class TrBaseToken extends TableBaseToken {
     #private;
     abstract get type(): 'table' | 'tr';
-    /** 获取行数 */
+    /**
+     * Get the number of rows
+     *
+     * 获取行数
+     */
     getRowCount(): number;
     /**
+     * Get the `n`-th column
+     *
      * 获取第n列
-     * @param n 列号
-     * @param insert 是否用于判断插入新列的位置
+     * @param n column number / 列号
+     * @param insert whether to be used to insert a new column / 是否用于判断插入新列的位置
      * @throws `RangeError` 不存在对应单元格
      */
     getNthCol(n: number, insert?: false): TdToken | undefined;
     getNthCol(n: number, insert: true): TdToken | TrToken | SyntaxToken | undefined;
     /**
      * @override
-     * @param i 移除位置
+     * @param i position of the child node / 移除位置
      */
     removeAt(i: number): AstNodes;
     /**
      * @override
-     * @param token 待插入的子节点
-     * @param i 插入位置
+     * @param token node to be inserted / 待插入的子节点
+     * @param i position to be inserted at / 插入位置
      */
     insertAt<T extends Token>(token: T, i?: number): T;
-    /** 获取列数 */
+    /**
+     * Get the number of columns
+     *
+     * 获取列数
+     */
     getColCount(): number;
     /**
+     * Insert a new cell
+     *
      * 插入新的单元格
-     * @param inner 单元格内部wikitext
-     * @param {TableCoords} coord 单元格坐标
-     * @param subtype 单元格类型
-     * @param attr 单元格属性
+     * @param inner inner wikitext of the cell / 单元格内部wikitext
+     * @param {TableCoords} coord table coordinates of the cell / 单元格坐标
+     * @param subtype cell type / 单元格类型
+     * @param attr cell attribute / 单元格属性
      */
     insertTableCell(inner: string | Token, { column }: TableCoords, subtype?: TdSubtypes, attr?: TdAttrs): TdToken;
 }

package/dist/src/table/trBase.js

@@ -9,7 +9,11 @@ const debug_1 = require("../../util/debug");
 const constants_1 = require("../../util/constants");
 const html_1 = require("../../util/html");
 const index_1 = require("../index");
-/** 表格行或表格 */
+/**
+ * table row or table
+ *
+ * 表格行或表格
+ */
 class TrBaseToken extends base_1.TableBaseToken {
     /** @private */
     lint(start = this.getAbsoluteIndex(), re) {
@@ -39,19 +43,23 @@ class TrBaseToken extends base_1.TableBaseToken {
         errors.push(error);
         return errors;
     }
-    /** 获取行数 */
+    /**
+     * Get the number of rows
+     *
+     * 获取行数
+     */
     getRowCount() {
-        return Number(this.childNodes.some(child => child instanceof td_1.TdToken && child.isIndependent() && !child.firstChild.text().endsWith('+')));
+        return Number(this.childNodes.some(child => child instanceof td_1.TdToken
+            && child.isIndependent()
+            && !child.firstChild.text().endsWith('+')));
     }
     getNthCol(n, insert) {
-        /* NOT FOR BROWSER */
         const nCols = this.getColCount();
         n += n < 0 ? nCols : 0;
         /* istanbul ignore if */
         if (n < 0 || n > nCols || n === nCols && !insert) {
             throw new RangeError(`There is no cell at position ${n}!`);
         }
-        /* NOT FOR BROWSER END */
         let last = 0;
         for (const child of this.childNodes.slice(2)) {
             if (child instanceof td_1.TdToken) {
@@ -62,16 +70,13 @@ class TrBaseToken extends base_1.TableBaseToken {
                 if (n < 0) {
                     return child;
                 }
-                /* NOT FOR BROWSER */
             }
             else if (child.is('tr') || child.is('table-syntax')) {
                 return child;
-                /* NOT FOR BROWSER END */
             }
         }
         return undefined;
     }
-    /* NOT FOR BROWSER */
     /** 修复简单的表格语法错误 */
     #correct() {
         const { childNodes: [, , child] } = this;
@@ -97,7 +102,7 @@ class TrBaseToken extends base_1.TableBaseToken {
     }
     /**
      * @override
-     * @param i 移除位置
+     * @param i position of the child node / 移除位置
      */
     removeAt(i) {
         i += i < 0 ? this.length : 0;
@@ -112,8 +117,8 @@ class TrBaseToken extends base_1.TableBaseToken {
     }
     /**
      * @override
-     * @param token 待插入的子节点
-     * @param i 插入位置
+     * @param token node to be inserted / 待插入的子节点
+     * @param i position to be inserted at / 插入位置
      */
     insertAt(token, i = this.length) {
         if (!debug_1.Shadow.running && token.type !== 'td') {
@@ -132,7 +137,11 @@ class TrBaseToken extends base_1.TableBaseToken {
         }
         return super.insertAt(token, i);
     }
-    /** 获取列数 */
+    /**
+     * Get the number of columns
+     *
+     * 获取列数
+     */
     getColCount() {
         let count = 0, last = 0;
         for (const child of this.childNodes) {
@@ -144,15 +153,16 @@ class TrBaseToken extends base_1.TableBaseToken {
         return count;
     }
     /**
+     * Insert a new cell
+     *
      * 插入新的单元格
-     * @param inner 单元格内部wikitext
-     * @param {TableCoords} coord 单元格坐标
-     * @param subtype 单元格类型
-     * @param attr 单元格属性
+     * @param inner inner wikitext of the cell / 单元格内部wikitext
+     * @param {TableCoords} coord table coordinates of the cell / 单元格坐标
+     * @param subtype cell type / 单元格类型
+     * @param attr cell attribute / 单元格属性
      */
     insertTableCell(inner, { column }, subtype = 'td', attr = {}) {
-        const token = (0, td_1.createTd)(inner, subtype, attr, this.getAttribute('include'), this.getAttribute('config'));
-        return this.insertBefore(token, this.getNthCol(column, true));
+        return this.insertBefore((0, td_1.createTd)(inner, subtype, attr, this.getAttribute('include'), this.getAttribute('config')), this.getNthCol(column, true));
     }
     /** @private */
     toHtmlInternal(opt) {

package/dist/src/tagPair/ext.d.ts

@@ -7,6 +7,8 @@ import type { AttributesParentBase } from '../../mixin/attributesParent';
 export interface ExtToken extends AttributesParentBase {
 }
 /**
+ * extension tag
+ *
  * 扩展标签
  * @classdesc `{childNodes: [AttributesToken, Token]}`
  */
@@ -20,10 +22,10 @@ export declare abstract class ExtToken extends TagPairToken {
     get type(): 'ext';
     /**
      * @param name 标签名
-     * @param include 是否嵌入
      * @param attr 标签属性
      * @param inner 内部wikitext
      * @param closed 是否封闭
+     * @param include 是否嵌入
      */
     constructor(name: string, attr?: string, inner?: string, closed?: string, config?: Parser.Config, include?: boolean, accum?: Token[]);
     cloneNode(): this;

package/dist/src/tagPair/ext.js

@@ -52,7 +52,6 @@ const index_5 = require("../nowiki/index");
 const debug_1 = require("../../util/debug");
 const constants_1 = require("../../util/constants");
 const string_1 = require("../../util/string");
-const html_1 = require("../../util/html");
 /**
  * 从数组中删除指定元素
  * @param arr 数组
@@ -64,6 +63,8 @@ const del = (arr, ele) => {
     return [...set];
 };
 /**
+ * extension tag
+ *
  * 扩展标签
  * @classdesc `{childNodes: [AttributesToken, Token]}`
  */
@@ -88,10 +89,10 @@ let ExtToken = (() => {
         }
         /**
          * @param name 标签名
-         * @param include 是否嵌入
          * @param attr 标签属性
          * @param inner 内部wikitext
          * @param closed 是否封闭
+         * @param include 是否嵌入
          */
         constructor(name, attr, inner, closed, config = index_1.default.getConfig(), include = false, accum = []) {
             const lcName = name.toLowerCase(), 
@@ -200,13 +201,14 @@ let ExtToken = (() => {
             const { name, firstChild, lastChild } = this;
             switch (name) {
                 case 'nowiki':
-                    return (0, html_1.font)(this, (0, string_1.newline)(lastChild.toHtmlInternal()));
+                    return (0, string_1.newline)(lastChild.toHtmlInternal());
                 case 'pre':
-                    return (0, html_1.font)(this, `<pre${firstChild.toHtmlInternal()}>${(0, string_1.newline)(lastChild.toHtmlInternal({ ...opt, nowrap: false }))}</pre>`);
+                    return `<pre${firstChild.toHtmlInternal()}>${(0, string_1.newline)(lastChild.toHtmlInternal({ ...opt, nowrap: false }))}</pre>`;
                 case 'poem':
                     firstChild.classList.add('poem');
-                    return (0, html_1.font)(this, `<div${firstChild.toHtmlInternal()}>${lastChild.toHtmlInternal({ ...opt, nowrap: false }).replace(/(?<!^|<hr>)\n(?!$)/gu, '<br>\n')
-                        .replace(/^ +/gmu, p => '&nbsp;'.repeat(p.length))}</div>`);
+                    return `<div${firstChild.toHtmlInternal()}>${lastChild.toHtmlInternal({ ...opt, nowrap: false })
+                        .replace(/(?<!^|<hr>)\n(?!$)/gu, '<br>\n')
+                        .replace(/^ +/gmu, p => '&nbsp;'.repeat(p.length))}</div>`;
                 case 'gallery': {
                     const caption = firstChild.getAttrToken('caption'), perrow = parseInt(String(firstChild.getAttr('perrow'))), mode = firstChild.getAttr('mode'), nolines = typeof mode === 'string' && mode.toLowerCase() === 'nolines', padding = nolines ? 9 : 43;
                     firstChild.classList.add('gallery');
@@ -217,9 +219,9 @@ let ExtToken = (() => {
                         const style = firstChild.getAttr('style');
                         firstChild.setAttr('style', `max-width: ${(lastChild.widths + padding) * perrow}px;${typeof style === 'string' ? style : ''}`);
                     }
-                    return (0, html_1.font)(this, `<ul${firstChild.toHtmlInternal()}>\n${caption
+                    return `<ul${firstChild.toHtmlInternal()}>\n${caption
                         ? `\t<li class="gallerycaption">${caption.lastChild.toHtmlInternal({ nowrap: true })}</li>\n`
-                        : ''}${lastChild.toHtmlInternal()}\n</ul>`);
+                        : ''}${lastChild.toHtmlInternal()}\n</ul>`;
                 }
                 default:
                     return '';

package/dist/src/tagPair/include.d.ts

@@ -2,6 +2,8 @@ import { TagPairToken } from './index';
 import type { LintError, Config } from '../../base';
 import type { AstText, Token } from '../../internal';
 /**
+ * `<includeonly>`, `<noinclude>` or `<onlyinclude>`
+ *
  * `<includeonly>`或`<noinclude>`或`<onlyinclude>`
  * @classdesc `{childNodes: [AstText, AstText]}`
  */
@@ -25,9 +27,13 @@ export declare abstract class IncludeToken extends TagPairToken {
     cloneNode(): this;
     /**
      * @override
-     * @param str 新文本
+     * @param str new text / 新文本
      */
     setText(str: string): string;
-    /** 清除标签属性 */
+    /**
+     * Remove tag attributes
+     *
+     * 清除标签属性
+     */
     removeAttr(): void;
 }

package/dist/src/tagPair/include.js

@@ -45,6 +45,8 @@ const debug_1 = require("../../util/debug");
 const constants_1 = require("../../util/constants");
 /* NOT FOR BROWSER END */
 /**
+ * `<includeonly>`, `<noinclude>` or `<onlyinclude>`
+ *
  * `<includeonly>`或`<noinclude>`或`<onlyinclude>`
  * @classdesc `{childNodes: [AstText, AstText]}`
  */
@@ -117,12 +119,16 @@ let IncludeToken = (() => {
         }
         /**
          * @override
-         * @param str 新文本
+         * @param str new text / 新文本
          */
         setText(str) {
             return super.setText(str, 1);
         }
-        /** 清除标签属性 */
+        /**
+         * Remove tag attributes
+         *
+         * 清除标签属性
+         */
         removeAttr() {
             super.setText('');
         }

package/dist/src/tagPair/index.d.ts

@@ -1,7 +1,11 @@
 import { Token } from '../index';
 import type { Config } from '../../base';
 import type { AstNodes } from '../../lib/node';
-/** 成对标签 */
+/**
+ * Paired tags
+ *
+ * 成对标签
+ */
 export declare abstract class TagPairToken extends Token {
     #private;
     readonly name: string;
@@ -11,7 +15,7 @@ export declare abstract class TagPairToken extends Token {
     readonly childNodes: readonly [AstNodes, AstNodes];
     abstract get firstChild(): AstNodes;
     abstract get lastChild(): AstNodes;
-    /** 内部wikitext */
+    /** inner wikitext / 内部wikitext */
     get innerText(): string | undefined;
     /**
      * @param name 标签名

package/dist/src/tagPair/index.js

@@ -41,7 +41,11 @@ const constants_1 = require("../../util/constants");
 const fixed_1 = require("../../mixin/fixed");
 const index_2 = require("../../index");
 /* NOT FOR BROWSER END */
-/** 成对标签 */
+/**
+ * Paired tags
+ *
+ * 成对标签
+ */
 let TagPairToken = (() => {
     let _classDecorators = [fixed_1.fixedToken];
     let _classDescriptor;
@@ -61,7 +65,7 @@ let TagPairToken = (() => {
         closed;
         selfClosing;
         /* NOT FOR BROWSER END */
-        /** 内部wikitext */
+        /** inner wikitext / 内部wikitext */
         get innerText() {
             return this.selfClosing ? undefined : this.lastChild.text();
         }

package/dist/src/transclude.d.ts

@@ -6,8 +6,10 @@ import { SyntaxToken } from './syntax';
 import type { LintError } from '../base';
 declare type Child = AtomToken | SyntaxToken;
 /**
+ * template or magic word
+ *
  * 模板或魔术字
- * @classdesc `{childNodes: [AtomToken|SyntaxToken, ...AtomToken, ...ParameterToken]}`
+ * @classdesc `{childNodes: [AtomToken|SyntaxToken, ...AtomToken[], ...ParameterToken[]]}`
  */
 export declare abstract class TranscludeToken extends Token {
     #private;
@@ -20,7 +22,7 @@ export declare abstract class TranscludeToken extends Token {
     abstract get firstElementChild(): Child;
     abstract get lastElementChild(): Child | ParameterToken;
     get type(): 'template' | 'magic-word';
-    /** 是否存在重复参数 */
+    /** whether to contain duplicated parameters / 是否存在重复参数 */
     get duplication(): boolean;
     set duplication(duplication: boolean);
     /**
@@ -30,134 +32,201 @@ export declare abstract class TranscludeToken extends Token {
      */
     constructor(title: string, parts: ([string] | [string | number, string])[], config?: Parser.Config, accum?: Token[]);
     /**
+     * Set the transclusion modifier
+     *
      * 设置引用修饰符
-     * @param modifier 引用修饰符
+     * @param modifier transclusion modifier / 引用修饰符
      */
     setModifier(modifier: string): boolean;
-    /** 是否是模板或模块 */
+    /**
+     * Check if it is a template or a module
+     *
+     * 是否是模板或模块
+     */
     isTemplate(): boolean;
     /**
+     * Get the module name and module function name
+     *
      * 获取模块名和模块函数名
      * @throws `Error` 仅用于模块
      */
     getModule(): [string, string | undefined];
     /**
      * @override
-     * @param token 待插入的子节点
-     * @param i 插入位置
+     * @param token node to be inserted / 待插入的子节点
+     * @param i position to be inserted at / 插入位置
      */
     insertAt<T extends ParameterToken>(token: T, i?: number): T;
-    /** 获取所有参数 */
+    /**
+     * Get all parameters
+     *
+     * 获取所有参数
+     */
     getAllArgs(): ParameterToken[];
-    /** 获取所有匿名参数 */
+    /**
+     * Get all anonymous parameters
+     *
+     * 获取所有匿名参数
+     */
     getAnonArgs(): ParameterToken[];
     /**
+     * Get parameters with the specified name
+     *
      * 获取指定参数
-     * @param key 参数名
-     * @param exact 是否匹配匿名性
-     * @param copy 是否返回一个备份
+     * @param key parameter name / 参数名
+     * @param exact whether to match anonymosity / 是否匹配匿名性
+     * @param copy whether to return a copy / 是否返回一个备份
      */
     getArgs(key: string | number, exact?: boolean, copy?: boolean): Set<ParameterToken>;
     /**
+     * Get duplicated parameters
+     *
      * 获取重名参数
      * @throws `Error` 仅用于模板
      */
     getDuplicatedArgs(): [string, ParameterToken[]][];
     /**
+     * Get possible values of some magic words
+     *
      * 对特定魔术字获取可能的取值
      * @throws `Error` 不是可接受的魔术字
      */
     getPossibleValues(): Token[];
     cloneNode(): this;
-    /** 替换引用 */
+    /**
+     * Convert to substitution
+     *
+     * 替换引用
+     */
     subst(): void;
-    /** 安全的替换引用 */
+    /**
+     * Convert to safe substitution
+     *
+     * 安全的替换引用
+     */
     safesubst(): void;
     /**
      * @override
-     * @param i 移除位置
+     * @param i position of the child node / 移除位置
      */
     removeAt(i: number): ParameterToken;
     /**
+     * Check if there is a parameter with the specified name
+     *
      * 是否具有某参数
-     * @param key 参数名
-     * @param exact 是否匹配匿名性
+     * @param key parameter name / 参数名
+     * @param exact whether to match anonymosity / 是否匹配匿名性
      */
     hasArg(key: string | number, exact?: boolean): boolean;
     /**
+     * Get the effective parameter with the specified name
+     *
      * 获取生效的指定参数
-     * @param key 参数名
-     * @param exact 是否匹配匿名性
+     * @param key parameter name / 参数名
+     * @param exact whether to match anonymosity / 是否匹配匿名性
      */
     getArg(key: string | number, exact?: boolean): ParameterToken | undefined;
     /**
+     * Remove parameters with the specified name
+     *
      * 移除指定参数
-     * @param key 参数名
-     * @param exact 是否匹配匿名性
+     * @param key parameter name / 参数名
+     * @param exact whether to match anonymosity / 是否匹配匿名性
      */
     removeArg(key: string | number, exact?: boolean): void;
-    /** 获取所有参数名 */
+    /**
+     * Get all parameter names
+     *
+     * 获取所有参数名
+     */
     getKeys(): string[];
     /**
+     * Get parameter values
+     *
      * 获取参数值
-     * @param key 参数名
+     * @param key parameter name / 参数名
      */
     getValues(key: string | number): string[];
     /**
+     * Get the effective parameter value
+     *
      * 获取生效的参数值
-     * @param key 参数名
+     * @param key parameter name / 参数名
      */
     getValue(): Record<string, string>;
     getValue(key: string | number): string | undefined;
     /**
+     * Insert an anonymous parameter
+     *
      * 插入匿名参数
-     * @param val 参数值
+     * @param val parameter value / 参数值
      */
     newAnonArg(val: string): ParameterToken;
     /**
+     * Set the parameter value
+     *
      * 设置参数值
-     * @param key 参数名
-     * @param value 参数值
+     * @param key parameter name / 参数名
+     * @param value parameter value / 参数值
      * @throws `Error` 仅用于模板
      */
     setValue(key: string, value: string): void;
     /**
+     * Convert all anonymous parameters to named ones
+     *
      * 将匿名参数改写为命名参数
      * @throws `Error` 仅用于模板
      */
     anonToNamed(): void;
     /**
+     * Replace the template name
+     *
      * 替换模板名
-     * @param title 模板名
+     * @param title template name / 模板名
      * @throws `Error` 仅用于模板
      */
     replaceTemplate(title: string): void;
     /**
+     * Replace the module name
+     *
      * 替换模块名
-     * @param title 模块名
+     * @param title module name / 模块名
      * @throws `Error` 仅用于模块
      */
     replaceModule(title: string): void;
     /**
+     * Replace the module function
+     *
      * 替换模块函数
-     * @param func 模块函数名
+     * @param func module function name / 模块函数名
      * @throws `Error` 仅用于模块
      * @throws `Error` 尚未指定模块名称
      */
     replaceFunction(func: string): void;
     /**
+     * Count duplicated parameters
+     *
      * 重复参数计数
      * @throws `Error` 仅用于模板
      */
     hasDuplicatedArgs(): number;
     /**
-     * 修复重名参数：
-     * `aggressive = false`时只移除空参数和全同参数，优先保留匿名参数，否则将所有匿名参数更改为命名。
-     * `aggressive = true`时还会尝试处理连续的以数字编号的参数。
-     * @param aggressive 是否使用有更大风险的修复手段
+     * Fix duplicated parameters
+     * @description
+     * - Only empty parameters and identical parameters are removed with `aggressive = false`.
+     * Anonymous parameters have a higher precedence, otherwise all anonymous parameters are converted to named ones.
+     * - Additionally, consecutive numbered parameters are treated with `aggressive = true`.
+     *
+     * 修复重名参数
+     * @description
+     * - `aggressive = false`时只移除空参数和全同参数，优先保留匿名参数，否则将所有匿名参数更改为命名。
+     * - `aggressive = true`时还会尝试处理连续的以数字编号的参数。
+     * @param aggressive whether to use a more risky approach / 是否使用有更大风险的修复手段
      */
     fixDuplication(aggressive?: boolean): string[];
     /**
+     * Escape tables inside the template
+     *
      * 转义模板内的表格
      * @throws `Error` 转义失败
      */