wikiparser-node 1.0.0-beta.3 → 1.0.1-b

package/dist/index.d.ts

@@ -1,62 +0,0 @@
-import type { Title } from './lib/title';
-import type { Token } from './internal';
-export interface Config {
-    ext: string[];
-    html: [string[], string[], string[]];
-    namespaces: Record<string, string>;
-    nsid: Record<string, number>;
-    parserFunction: [Record<string, string>, string[], string[], string[]];
-    doubleUnderscore: [string[], string[]];
-    protocol: string;
-    img: Record<string, string>;
-    variants: string[];
-    interwiki: string[];
-    excludes?: string[];
-    conversionTable?: [string, string][];
-    redirects?: [string, string][];
-}
-export interface LintError {
-    message: string;
-    severity: 'error' | 'warning';
-    startIndex: number;
-    endIndex: number;
-    startLine: number;
-    startCol: number;
-    endLine: number;
-    endCol: number;
-    excerpt: string;
-}
-declare interface Parser {
-    /** @browser */
-    config: string | Config;
-    /** @browser */
-    i18n?: string | Record<string, string>;
-    conversionTable: Map<string, string>;
-    redirects: Map<string, string>;
-    /**
-     * 规范化页面标题
-     * @browser
-     * @param title 标题（含或不含命名空间前缀）
-     * @param defaultNs 命名空间
-     * @param include 是否嵌入
-     * @param halfParsed 是否是半解析状态
-     * @param decode 是否需要解码
-     * @param selfLink 是否允许selfLink
-     */
-    normalizeTitle(title: string, defaultNs?: number, include?: boolean, config?: Config, halfParsed?: boolean, decode?: boolean, selfLink?: boolean): Title;
-    /**
-     * 解析wikitext
-     * @browser
-     * @param include 是否嵌入
-     * @param maxStage 最大解析层级
-     */
-    parse(wikitext: string, include?: boolean, maxStage?: number, config?: Config): Token;
-    /**
-     * 是否是跨维基链接
-     * @param title 链接标题
-     */
-    isInterwiki(title: string, config?: Config): [string, string] | null;
-}
-declare const Parser: Parser;
-export default Parser;
-export type * from './internal';

package/dist/index.js

@@ -1,305 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = require("fs");
-const path = require("path");
-/**
- * 从根路径require
- * @param file 文件名
- * @param dir 子路径
- */
-const rootRequire = (file, dir = '') => require(`../${file.includes('/') ? '' : dir}${file}`);
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-const Parser = {
-    config: 'default',
-    conversionTable: new Map(),
-    redirects: new Map(),
-    MAX_STAGE: 11,
-    warning: true,
-    debugging: false,
-    running: false,
-    classes: {},
-    mixins: {},
-    parsers: {},
-    aliases: [
-        ['AstText'],
-        ['CommentToken', 'ExtToken', 'IncludeToken', 'NoincludeToken'],
-        ['ArgToken', 'TranscludeToken', 'HeadingToken'],
-        ['HtmlToken'],
-        ['TableToken'],
-        ['HrToken', 'DoubleUnderscoreToken'],
-        ['LinkToken', 'FileToken', 'CategoryToken'],
-        ['QuoteToken'],
-        ['ExtLinkToken'],
-        ['MagicLinkToken'],
-        ['ListToken', 'DdToken'],
-        ['ConverterToken'],
-    ],
-    typeAliases: {
-        text: ['string', 'str'],
-        plain: ['regular', 'normal'],
-        // comment and extension
-        onlyinclude: ['only-include'],
-        noinclude: ['no-include'],
-        include: ['includeonly', 'include-only'],
-        comment: undefined,
-        ext: ['extension'],
-        'ext-attrs': ['extension-attrs', 'ext-attributes', 'extension-attributes'],
-        'ext-attr-dirty': ['extension-attr-dirty', 'ext-attribute-dirty', 'extension-attribute-dirty'],
-        'ext-attr': ['extension-attr', 'ext-attribute', 'extension-attribute'],
-        'attr-key': ['attribute-key'],
-        'attr-value': ['attribute-value', 'attr-val', 'attribute-val'],
-        'ext-inner': ['extension-inner'],
-        // triple braces
-        arg: ['argument'],
-        'arg-name': ['argument-name'],
-        'arg-default': ['argument-default'],
-        hidden: ['arg-redundant'],
-        // double braces
-        'magic-word': ['parser-function', 'parser-func'],
-        'magic-word-name': ['parser-function-name', 'parser-func-name'],
-        'invoke-function': ['invoke-func', 'lua-function', 'lua-func', 'module-function', 'module-func'],
-        'invoke-module': ['lua-module'],
-        template: undefined,
-        'template-name': undefined,
-        parameter: ['param'],
-        'parameter-key': ['param-key'],
-        'parameter-value': ['parameter-val', 'param-value', 'param-val'],
-        // heading
-        heading: ['header'],
-        'heading-title': ['header-title'],
-        'heading-trail': ['header-trail'],
-        // html
-        html: undefined,
-        'html-attrs': ['html-attributes'],
-        'html-attr-dirty': ['html-attribute-dirty'],
-        'html-attr': ['html-attribute'],
-        // table
-        table: undefined,
-        tr: ['table-row'],
-        td: ['table-cell', 'table-data'],
-        'table-syntax': undefined,
-        'table-attrs': ['tr-attrs', 'td-attrs', 'table-attributes', 'tr-attributes', 'td-attributes'],
-        'table-attr-dirty': ['tr-attr-dirty', 'td-attr-dirty', 'table-attribute-dirty', 'tr-attribute-dirty', 'td-attribute-dirty'],
-        'table-attr': ['tr-attr', 'td-attr', 'table-attribute', 'tr-attribute', 'td-attribute'],
-        'table-inter': undefined,
-        'td-inner': ['table-cell-inner', 'table-data-inner'],
-        // hr and double-underscore
-        hr: ['horizontal'],
-        'double-underscore': ['underscore', 'behavior-switch', 'behaviour-switch'],
-        // link
-        link: ['wikilink'],
-        'link-target': ['wikilink-target'],
-        'link-text': ['wikilink-text'],
-        category: ['category-link', 'cat', 'cat-link'],
-        file: ['file-link', 'image', 'image-link', 'img', 'img-link'],
-        'gallery-image': ['gallery-file', 'gallery-img'],
-        'imagemap-image': ['imagemap-file', 'imagemap-img', 'image-map-image', 'image-map-file', 'image-map-img'],
-        'image-parameter': ['img-parameter', 'image-param', 'img-param'],
-        // quotes
-        quote: ['quotes', 'quot', 'apostrophe', 'apostrophes', 'apos'],
-        // external link
-        'ext-link': ['external-link'],
-        'ext-link-text': ['external-link-text'],
-        'ext-link-url': ['external-link-url'],
-        // magic link
-        'free-ext-link': ['free-external-link', 'magic-link'],
-        // list
-        list: ['ol', 'ordered-list', 'ul', 'unordered-list', 'dl', 'description-list'],
-        dd: ['indent', 'indentation'],
-        // converter
-        converter: ['convert', 'conversion'],
-        'converter-flags': ['convert-flags', 'conversion-flags'],
-        'converter-flag': ['convert-flag', 'conversion-flag'],
-        'converter-rule': ['convert-rule', 'conversion-rule'],
-        'converter-rule-noconvert': ['convert-rule-noconvert', 'conversion-rule-noconvert'],
-        'converter-rule-variant': ['convert-rule-variant', 'conversion-rule-variant'],
-        'converter-rule-to': ['convert-rule-to', 'conversion-rule-to'],
-        'converter-rule-from': ['convert-rule-from', 'conversion-rule-from'],
-        // specific extensions
-        'param-line': ['parameter-line'],
-        'imagemap-link': ['image-map-link'],
-    },
-    promises: [Promise.resolve()],
-    /** @implements */
-    getConfig() {
-        if (typeof this.config === 'string') {
-            this.config = rootRequire(this.config, 'config/');
-            const { config: { conversionTable, redirects } } = this;
-            if (conversionTable) {
-                this.conversionTable = new Map(conversionTable);
-            }
-            if (redirects) {
-                this.redirects = new Map(redirects);
-            }
-            return this.getConfig();
-        }
-        return { ...this.config, excludes: [] };
-    },
-    /** @implements */
-    msg(msg, arg = '') {
-        if (typeof this.i18n === 'string') {
-            this.i18n = rootRequire(this.i18n, 'i18n/');
-            return this.msg(msg, arg);
-        }
-        return (this.i18n?.[msg] ?? msg).replace('$1', arg);
-    },
-    /** @implements */
-    normalizeTitle(title, defaultNs = 0, include = false, config = Parser.getConfig(), halfParsed = false, decode = false, selfLink = false) {
-        const { Title } = require('./lib/title');
-        if (halfParsed) {
-            return new Title(title, defaultNs, config, decode, selfLink);
-        }
-        const { Token } = require('./src');
-        const token = this.run(() => new Token(title, config).parseOnce(0, include).parseOnce()), titleObj = new Title(String(token.firstChild), defaultNs, config, decode, selfLink);
-        this.run(() => {
-            for (const key of ['main', 'fragment']) {
-                if (titleObj[key]?.includes('\0')) {
-                    titleObj[key] = token.buildFromStr(titleObj[key], 'text');
-                }
-            }
-        });
-        titleObj.conversionTable = this.conversionTable;
-        titleObj.redirects = this.redirects;
-        return titleObj;
-    },
-    /** @implements */
-    parse(wikitext, include, maxStage = Parser.MAX_STAGE, config = Parser.getConfig()) {
-        const { Token } = require('./src');
-        let token;
-        this.run(() => {
-            token = new Token(wikitext, config);
-            try {
-                token.parse(maxStage, include);
-            }
-            catch (e) {
-                if (e instanceof Error) {
-                    const file = path.join(__dirname, '..', 'errors', new Date().toISOString()), stage = token.getAttribute('stage');
-                    fs.writeFileSync(file, stage === this.MAX_STAGE ? wikitext : String(token));
-                    fs.writeFileSync(`${file}.err`, e.stack);
-                    fs.writeFileSync(`${file}.json`, JSON.stringify({
-                        stage, include: token.getAttribute('include'), config: this.config,
-                    }, null, '\t'));
-                }
-                throw e;
-            }
-        });
-        if (this.debugging) {
-            let restored = String(token), process = '解析';
-            if (restored === wikitext) {
-                const entities = { lt: '<', gt: '>', amp: '&' };
-                restored = token.print().replace(/<[^<]+?>|&([lg]t|amp);/gu, (_, s) => s ? entities[s] : '');
-                process = '渲染HTML';
-            }
-            if (restored !== wikitext) {
-                const { diff } = require('./util/diff');
-                const { promises: { 0: cur, length } } = this;
-                this.promises.unshift((async () => {
-                    await cur;
-                    this.error(`${process}过程中不可逆地修改了原始文本！`);
-                    return diff(wikitext, restored, length);
-                })());
-            }
-        }
-        return token;
-    },
-    /** @implements */
-    run(callback) {
-        const { running } = this;
-        this.running = true;
-        try {
-            const result = callback();
-            this.running = running;
-            return result;
-        }
-        catch (e) {
-            this.running = running;
-            throw e;
-        }
-    },
-    /** @implements */
-    warn(msg, ...args) {
-        if (this.warning) {
-            console.warn('\x1B[33m%s\x1B[0m', msg, ...args);
-        }
-    },
-    /** @implements */
-    debug(msg, ...args) {
-        if (this.debugging) {
-            console.debug('\x1B[34m%s\x1B[0m', msg, ...args);
-        }
-    },
-    /** @implements */
-    error(msg, ...args) {
-        console.error('\x1B[31m%s\x1B[0m', msg, ...args);
-    },
-    /** @implements */
-    info(msg, ...args) {
-        console.info('\x1B[32m%s\x1B[0m', msg, ...args);
-    },
-    /** @implements */
-    log(f) {
-        if (typeof f === 'function') {
-            console.log(String(f));
-        }
-    },
-    /** @implements */
-    clearCache() {
-        const entries = [
-            ...Object.entries(this.classes),
-            ...Object.entries(this.mixins),
-            ...Object.entries(this.parsers),
-        ];
-        for (const [, filePath] of entries) {
-            try {
-                delete require.cache[require.resolve(filePath)];
-            }
-            catch { }
-        }
-        for (const [name, filePath] of entries) {
-            if (name in global) {
-                // @ts-expect-error noImplicitAny
-                global[name] = require(filePath);
-            }
-        }
-    },
-    /** @implements */
-    isInterwiki(title, { interwiki } = Parser.getConfig()) {
-        return new RegExp(`^(${interwiki.join('|')})\\s*:`, 'iu')
-            .exec(title.replaceAll('_', ' ').replace(/^\s*:?\s*/u, ''));
-    },
-    /** @implements */
-    reparse(date) {
-        const main = fs.readdirSync(path.join(__dirname, '..', 'errors'))
-            .find(name => name.startsWith(date) && name.endsWith('Z'));
-        if (!main) {
-            throw new RangeError(`找不到对应时间戳的错误记录：${date}`);
-        }
-        const file = path.join(__dirname, '..', 'errors', main), wikitext = fs.readFileSync(file, 'utf8');
-        const { stage, include, config } = require(`${file}.json`), { Token } = require('./src');
-        this.config = config;
-        return this.run(() => {
-            const halfParsed = stage < this.MAX_STAGE, token = new Token(wikitext, this.getConfig(), halfParsed);
-            if (halfParsed) {
-                token.setAttribute('stage', stage).parseOnce(stage, include);
-            }
-            else {
-                token.parse(undefined, include);
-            }
-            fs.unlinkSync(file);
-            fs.unlinkSync(`${file}.err`);
-            fs.unlinkSync(`${file}.json`);
-            return token;
-        });
-    },
-};
-const def = {}, immutable = new Set(['MAX_STAGE', 'aliases', 'typeAliases', 'promises']), enumerable = new Set(['config', 'conversionTable', 'redirects', 'normalizeTitle', 'parse', 'isInterwiki']);
-for (const key in Parser) {
-    if (immutable.has(key)) {
-        def[key] = { enumerable: false, writable: false };
-    }
-    else if (!enumerable.has(key)) {
-        def[key] = { enumerable: false };
-    }
-}
-Object.defineProperties(Parser, def);
-exports.default = Parser;

package/dist/internal.d.ts

@@ -1,44 +0,0 @@
-export type { AstNodes, } from './lib/node';
-export type * from './lib/text';
-export type * from './src';
-export type * from './src/onlyinclude';
-export type * from './src/nowiki/noinclude';
-export type * from './src/tagPair/include';
-export type * from './src/nowiki/comment';
-export type * from './src/atom';
-export type * from './src/attribute';
-export type * from './src/attributes';
-export type * from './src/tagPair/ext';
-export type * from './src/hidden';
-export type * from './src/arg';
-export type * from './src/syntax';
-export type * from './src/parameter';
-export type * from './src/transclude';
-export type * from './src/heading';
-export type * from './src/html';
-export type { TdToken } from './src/table/td';
-export type * from './src/table/tr';
-export type * from './src/table';
-export type * from './src/nowiki/hr';
-export type * from './src/nowiki/doubleUnderscore';
-export type * from './src/link';
-export type * from './src/link/category';
-export type * from './src/imageParameter';
-export type * from './src/link/file';
-export type * from './src/link/galleryImage';
-export type * from './src/nowiki/quote';
-export type * from './src/magicLink';
-export type * from './src/extLink';
-export type * from './src/nowiki/dd';
-export type * from './src/nowiki/list';
-export type * from './src/converterFlags';
-export type * from './src/converterRule';
-export type * from './src/converter';
-export type * from './src/nowiki';
-export type * from './src/pre';
-export type * from './src/paramTag';
-export type * from './src/paramTag/inputbox';
-export type * from './src/nested';
-export type * from './src/gallery';
-export type * from './src/imagemapLink';
-export type * from './src/imagemap';

package/dist/lib/element.d.ts

@@ -1,186 +0,0 @@
-import { AstNode } from './node';
-import type { LintError } from '../index';
-import type { AstNodes, AstText, Token } from '../internal';
-/** 类似HTMLElement */
-export declare abstract class AstElement extends AstNode {
-    #private;
-    /** @browser */
-    name?: string;
-    /**
-     * 子节点总数
-     * @browser
-     */
-    get length(): number;
-    /** 全部非文本子节点 */
-    get children(): Token[];
-    /** 首位非文本子节点 */
-    get firstElementChild(): Token | undefined;
-    /** 末位非文本子节点 */
-    get lastElementChild(): Token | undefined;
-    /** 非文本子节点总数 */
-    get childElementCount(): number;
-    /** 父节点 */
-    get parentElement(): Token | undefined;
-    /** AstElement.prototype.text()的getter写法 */
-    get outerText(): string;
-    /** 不可见 */
-    get hidden(): boolean;
-    /** 后一个可见的兄弟节点 */
-    get nextVisibleSibling(): AstNodes | undefined;
-    /** 前一个可见的兄弟节点 */
-    get previousVisibleSibling(): AstNodes | undefined;
-    /** 内部高度 */
-    get clientHeight(): number | undefined;
-    /** 内部宽度 */
-    get clientWidth(): number | undefined;
-    constructor();
-    /**
-     * 可见部分
-     * @browser
-     * @param separator 子节点间的连接符
-     */
-    text(separator?: string): string;
-    /**
-     * 合并相邻的文本子节点
-     * @browser
-     */
-    normalize(): void;
-    /**
-     * 移除子节点
-     * @browser
-     * @param i 移除位置
-     */
-    removeAt(i: number): AstNodes;
-    /**
-     * 插入子节点
-     * @browser
-     * @param node 待插入的子节点
-     * @param i 插入位置
-     * @throws `RangeError` 不能插入祖先节点
-     */
-    insertAt<T extends AstNodes>(node: T, i?: number): T;
-    /**
-     * 最近的祖先节点
-     * @browser
-     * @param selector 选择器
-     */
-    closest(selector: string): Token | undefined;
-    /**
-     * 在末尾批量插入子节点
-     * @browser
-     * @param elements 插入节点
-     */
-    append(...elements: (AstNodes | string)[]): void;
-    /**
-     * 批量替换子节点
-     * @browser
-     * @param elements 新的子节点
-     */
-    replaceChildren(...elements: (AstNodes | string)[]): void;
-    /**
-     * 修改文本子节点
-     * @browser
-     * @param str 新文本
-     * @param i 子节点位置
-     * @throws `RangeError` 对应位置的子节点不是文本节点
-     */
-    setText(str: string, i?: number): string;
-    /**
-     * 还原为wikitext
-     * @browser
-     * @param selector
-     * @param separator 子节点间的连接符
-     */
-    toString(selector?: string, separator?: string): string;
-    /**
-     * Linter
-     * @browser
-     * @param start
-     */
-    lint(start?: number): LintError[];
-    /**
-     * 以HTML格式打印
-     * @browser
-     * @param opt 选项
-     */
-    print(opt?: PrintOpt): string;
-    /**
-     * 保存为JSON
-     * @browser
-     * @param file 文件名
-     */
-    json(file?: string): unknown;
-    /** 销毁 */
-    destroy(): void;
-    /**
-     * 检查是否符合选择器
-     * @param selector 选择器
-     */
-    matches(selector?: string): boolean;
-    /**
-     * 符合选择器的第一个后代节点
-     * @param selector 选择器
-     */
-    querySelector(selector: string): Token | undefined;
-    /**
-     * 符合选择器的所有后代节点
-     * @param selector 选择器
-     */
-    querySelectorAll(selector: string): Token[];
-    /**
-     * id选择器
-     * @param id id名
-     */
-    getElementById(id: string): Token | undefined;
-    /**
-     * 类选择器
-     * @param className 类名之一
-     */
-    getElementsByClassName(className: string): Token[];
-    /**
-     * 标签名选择器
-     * @param name 标签名
-     */
-    getElementsByTagName(name: string): Token[];
-    /**
-     * 获取某一行的wikitext
-     * @param n 行号
-     */
-    getLine(n: number): string | undefined;
-    /**
-     * 在开头批量插入子节点
-     * @param elements 插入节点
-     */
-    prepend(...elements: (AstNodes | string)[]): void;
-    /**
-     * 移除子节点
-     * @param node 子节点
-     */
-    removeChild<T extends AstNodes>(node: T): T;
-    /**
-     * 在末尾插入子节点
-     * @param node 插入节点
-     */
-    appendChild(node: string): AstText;
-    /** @ignore */
-    appendChild<T extends AstNodes>(node: T): T;
-    /**
-     * 在指定位置前插入子节点
-     * @param child 插入节点
-     * @param reference 指定位置处的子节点
-     */
-    insertBefore(child: string, reference?: AstNodes): AstText;
-    /** @ignore */
-    insertBefore<T extends AstNodes>(child: T, reference?: AstNodes): T;
-    /**
-     * 替换子节点
-     * @param newChild 新子节点
-     * @param oldChild 原子节点
-     */
-    replaceChild<T extends AstNodes>(newChild: AstNodes | string, oldChild: T): T;
-    /**
-     * 输出AST
-     * @param depth 当前深度
-     */
-    echo(depth?: number): void;
-}