wikiparser-node 1.7.0-beta.4 → 1.7.0

package/dist/src/link/redirectTarget.d.ts

@@ -0,0 +1,51 @@
+import Parser from '../../index';
+import { LinkBaseToken } from './base';
+import { NoincludeToken } from '../nowiki/noinclude';
+import type { LintError } from '../../base';
+import type { Title } from '../../lib/title';
+import type { Token, AtomToken } from '../../internal';
+/**
+ * 重定向目标
+ * @classdesc `{childNodes: [AtomToken, ?Token]}`
+ */
+export declare abstract class RedirectTargetToken extends LinkBaseToken {
+    readonly type = "redirect-target";
+    readonly childNodes: readonly [AtomToken] | readonly [AtomToken, NoincludeToken];
+    abstract get lastChild(): AtomToken | NoincludeToken;
+    abstract get children(): [AtomToken] | [AtomToken, NoincludeToken];
+    abstract get lastElementChild(): AtomToken | NoincludeToken;
+    abstract get link(): Title;
+    abstract set link(link: string);
+    /** @override */
+    get fragment(): string | undefined;
+    set fragment(fragment: string | undefined);
+    /** interwiki */
+    get interwiki(): string;
+    /** @throws `RangeError` 非法的跨维基前缀 */
+    set interwiki(interwiki: string);
+    /**
+     * @param link 链接标题
+     * @param linkText 链接显示文字
+     * @param delimiter `|`
+     */
+    constructor(link: string, linkText?: string, config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    text(): string;
+    /** @override */
+    lint(start?: number): LintError[];
+    /**
+     * 设置链接目标
+     * @param link 链接目标
+     */
+    setTarget(link: string): void;
+    /**
+     * 设置fragment
+     * @param fragment fragment
+     */
+    setFragment(fragment?: string): void;
+    /**
+     * 设置链接显示文字
+     * @param linkStr 链接显示文字
+     */
+    setLinkText(linkStr?: string): void;
+}

package/dist/src/link/redirectTarget.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedirectTargetToken = void 0;
+const lint_1 = require("../../util/lint");
+const constants_1 = require("../../util/constants");
+const index_1 = require("../../index");
+const base_1 = require("./base");
+const noinclude_1 = require("../nowiki/noinclude");
+/**
+ * 重定向目标
+ * @classdesc `{childNodes: [AtomToken, ?Token]}`
+ */
+class RedirectTargetToken extends base_1.LinkBaseToken {
+    type = 'redirect-target';
+    /** @override */
+    get fragment() {
+        return super.fragment;
+    }
+    set fragment(fragment) {
+        this.setFragment(fragment);
+    }
+    /** interwiki */
+    get interwiki() {
+        return this.link.interwiki;
+    }
+    /** @throws `RangeError` 非法的跨维基前缀 */
+    set interwiki(interwiki) {
+        const { link: { prefix, main, fragment } } = this, link = `${interwiki}:${prefix}${main}${fragment === undefined ? '' : `#${fragment}`}`;
+        if (interwiki && !this.isInterwiki(link)) {
+            throw new RangeError(`${interwiki} 不是合法的跨维基前缀!`);
+        }
+        this.setTarget(link);
+    }
+    /* NOT FOR BROWSER END */
+    /**
+     * @param link 链接标题
+     * @param linkText 链接显示文字
+     * @param delimiter `|`
+     */
+    constructor(link, linkText, config = index_1.default.getConfig(), accum = []) {
+        super(link, undefined, config, accum);
+        if (linkText !== undefined) {
+            // @ts-expect-error abstract class
+            this.insertAt(new noinclude_1.NoincludeToken(linkText, config, accum));
+        }
+        /* NOT FOR BROWSER */
+        this.setAttribute('acceptable', { AtomToken: 0, NoincludeToken: 1 });
+        // @ts-expect-error abstract getter
+        this.firstChild.setAttribute('acceptable', { AstText: ':' });
+    }
+    /** @private */
+    getTitle() {
+        return this.normalizeTitle(String(this.firstChild), 0, true, true);
+    }
+    /** @override */
+    text() {
+        return `[[${String(this.firstChild)}]]`;
+    }
+    /** @override */
+    lint(start = this.getAbsoluteIndex()) {
+        const errors = super.lint(start, /\]\]/u);
+        if (this.length === 2) {
+            const e = (0, lint_1.generateForChild)(this.lastChild, { start }, 'no-ignored', 'useless link text');
+            e.startIndex--;
+            e.startCol--;
+            e.fix = {
+                range: [e.startIndex, e.endIndex],
+                text: '',
+            };
+            errors.push(e);
+        }
+        return errors;
+    }
+    /* NOT FOR BROWSER */
+    /**
+     * 设置链接目标
+     * @param link 链接目标
+     */
+    setTarget(link) {
+        this.firstChild.setText(link);
+    }
+    /**
+     * 设置fragment
+     * @param fragment fragment
+     */
+    setFragment(fragment) {
+        fragment &&= fragment.replace(/[\]|]/gu, p => encodeURIComponent(p));
+        this.setTarget(`${this.name}${fragment === undefined ? '' : `#${fragment}`}`);
+    }
+    /**
+     * 设置链接显示文字
+     * @param linkStr 链接显示文字
+     */
+    setLinkText(linkStr) {
+        if (!linkStr) {
+            this.childNodes[1]?.remove();
+        }
+    }
+}
+exports.RedirectTargetToken = RedirectTargetToken;
+constants_1.classes['RedirectTargetToken'] = __filename;

package/dist/src/magicLink.d.ts

@@ -0,0 +1,59 @@
+import Parser from '../index';
+import { Token } from './index';
+import type { LintError } from '../base';
+import type { SyntaxBase } from '../mixin/syntax';
+import type { AstText, CommentToken, IncludeToken, NoincludeToken, TranscludeToken, AstNodes } from '../internal';
+/** NOT FOR BROWSER */
+export interface MagicLinkToken extends SyntaxBase {
+}
+/** NOT FOR BROWSER END */
+/**
+ * 自由外链
+ * @classdesc `{childNodes: ...AstText|CommentToken|IncludeToken|NoincludeToken}`
+ */
+export declare abstract class MagicLinkToken extends Token {
+    type: 'free-ext-link' | 'ext-link-url';
+    readonly childNodes: readonly (AstText | CommentToken | IncludeToken | NoincludeToken | TranscludeToken)[];
+    abstract get firstChild(): AstText | TranscludeToken;
+    abstract get lastChild(): AstText | CommentToken | IncludeToken | NoincludeToken | TranscludeToken;
+    abstract get children(): (CommentToken | IncludeToken | NoincludeToken | TranscludeToken)[];
+    abstract get firstElementChild(): CommentToken | IncludeToken | NoincludeToken | TranscludeToken | undefined;
+    abstract get lastElementChild(): CommentToken | IncludeToken | NoincludeToken | TranscludeToken | undefined;
+    /** 协议 */
+    get protocol(): string | undefined;
+    /** @throws `Error` 特殊外链无法更改协议n */
+    set protocol(value: string);
+    /** 和内链保持一致 */
+    get link(): string;
+    set link(url: string);
+    /**
+     * @param url 网址
+     * @param doubleSlash 是否接受"//"作为协议
+     */
+    constructor(url?: string, doubleSlash?: boolean, config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    lint(start?: number, re?: RegExp): LintError[];
+    /** @override */
+    cloneNode(): this;
+    /**
+     * @override
+     * @param token 待插入的节点
+     * @param i 插入位置
+     */
+    insertAt(token: string, i?: number): AstText;
+    insertAt<T extends AstNodes>(token: T, i?: number): T;
+    /**
+     * 获取网址
+     * @throws `Error` 非标准协议
+     */
+    getUrl(): URL;
+    /**
+     * 设置外链目标
+     * @param url 含协议的网址
+     */
+    setTarget(url: string): void;
+    /** 是否是模板或魔术字参数 */
+    isParamValue(): boolean;
+    /** 转义 `=` */
+    escape(): void;
+}

package/dist/src/magicLink.js

@@ -0,0 +1,220 @@
+"use strict";
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MagicLinkToken = void 0;
+const lint_1 = require("../util/lint");
+const debug_1 = require("../util/debug");
+const constants_1 = require("../util/constants");
+const string_1 = require("../util/string");
+const syntax_1 = require("../mixin/syntax");
+const index_1 = require("../index");
+const index_2 = require("./index");
+/** NOT FOR BROWSER END */
+/**
+ * 自由外链
+ * @classdesc `{childNodes: ...AstText|CommentToken|IncludeToken|NoincludeToken}`
+ */
+let MagicLinkToken = (() => {
+    let _classDecorators = [(0, syntax_1.syntax)()];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    let _classSuper = index_2.Token;
+    var MagicLinkToken = class extends _classSuper {
+        static { _classThis = this; }
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+            MagicLinkToken = _classThis = _classDescriptor.value;
+            if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+            __runInitializers(_classThis, _classExtraInitializers);
+        }
+        /** 协议 */
+        get protocol() {
+            return this.pattern.exec(this.text())?.[0];
+        }
+        /** @throws `Error` 特殊外链无法更改协议n */
+        set protocol(value) {
+            const { link, pattern } = this;
+            if (!pattern.test(link)) {
+                throw new Error(`特殊外链无法更改协议：${link}`);
+            }
+            this.setTarget(link.replace(pattern, value));
+        }
+        /** 和内链保持一致 */
+        get link() {
+            const map = { '!': '|', '=': '=' };
+            return (0, string_1.text)(this.childNodes.map(child => {
+                const { type, name } = child;
+                return type === 'magic-word' && name in map ? map[name] : child;
+            }));
+        }
+        set link(url) {
+            this.setTarget(url);
+        }
+        /* NOT FOR BROWSER END */
+        /**
+         * @param url 网址
+         * @param doubleSlash 是否接受"//"作为协议
+         */
+        constructor(url, doubleSlash, config = index_1.default.getConfig(), accum = []) {
+            super(url, config, accum, {
+                'Stage-1': '1:', '!ExtToken': '', AstText: ':', TranscludeToken: ':',
+            });
+            this.type = doubleSlash ? 'ext-link-url' : 'free-ext-link';
+            /* NOT FOR BROWSER */
+            this.setAttribute('pattern', new RegExp(`^(?:${config.protocol}${doubleSlash ? '|//' : ''})`, 'iu'));
+        }
+        /** @override */
+        lint(start = this.getAbsoluteIndex(), re) {
+            const errors = super.lint(start, re), source = `[，；。：！？（）]+${this.type === 'ext-link-url' ? '|\\|+' : ''}`, regex = new RegExp(source, 'u'), regexGlobal = new RegExp(source, 'gu');
+            let rect;
+            for (const child of this.childNodes) {
+                const { type, data } = child;
+                if (type !== 'text' || !regex.test(data)) {
+                    continue;
+                }
+                rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+                const refError = (0, lint_1.generateForChild)(child, rect, 'unterminated-url', '', 'warning');
+                regexGlobal.lastIndex = 0;
+                for (let mt = regexGlobal.exec(data); mt; mt = regexGlobal.exec(data)) {
+                    const { index, 0: s } = mt, lines = data.slice(0, index).split('\n'), top = lines.length, left = lines[top - 1].length, startIndex = refError.startIndex + index, startLine = refError.startLine + top - 1, startCol = top === 1 ? refError.startCol + left : left, pipe = s.startsWith('|');
+                    const e = {
+                        ...refError,
+                        message: index_1.default.msg('$1 in URL', pipe ? '"|"' : 'full-width punctuation'),
+                        startIndex,
+                        endIndex: startIndex + s.length,
+                        startLine,
+                        endLine: startLine,
+                        startCol,
+                        endCol: startCol + s.length,
+                    };
+                    if (!pipe) {
+                        e.suggestions = [
+                            {
+                                desc: 'whitespace',
+                                range: [startIndex, startIndex],
+                                text: ' ',
+                            },
+                            {
+                                desc: 'escape',
+                                range: [startIndex, e.endIndex],
+                                text: encodeURI(s),
+                            },
+                        ];
+                    }
+                    else if (s.length === 1) {
+                        e.suggestions = [
+                            {
+                                desc: 'whitespace',
+                                range: [startIndex, startIndex + 1],
+                                text: ' ',
+                            },
+                        ];
+                    }
+                    errors.push(e);
+                }
+            }
+            return errors;
+        }
+        /* NOT FOR BROWSER */
+        /** @override */
+        cloneNode() {
+            const cloned = this.cloneChildNodes();
+            return debug_1.Shadow.run(() => {
+                // @ts-expect-error abstract class
+                const token = new MagicLinkToken(undefined, this.type === 'ext-link-url', this.getAttribute('config'));
+                token.append(...cloned);
+                token.afterBuild();
+                return token;
+            });
+        }
+        insertAt(token, i) {
+            if (typeof token !== 'string') {
+                const { type, name } = token;
+                if (type === 'template') {
+                    this.constructorError('不可插入模板');
+                }
+                else if (!debug_1.Shadow.running && type === 'magic-word' && name !== '!' && name !== '=') {
+                    this.constructorError('不可插入 "{{!}}" 或 "{{=}}" 以外的魔术字');
+                }
+            }
+            return super.insertAt(token, i);
+        }
+        /**
+         * 获取网址
+         * @throws `Error` 非标准协议
+         */
+        getUrl() {
+            let { link } = this;
+            if (link.startsWith('//')) {
+                link = `https:${link}`;
+            }
+            try {
+                return new URL(link);
+            }
+            catch (e) {
+                if (e instanceof TypeError && e.message === 'Invalid URL') {
+                    throw new Error(`非标准协议的外部链接：${link}`);
+                }
+                throw e;
+            }
+        }
+        /**
+         * 设置外链目标
+         * @param url 含协议的网址
+         */
+        setTarget(url) {
+            const { childNodes } = index_1.default.parse(url, this.getAttribute('include'), 2, this.getAttribute('config'));
+            this.replaceChildren(...childNodes);
+        }
+        /** 是否是模板或魔术字参数 */
+        isParamValue() {
+            return this.closest('parameter')?.getValue() === this.text();
+        }
+        /** 转义 `=` */
+        escape() {
+            for (const child of this.childNodes) {
+                if (child.type === 'text') {
+                    child.escape();
+                }
+            }
+        }
+    };
+    return MagicLinkToken = _classThis;
+})();
+exports.MagicLinkToken = MagicLinkToken;
+constants_1.classes['MagicLinkToken'] = __filename;

package/dist/src/nested.d.ts

@@ -0,0 +1,43 @@
+import Parser from '../index';
+import { Token } from './index';
+import { ExtToken } from './tagPair/ext';
+import { NoincludeToken } from './nowiki/noinclude';
+import { CommentToken } from './nowiki/comment';
+import type { LintError } from '../base';
+import type { AttributesToken } from './attributes';
+/**
+ * 嵌套式的扩展标签
+ * @classdesc `{childNodes: ...ExtToken|NoincludeToken|CommentToken}`
+ */
+export declare abstract class NestedToken extends Token {
+    #private;
+    readonly type = "ext-inner";
+    readonly name: string;
+    readonly childNodes: readonly (ExtToken | NoincludeToken | CommentToken)[];
+    abstract get firstChild(): ExtToken | NoincludeToken | CommentToken | undefined;
+    abstract get lastChild(): ExtToken | NoincludeToken | CommentToken | undefined;
+    abstract get nextSibling(): undefined;
+    abstract get previousSibling(): AttributesToken;
+    abstract get parentNode(): ExtToken | undefined;
+    abstract get children(): (ExtToken | NoincludeToken | CommentToken)[];
+    abstract get firstElementChild(): ExtToken | NoincludeToken | CommentToken | undefined;
+    abstract get lastElementChild(): ExtToken | NoincludeToken | CommentToken | undefined;
+    abstract get previousElementSibling(): AttributesToken;
+    abstract get nextElementSibling(): undefined;
+    abstract get parentElement(): ExtToken | undefined;
+    /**
+     * @param regex 内层正则
+     * @param tags 内层标签名
+     */
+    constructor(wikitext: string | undefined, regex: RegExp, tags: readonly string[], config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    lint(start?: number, re?: RegExp): LintError[];
+    /**
+     * @override
+     * @param token 待插入的子节点
+     * @param i 插入位置
+     */
+    insertAt<T extends Token>(token: T, i?: number): T;
+    /** @override */
+    cloneNode(): this;
+}

package/dist/src/nested.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NestedToken = void 0;
+const lint_1 = require("../util/lint");
+const debug_1 = require("../util/debug");
+const constants_1 = require("../util/constants");
+const index_1 = require("../index");
+const index_2 = require("./index");
+const ext_1 = require("./tagPair/ext");
+const noinclude_1 = require("./nowiki/noinclude");
+const comment_1 = require("./nowiki/comment");
+/**
+ * 嵌套式的扩展标签
+ * @classdesc `{childNodes: ...ExtToken|NoincludeToken|CommentToken}`
+ */
+class NestedToken extends index_2.Token {
+    type = 'ext-inner';
+    /* NOT FOR BROWSER */
+    #tags;
+    #regex;
+    /* NOT FOR BROWSER END */
+    /**
+     * @param regex 内层正则
+     * @param tags 内层标签名
+     */
+    constructor(wikitext, regex, tags, config = index_1.default.getConfig(), accum = []) {
+        wikitext = wikitext?.replace(regex, (comment, name, attr, inner, closing) => {
+            const str = `\0${accum.length + 1}${name ? 'e' : 'c'}\x7F`;
+            if (name) {
+                // @ts-expect-error abstract class
+                new ext_1.ExtToken(name, attr, inner, closing, config, accum);
+            }
+            else {
+                const closed = comment.endsWith('-->');
+                // @ts-expect-error abstract class
+                new comment_1.CommentToken(comment.slice(4, closed ? -3 : undefined), closed, config, accum);
+            }
+            return str;
+        }).replace(/(^|\0\d+[ce]\x7F)([^\0]+)(?=$|\0\d+[ce]\x7F)/gu, (_, lead, substr) => {
+            // @ts-expect-error abstract class
+            new noinclude_1.NoincludeToken(substr, config, accum);
+            return `${lead}\0${accum.length}c\x7F`;
+        });
+        super(wikitext, config, accum, {
+            NoincludeToken: ':', ExtToken: ':',
+        });
+        /* NOT FOR BROWSER */
+        this.#tags = [...tags];
+        this.#regex = regex;
+    }
+    /** @override */
+    lint(start = this.getAbsoluteIndex(), re) {
+        let rect;
+        return [
+            ...super.lint(start, re),
+            ...this.childNodes.filter(child => {
+                if (child.type === 'ext' || child.type === 'comment') {
+                    return false;
+                }
+                const str = String(child).trim();
+                return str && !/^<!--.*-->$/su.test(str);
+            }).map(child => {
+                rect ??= { start, ...this.getRootNode().posFromIndex(start) };
+                const e = (0, lint_1.generateForChild)(child, rect, 'no-ignored', index_1.default.msg('invalid content in <$1>', this.name));
+                e.suggestions = [
+                    {
+                        desc: 'remove',
+                        range: [e.startIndex, e.endIndex],
+                        text: '',
+                    },
+                    {
+                        desc: 'comment',
+                        range: [e.startIndex, e.startIndex],
+                        text: `<!--${String(child)}-->`,
+                    },
+                ];
+                return e;
+            }),
+        ];
+    }
+    /* NOT FOR BROWSER */
+    /**
+     * @override
+     * @param token 待插入的子节点
+     * @param i 插入位置
+     */
+    insertAt(token, i) {
+        if (typeof token !== 'string' && token.type === 'ext' && !this.#tags.includes(token.name)) {
+            this.constructorError(`只能以 ${this.#tags.join(' 或 ')} 标签作为子节点`);
+        }
+        return super.insertAt(token, i);
+    }
+    /** @override */
+    cloneNode() {
+        const cloned = this.cloneChildNodes(), config = this.getAttribute('config');
+        return debug_1.Shadow.run(() => {
+            // @ts-expect-error abstract class
+            const token = new NestedToken(undefined, this.#regex, this.#tags, config);
+            token.append(...cloned);
+            return token;
+        });
+    }
+}
+exports.NestedToken = NestedToken;
+constants_1.classes['NestedToken'] = __filename;

package/dist/src/nowiki/base.d.ts

@@ -0,0 +1,31 @@
+import Parser from '../../index';
+import { Token } from '../index';
+import type { AstText } from '../../lib/text';
+declare type NowikiTypes = 'ext-inner' | 'comment' | 'dd' | 'double-underscore' | 'hr' | 'list' | 'noinclude' | 'quote';
+/**
+ * 纯文字Token，不会被解析
+ * @classdesc `{childNodes: [AstText]}`
+ */
+export declare abstract class NowikiBaseToken extends Token {
+    type: NowikiTypes;
+    readonly childNodes: readonly [AstText];
+    abstract get firstChild(): AstText;
+    abstract get lastChild(): AstText;
+    abstract get children(): [];
+    abstract get firstElementChild(): undefined;
+    abstract get lastElementChild(): undefined;
+    /** 纯文本部分 */
+    get innerText(): string;
+    /** @param wikitext default: `''` */
+    constructor(wikitext?: string, config?: Parser.Config, accum?: Token[]);
+    /** @override */
+    cloneNode(this: this & {
+        constructor: new (...args: any[]) => unknown;
+    }): this;
+    /**
+     * @override
+     * @param str 新文本
+     */
+    setText(str: string): string;
+}
+export {};