wikiparser-node 1.5.2-b → 1.5.2

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import type { log } from './util/diff';
+import type { Config, LintError, Parser as ParserBase } from './base';
+import type { Title } from './lib/title';
+import type { Token } from './internal';
+declare interface Parser extends ParserBase {
+    conversionTable: Map<string, string>;
+    redirects: Map<string, string>;
+    warning: boolean;
+    debugging: boolean;
+    /**
+     * 规范化页面标题
+     * @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;
+    parse(wikitext: string, include?: boolean, maxStage?: number, config?: Config): Token;
+    /**
+     * 是否是跨维基链接
+     * @param title 链接标题
+     */
+    isInterwiki(title: string, config?: Config): RegExpExecArray | null;
+}
+declare const Parser: Parser;
+export = Parser;
+export type { Config, LintError };
+export type * from './internal';

package/dist/index.js

@@ -0,0 +1,214 @@
+"use strict";
+/* eslint n/exports-style: 0 */
+const fs = require("fs");
+const path = require("path");
+const chalk = require("chalk");
+const base_1 = require("./base");
+const debug_1 = require("./util/debug");
+const constants_1 = require("./util/constants");
+const string_1 = require("./util/string");
+const diff_1 = require("./util/diff");
+/**
+ * 从根路径require
+ * @param file 文件名
+ * @param dir 子路径
+ */
+const rootRequire = (file, dir) => require(file.startsWith('/') ? file : `../${file.includes('/') ? '' : dir}${file}`);
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+const Parser = {
+    config: 'default',
+    i18n: undefined,
+    rules: base_1.rules,
+    /* NOT FOR BROWSER */
+    conversionTable: new Map(),
+    redirects: new Map(),
+    warning: true,
+    debugging: false,
+    /* NOT FOR BROWSER END */
+    /** @implements */
+    getConfig() {
+        if (typeof this.config === 'string') {
+            this.config = rootRequire(this.config, 'config/');
+            /* NOT FOR BROWSER */
+            const { config: { conversionTable, redirects } } = this;
+            if (conversionTable) {
+                this.conversionTable = new Map(conversionTable);
+            }
+            if (redirects) {
+                this.redirects = new Map(redirects);
+            }
+            /* NOT FOR BROWSER END */
+            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 msg && (this.i18n?.[msg] ?? msg).replace('$1', this.msg(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/index');
+        const token = debug_1.Shadow.run(() => new Token(title, config).parseOnce(0, include).parseOnce()), titleObj = new Title(String(token), defaultNs, config, decode, selfLink);
+        /* NOT FOR BROWSER */
+        debug_1.Shadow.run(() => {
+            for (const key of ['main', 'fragment']) {
+                const str = titleObj[key];
+                if (str?.includes('\0')) {
+                    titleObj[key] = token.buildFromStr(str, constants_1.BuildMethod.Text);
+                }
+            }
+        });
+        titleObj.conversionTable = this.conversionTable;
+        titleObj.redirects = this.redirects;
+        /* NOT FOR BROWSER END */
+        return titleObj;
+    },
+    /** @implements */
+    parse(wikitext, include, maxStage = constants_1.MAX_STAGE, config = Parser.getConfig()) {
+        wikitext = (0, string_1.tidy)(wikitext);
+        const { Token } = require('./src/index');
+        const root = debug_1.Shadow.run(() => {
+            const token = new Token(wikitext, config);
+            try {
+                return 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 === constants_1.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;
+            }
+        });
+        /* NOT FOR BROWSER */
+        if (this.debugging) {
+            let restored = String(root), process = '解析';
+            if (restored === wikitext) {
+                const entities = { lt: '<', gt: '>', amp: '&' };
+                restored = root.print().replace(/<[^<]+?>|&([lg]t|amp);/gu, (_, s) => s ? entities[s] : '');
+                process = '渲染HTML';
+            }
+            if (restored !== wikitext) {
+                const { diff } = require('./util/diff');
+                const { 0: cur, length } = constants_1.promises;
+                constants_1.promises.unshift((async () => {
+                    await cur;
+                    this.error(`${process}过程中不可逆地修改了原始文本！`);
+                    return diff(wikitext, restored, length);
+                })());
+            }
+        }
+        /* NOT FOR BROWSER END */
+        return root;
+    },
+    /* NOT FOR BROWSER */
+    /** @implements */
+    warn(msg, ...args) {
+        if (this.warning) {
+            console.warn(chalk.yellow(msg), ...args);
+        }
+    },
+    /** @implements */
+    debug(msg, ...args) {
+        if (this.debugging) {
+            console.debug(chalk.blue(msg), ...args);
+        }
+    },
+    error: diff_1.error,
+    info: diff_1.info,
+    /** @implements */
+    log(f) {
+        if (typeof f === 'function') {
+            console.log(String(f));
+        }
+    },
+    /** @implements */
+    async clearCache() {
+        const promise = (0, diff_1.cmd)('npm', ['run', 'build']), entries = [
+            ...Object.entries(constants_1.classes),
+            ...Object.entries(constants_1.mixins),
+            ...Object.entries(constants_1.parsers),
+        ];
+        for (const [, filePath] of entries) {
+            try {
+                delete require.cache[require.resolve(filePath)];
+            }
+            catch { }
+        }
+        await promise;
+        for (const [name, filePath] of entries) {
+            if (name in global) {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+                Object.assign(global, { [name]: require(filePath)[name] });
+            }
+        }
+        this.info('已重新加载Parser');
+    },
+    /** @implements */
+    isInterwiki(title, { interwiki } = Parser.getConfig()) {
+        return interwiki.length > 0
+            ? new RegExp(`^(${interwiki.join('|')})\\s*:`, 'diu')
+                .exec(title.replace(/_/gu, ' ').replace(/^\s*:?\s*/u, ''))
+            : null;
+    },
+    /** @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 debug_1.Shadow.run(() => {
+            const halfParsed = stage < constants_1.MAX_STAGE, token = new Token(halfParsed ? wikitext : (0, string_1.tidy)(wikitext), this.getConfig());
+            if (halfParsed) {
+                token.setAttribute('stage', stage);
+                token.parseOnce(stage, include);
+            }
+            else {
+                token.parse(undefined, include);
+            }
+            fs.unlinkSync(file);
+            fs.unlinkSync(`${file}.err`);
+            fs.unlinkSync(`${file}.json`);
+            return token;
+        });
+    },
+};
+const def = {
+    default: { value: Parser },
+}, enumerable = new Set([
+    'normalizeTitle',
+    'parse',
+    /* NOT FOR BROWSER */
+    'conversionTable',
+    'redirects',
+    'warning',
+    'debugging',
+    'isInterwiki',
+]);
+for (const key in Parser) {
+    if (!enumerable.has(key)) {
+        def[key] = { enumerable: false };
+    }
+}
+Object.defineProperties(Parser, def);
+module.exports = Parser;

package/dist/internal.d.ts

@@ -0,0 +1,44 @@
+export type { AstNodes, } from './lib/node';
+export type * from './lib/text';
+export type * from './src/index';
+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 { AttributeToken } 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 { TableToken } from './src/table/index';
+export type * from './src/nowiki/hr';
+export type * from './src/nowiki/doubleUnderscore';
+export type * from './src/link/index';
+export type * from './src/link/category';
+export type { ImageParameterToken } 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/index';
+export type * from './src/pre';
+export type * from './src/paramTag/index';
+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

@@ -0,0 +1,150 @@
+import { AstNode } from './node';
+import type { LintError, AST } from '../base';
+import type { AstNodes, AstText, Token } from '../internal';
+/** 类似HTMLElement */
+export declare abstract class AstElement extends AstNode {
+    #private;
+    readonly name?: string;
+    readonly data: undefined;
+    /** 子节点总数 */
+    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();
+    /**
+     * 可见部分
+     * @param separator 子节点间的连接符
+     */
+    text(separator?: string): string;
+    /** 合并相邻的文本子节点 */
+    normalize(): void;
+    /**
+     * 移除子节点
+     * @param i 移除位置
+     */
+    removeAt(i: number): AstNodes;
+    /**
+     * 插入子节点
+     * @param node 待插入的子节点
+     * @param i 插入位置
+     * @throws `RangeError` 不能插入祖先或子节点
+     */
+    insertAt<T extends AstNodes>(node: T, i?: number): T;
+    /**
+     * 最近的祖先节点
+     * @param selector 选择器
+     */
+    closest<T = Token>(selector: string): T | undefined;
+    /**
+     * 在末尾批量插入子节点
+     * @param elements 插入节点
+     */
+    append(...elements: (AstNodes | string)[]): void;
+    /**
+     * 批量替换子节点
+     * @param elements 新的子节点
+     */
+    replaceChildren(...elements: (AstNodes | string)[]): void;
+    /**
+     * 修改文本子节点
+     * @param str 新文本
+     * @param i 子节点位置
+     * @throws `RangeError` 对应位置的子节点不是文本节点
+     */
+    setText(str: string, i?: number): string;
+    /**
+     * @override
+     * @param start
+     */
+    lint(start?: number): LintError[];
+    /**
+     * @override
+     * @param opt 选项
+     */
+    print(opt?: PrintOpt): string;
+    /**
+     * 保存为JSON
+     * @param file 文件名
+     * @param start
+     */
+    json(file?: string, start?: number): AST;
+    /** 销毁 */
+    destroy(): void;
+    /**
+     * 检查是否符合选择器
+     * @param selector 选择器
+     */
+    matches<T>(selector?: string): this is T;
+    /**
+     * 符合选择器的第一个后代节点
+     * @param selector 选择器
+     */
+    querySelector<T = Token>(selector: string): T | undefined;
+    /**
+     * 类型选择器
+     * @param types
+     */
+    getElementByTypes<T = Token>(types: string): T | undefined;
+    /**
+     * id选择器
+     * @param id id名
+     */
+    getElementById<T = Token>(id: string): T | undefined;
+    /**
+     * 符合选择器的所有后代节点
+     * @param selector 选择器
+     */
+    querySelectorAll<T = Token>(selector: string): T[];
+    /**
+     * 类选择器
+     * @param className 类名之一
+     */
+    getElementsByClassName<T = Token>(className: string): T[];
+    /**
+     * 标签名选择器
+     * @param tag 标签名
+     */
+    getElementsByTagName<T = Token>(tag: string): T[];
+    /**
+     * 获取某一行的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 child 插入节点
+     * @param reference 指定位置处的子节点
+     */
+    insertBefore(child: string, reference?: AstNodes): AstText;
+    insertBefore<T extends AstNodes>(child: T, reference?: AstNodes): T;
+}