wikiparser-node 1.4.1-b → 1.4.1

package/dist/src/tagPair/ext.js

@@ -0,0 +1,151 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtToken = void 0;
+const lint_1 = require("../../util/lint");
+const debug_1 = require("../../util/debug");
+const constants_1 = require("../../util/constants");
+const attributesParent_1 = require("../../mixin/attributesParent");
+const Parser = require("../../index");
+const index_1 = require("../index");
+const index_2 = require("./index");
+const attributes_1 = require("../attributes");
+/**
+ * 从数组中删除指定元素
+ * @param arr 数组
+ * @param ele 元素
+ */
+const del = (arr, ele) => {
+    const set = new Set(arr);
+    set.delete(ele);
+    return [...set];
+};
+/**
+ * 扩展标签
+ * @classdesc `{childNodes: [AttributesToken, Token]}`
+ */
+class ExtToken extends (0, attributesParent_1.attributesParent)(index_2.TagPairToken) {
+    type = 'ext';
+    /**
+     * @param name 标签名
+     * @param attr 标签属性
+     * @param inner 内部wikitext
+     * @param closed 是否封闭
+     */
+    constructor(name, attr, inner, closed, config = Parser.getConfig(), accum = []) {
+        const lcName = name.toLowerCase(), 
+        // @ts-expect-error abstract class
+        attrToken = new attributes_1.AttributesToken(!attr || attr.trimStart() !== attr ? attr : ` ${attr}`, 'ext-attrs', lcName, config, accum), newConfig = { ...config, ext: del(config.ext, lcName), excludes: [...config.excludes ?? []] };
+        let innerToken;
+        switch (lcName) {
+            case 'tab':
+                newConfig.ext = del(newConfig.ext, 'tabs');
+            // fall through
+            case 'indicator':
+            case 'poem':
+            case 'ref':
+            case 'option':
+            case 'combooption':
+            case 'tabs':
+            case 'poll':
+            case 'seo':
+                if (lcName === 'poem') {
+                    newConfig.excludes.push('heading');
+                }
+                innerToken = new index_1.Token(inner, newConfig, accum);
+                break;
+            case 'pre': {
+                const { PreToken } = require('../pre');
+                // @ts-expect-error abstract class
+                innerToken = new PreToken(inner, newConfig, accum);
+                break;
+            }
+            case 'dynamicpagelist': {
+                const { ParamTagToken } = require('../paramTag/index');
+                // @ts-expect-error abstract class
+                innerToken = new ParamTagToken(inner, newConfig, accum);
+                break;
+            }
+            case 'inputbox': {
+                newConfig.excludes.push('heading');
+                const { InputboxToken } = require('../paramTag/inputbox');
+                // @ts-expect-error abstract class
+                innerToken = new InputboxToken(inner, newConfig, accum);
+                break;
+            }
+            case 'references': {
+                const { NestedToken } = require('../nested');
+                // @ts-expect-error abstract class
+                innerToken = new NestedToken(inner, /<!--.*?(?:-->|$)|<(ref)(\s[^>]*)?>(.*?)<\/(ref\s*)>/gisu, ['ref'], newConfig, accum);
+                break;
+            }
+            case 'choose': {
+                const { NestedToken } = require('../nested');
+                // @ts-expect-error abstract class
+                innerToken = new NestedToken(inner, /<(option|choicetemplate)(\s[^>]*)?>(.*?)<\/(\1)>/gsu, ['option', 'choicetemplate'], newConfig, accum);
+                break;
+            }
+            case 'combobox': {
+                const { NestedToken } = require('../nested');
+                // @ts-expect-error abstract class
+                innerToken = new NestedToken(inner, /<(combooption)(\s[^>]*)?>(.*?)<\/(combooption\s*)>/gisu, ['combooption'], newConfig, accum);
+                break;
+            }
+            case 'gallery': {
+                const { GalleryToken } = require('../gallery');
+                // @ts-expect-error abstract class
+                innerToken = new GalleryToken(inner, newConfig, accum);
+                break;
+            }
+            case 'imagemap': {
+                const { ImagemapToken } = require('../imagemap');
+                // @ts-expect-error abstract class
+                innerToken = new ImagemapToken(inner, newConfig, accum);
+                break;
+            }
+            // 更多定制扩展的代码示例：
+            // ```
+            // case 'extensionName': {
+            //	const {ExtensionToken}: typeof import('../extension') = require('../extension');
+            //	innerToken = new ExtensionToken(inner, newConfig, accum);
+            //	break;
+            // }
+            // ```
+            default: {
+                const { NowikiToken } = require('../nowiki/index');
+                // @ts-expect-error abstract class
+                innerToken = new NowikiToken(inner, newConfig);
+            }
+        }
+        innerToken.setAttribute('name', lcName);
+        innerToken.type = 'ext-inner';
+        super(name, attrToken, innerToken, closed, config, accum);
+        this.seal('closed', true);
+    }
+    /** @override */
+    lint(start = this.getAbsoluteIndex()) {
+        const errors = super.lint(start);
+        let rect;
+        if (this.name !== 'nowiki' && this.closest('html-attrs, table-attrs')) {
+            rect = { start, ...this.getRootNode().posFromIndex(start) };
+            errors.push((0, lint_1.generateForSelf)(this, rect, 'extension tag in HTML tag attributes'));
+        }
+        if (this.name === 'ref' && this.closest('heading-title')) {
+            rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+            errors.push((0, lint_1.generateForSelf)(this, rect, 'variable anchor in a section header'));
+        }
+        return errors;
+    }
+    /* NOT FOR BROWSER */
+    /** @override */
+    cloneNode() {
+        const inner = this.lastChild.cloneNode(), tags = this.getAttribute('tags'), config = this.getAttribute('config'), attr = String(this.firstChild);
+        return debug_1.Shadow.run(() => {
+            // @ts-expect-error abstract class
+            const token = new ExtToken(tags[0], attr, '', this.selfClosing ? undefined : tags[1], config);
+            token.lastChild.safeReplaceWith(inner);
+            return token;
+        });
+    }
+}
+exports.ExtToken = ExtToken;
+constants_1.classes['ExtToken'] = __filename;

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

@@ -0,0 +1,37 @@
+import * as Parser from '../../index';
+import { TagPairToken } from './index';
+import type { LintError } from '../../base';
+import type { AstText, Token } from '../../internal';
+export declare abstract class IncludeToken extends TagPairToken {
+    readonly type = "include";
+    readonly childNodes: readonly [AstText, AstText];
+    abstract get children(): [];
+    abstract get firstChild(): AstText;
+    abstract get firstElementChild(): undefined;
+    abstract get lastChild(): AstText;
+    abstract get lastElementChild(): undefined;
+    /**	@override */
+    get innerText(): string | undefined;
+    set innerText(text: string | undefined);
+    /**
+     * @param name 标签名
+     * @param attr 标签属性
+     * @param inner 内部wikitext
+     * @param closed 是否封闭
+     */
+    constructor(name: string, attr?: string, inner?: string, closed?: string, config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    lint(start?: number): LintError[];
+    /** @override */
+    json(): object;
+    /** @override */
+    cloneNode(): this;
+    /**
+     * @override
+     * @param str 新文本
+     */
+    setText(str: string): string;
+    /** 清除标签属性 */
+    removeAttr(): void;
+}
+export {};

package/dist/src/tagPair/include.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IncludeToken = void 0;
+const debug_1 = require("../../util/debug");
+const constants_1 = require("../../util/constants");
+const lint_1 = require("../../util/lint");
+const hidden_1 = require("../../mixin/hidden");
+const Parser = require("../../index");
+const index_1 = require("./index");
+/**
+ * `<includeonly>`或`<noinclude>`或`<onlyinclude>`
+ * @classdesc `{childNodes: [AstText, AstText]}`
+ */
+class IncludeToken extends (0, hidden_1.hiddenToken)(index_1.TagPairToken) {
+    type = 'include';
+    /* NOT FOR BROWSER */
+    /**	@override */
+    get innerText() {
+        return this.selfClosing ? undefined : this.lastChild.data;
+    }
+    set innerText(text) {
+        if (text === undefined) {
+            this.selfClosing = true;
+        }
+        else {
+            this.selfClosing = false;
+            this.setText(text);
+        }
+    }
+    /* NOT FOR BROWSER END */
+    /**
+     * @param name 标签名
+     * @param attr 标签属性
+     * @param inner 内部wikitext
+     * @param closed 是否封闭
+     */
+    constructor(name, attr = '', inner, closed, config = Parser.getConfig(), accum = []) {
+        super(name, attr, inner ?? '', inner === undefined ? closed : closed ?? '', config, accum);
+    }
+    /** @override */
+    lint(start = this.getAbsoluteIndex()) {
+        return this.closed ? [] : [(0, lint_1.generateForSelf)(this, { start }, Parser.msg('unclosed $1', `<${this.name}>`))];
+    }
+    /** @override */
+    json() {
+        return {
+            ...super.json(),
+            closed: this.closed,
+        };
+    }
+    /* NOT FOR BROWSER */
+    /** @override */
+    cloneNode() {
+        const tags = this.getAttribute('tags'), config = this.getAttribute('config'), { innerText } = this, closing = this.selfClosing || !this.closed ? undefined : tags[1];
+        // @ts-expect-error abstract class
+        return debug_1.Shadow.run(() => new IncludeToken(tags[0], this.firstChild.data, innerText, closing, config));
+    }
+    /**
+     * @override
+     * @param str 新文本
+     */
+    setText(str) {
+        return super.setText(str, 1);
+    }
+    /** 清除标签属性 */
+    removeAttr() {
+        super.setText('');
+    }
+}
+exports.IncludeToken = IncludeToken;
+constants_1.classes['IncludeToken'] = __filename;

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

@@ -0,0 +1,27 @@
+import * as Parser from '../../index';
+import { Token } from '../index';
+import type { AstNodes } from '../../lib/node';
+export declare abstract class TagPairToken extends Token {
+    #private;
+    type: 'ext' | 'include';
+    readonly name: string;
+    closed: boolean;
+    selfClosing: boolean;
+    readonly childNodes: readonly [AstNodes, AstNodes];
+    abstract get firstChild(): AstNodes;
+    abstract get lastChild(): AstNodes;
+    /** 内部wikitext */
+    get innerText(): string | undefined;
+    /**
+     * @param name 标签名
+     * @param attr 标签属性
+     * @param inner 内部wikitext
+     * @param closed 是否封闭；约定`undefined`表示自封闭，`''`表示未闭合
+     */
+    constructor(name: string, attr: string | Token, inner: string | Token, closed?: string, config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    text(): string;
+    /** @override */
+    print(): string;
+}
+export {};

package/dist/src/tagPair/index.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TagPairToken = void 0;
+const constants_1 = require("../../util/constants");
+const fixed_1 = require("../../mixin/fixed");
+const Parser = require("../../index");
+const index_1 = require("../index");
+/** 成对标签 */
+class TagPairToken extends (0, fixed_1.fixedToken)(index_1.Token) {
+    #tags;
+    closed;
+    selfClosing;
+    /* NOT FOR BROWSER END */
+    /** 内部wikitext */
+    get innerText() {
+        return this.selfClosing ? undefined : this.lastChild.text();
+    }
+    /**
+     * @param name 标签名
+     * @param attr 标签属性
+     * @param inner 内部wikitext
+     * @param closed 是否封闭；约定`undefined`表示自封闭，`''`表示未闭合
+     */
+    constructor(name, attr, inner, closed, config = Parser.getConfig(), accum = []) {
+        super(undefined, config);
+        this.setAttribute('name', name.toLowerCase());
+        this.#tags = [name, closed || name];
+        this.closed = closed !== '';
+        this.selfClosing = closed === undefined;
+        this.append(attr, inner);
+        const index = typeof attr === 'string' ? -1 : accum.indexOf(attr);
+        accum.splice(index === -1 ? Infinity : index, 0, this);
+        Object.defineProperty(this, 'closed', { enumerable: false });
+    }
+    /** @private */
+    toString(omit) {
+        const { selfClosing, firstChild, lastChild, nextSibling, name, closed, } = this, [opening, closing] = this.#tags;
+        if (omit && this.matchesTypes(omit)) {
+            return '';
+        }
+        else if (!closed && nextSibling) {
+            Parser.error(`自动闭合 <${name}>`, lastChild);
+            this.closed = true;
+        }
+        return selfClosing
+            ? `<${opening}${firstChild.toString(omit)}/>`
+            : `<${opening}${firstChild.toString(omit)}>${lastChild.toString(omit)}${this.closed ? `</${closing}>` : ''}`;
+    }
+    /** @override */
+    text() {
+        const [opening, closing] = this.#tags;
+        return this.selfClosing
+            ? `<${opening}${this.firstChild.text()}/>`
+            : `<${opening}${super.text('>')}${this.closed ? `</${closing}>` : ''}`;
+    }
+    /** @private */
+    getAttribute(key) {
+        if (key === 'tags') {
+            return [...this.#tags];
+        }
+        return key === 'padding' ? this.#tags[0].length + 1 : super.getAttribute(key);
+    }
+    /** @private */
+    getGaps() {
+        return 1;
+    }
+    /** @override */
+    print() {
+        const [opening, closing] = this.#tags;
+        return super.print(this.selfClosing
+            ? { pre: `&lt;${opening}`, post: '/&gt;' }
+            : { pre: `&lt;${opening}`, sep: '&gt;', post: this.closed ? `&lt;/${closing}&gt;` : '' });
+    }
+}
+exports.TagPairToken = TagPairToken;
+constants_1.classes['TagPairToken'] = __filename;

package/dist/src/transclude.d.ts

@@ -0,0 +1,167 @@
+import * as Parser from '../index';
+import { Token } from './index';
+import { ParameterToken } from './parameter';
+import { AtomToken } from './atom';
+import { SyntaxToken } from './syntax';
+import type { LintError } from '../base';
+/**
+ * 模板或魔术字
+ * @classdesc `{childNodes: [AtomToken|SyntaxToken, ...AtomToken, ...ParameterToken]}`
+ */
+export declare abstract class TranscludeToken extends Token {
+    #private;
+    type: 'template' | 'magic-word';
+    readonly name: string;
+    readonly modifier: string;
+    readonly childNodes: readonly [AtomToken | SyntaxToken, ...ParameterToken[]] | readonly [SyntaxToken, AtomToken, AtomToken, ...ParameterToken[]];
+    abstract get children(): [AtomToken | SyntaxToken, ...ParameterToken[]] | [SyntaxToken, AtomToken, AtomToken, ...ParameterToken[]];
+    abstract get firstChild(): AtomToken | SyntaxToken;
+    abstract get firstElementChild(): AtomToken | SyntaxToken;
+    abstract get lastChild(): AtomToken | SyntaxToken | ParameterToken;
+    abstract get lastElementChild(): AtomToken | SyntaxToken | ParameterToken;
+    /** 是否存在重复参数 */
+    get duplication(): boolean;
+    set duplication(duplication: boolean);
+    /**
+     * @param title 模板标题或魔术字
+     * @param parts 参数各部分
+     * @throws `SyntaxError` 非法的模板名称
+     */
+    constructor(title: string, parts: ([string] | [string | number, string])[], config?: Parser.Config, accum?: Token[]);
+    /**
+     * 设置引用修饰符
+     * @param modifier 引用修饰符
+     */
+    setModifier(modifier: string): boolean;
+    /** 是否是模板或模块 */
+    isTemplate(): boolean;
+    /** @override */
+    text(): string;
+    /** @override */
+    lint(start?: number): LintError[];
+    /**
+     * @override
+     * @param token 待插入的子节点
+     * @param i 插入位置
+     */
+    insertAt<T extends ParameterToken>(token: T, i?: number): T;
+    /** 获取所有参数 */
+    getAllArgs(): ParameterToken[];
+    /** 获取所有匿名参数 */
+    getAnonArgs(): ParameterToken[];
+    /**
+     * 获取指定参数
+     * @param key 参数名
+     * @param exact 是否匹配匿名性
+     * @param copy 是否返回一个备份
+     */
+    getArgs(key: string | number, exact?: boolean, copy?: boolean): Set<ParameterToken>;
+    /**
+     * 获取重名参数
+     * @throws `Error` 仅用于模板
+     */
+    getDuplicatedArgs(): [string, ParameterToken[]][];
+    /**
+     * 对特定魔术字获取可能的取值
+     * @throws `Error` 不是可接受的魔术字
+     */
+    getPossibleValues(): Token[];
+    /** @override */
+    print(): string;
+    /** @override */
+    cloneNode(): this;
+    /** 替换引用 */
+    subst(): void;
+    /** 安全的替换引用 */
+    safesubst(): void;
+    /**
+     * @override
+     * @param i 移除位置
+     */
+    removeAt(i: number): ParameterToken;
+    /**
+     * 是否具有某参数
+     * @param key 参数名
+     * @param exact 是否匹配匿名性
+     */
+    hasArg(key: string | number, exact?: boolean): boolean;
+    /**
+     * 获取生效的指定参数
+     * @param key 参数名
+     * @param exact 是否匹配匿名性
+     */
+    getArg(key: string | number, exact?: boolean): ParameterToken | undefined;
+    /**
+     * 移除指定参数
+     * @param key 参数名
+     * @param exact 是否匹配匿名性
+     */
+    removeArg(key: string | number, exact?: boolean): void;
+    /** 获取所有参数名 */
+    getKeys(): string[];
+    /**
+     * 获取参数值
+     * @param key 参数名
+     */
+    getValues(key: string | number): string[];
+    /** 获取所有生效的参数值 */
+    getValue(): Record<string, string>;
+    /**
+     * 获取生效的指定参数值
+     * @param key 参数名
+     */
+    getValue(key: string | number): string | undefined;
+    /**
+     * 插入匿名参数
+     * @param val 参数值
+     */
+    newAnonArg(val: string): ParameterToken;
+    /**
+     * 设置参数值
+     * @param key 参数名
+     * @param value 参数值
+     * @throws `Error` 仅用于模板
+     */
+    setValue(key: string, value: string): void;
+    /**
+     * 将匿名参数改写为命名参数
+     * @throws `Error` 仅用于模板
+     */
+    anonToNamed(): void;
+    /**
+     * 替换模板名
+     * @param title 模板名
+     * @throws `Error` 仅用于模板
+     */
+    replaceTemplate(title: string): void;
+    /**
+     * 替换模块名
+     * @param title 模块名
+     * @throws `Error` 仅用于模块
+     */
+    replaceModule(title: string): void;
+    /**
+     * 替换模块函数
+     * @param func 模块函数名
+     * @throws `Error` 仅用于模块
+     * @throws `Error` 尚未指定模块名称
+     */
+    replaceFunction(func: string): void;
+    /**
+     * 重复参数计数
+     * @throws `Error` 仅用于模板
+     */
+    hasDuplicatedArgs(): number;
+    /**
+     * 修复重名参数：
+     * `aggressive = false`时只移除空参数和全同参数，优先保留匿名参数，否则将所有匿名参数更改为命名。
+     * `aggressive = true`时还会尝试处理连续的以数字编号的参数。
+     * @param aggressive 是否使用有更大风险的修复手段
+     */
+    fixDuplication(aggressive?: boolean): string[];
+    /**
+     * 转义模板内的表格
+     * @throws `Error` 转义失败
+     */
+    escapeTables(): TranscludeToken;
+}