wikiparser-node 1.21.3 → 1.22.1

package/dist/base.d.ts

@@ -112,7 +112,7 @@ interface Token extends AstNode {
      * Get all descendants that match the selector
      *
      * 符合选择器的所有后代节点
-     * @param selector 选择器
+     * @param selector selector / 选择器
      */
     querySelectorAll<T = Token>(selector: string): T[];
     /**
@@ -175,7 +175,7 @@ export interface LanguageService {
      *
      * 提供自动补全
      * @param text source Wikitext / 源代码
-     * @param position 位置
+     * @param position position / 位置
      */
     provideCompletionItems(text: string, position: Position): Promise<CompletionItem[] | undefined>;
     /**
@@ -205,7 +205,7 @@ export interface LanguageService {
      *
      * 提供引用
      * @param text source Wikitext / 源代码
-     * @param position 位置
+     * @param position position / 位置
      */
     provideReferences(text: string, position: Position): Promise<Omit<Location, 'uri'>[] | undefined>;
     /**
@@ -213,7 +213,7 @@ export interface LanguageService {
      *
      * 提供定义
      * @param text source Wikitext / 源代码
-     * @param position 位置
+     * @param position position / 位置
      */
     provideDefinition(text: string, position: Position): Promise<Omit<Location, 'uri'>[] | undefined>;
     /**
@@ -221,7 +221,7 @@ export interface LanguageService {
      *
      * 提供变量更名准备
      * @param text source Wikitext / 源代码
-     * @param position 位置
+     * @param position position / 位置
      */
     resolveRenameLocation(text: string, position: Position): Promise<Range | undefined>;
     /**
@@ -229,7 +229,7 @@ export interface LanguageService {
      *
      * 变量更名
      * @param text source Wikitext / 源代码
-     * @param position 位置
+     * @param position position / 位置
      * @param newName new name / 新名称
      */
     provideRenameEdits(text: string, position: Position, newName: string): Promise<WorkspaceEdit | undefined>;
@@ -238,7 +238,7 @@ export interface LanguageService {
      *
      * 提供悬停信息
      * @param text source Wikitext / 源代码
-     * @param position 位置
+     * @param position position / 位置
      */
     provideHover(text: string, position: Position): Promise<Hover | undefined>;
     /**
@@ -246,7 +246,7 @@ export interface LanguageService {
      *
      * 提供魔术字帮助
      * @param text source Wikitext / 源代码
-     * @param position 位置
+     * @param position position / 位置
      */
     provideSignatureHelp(text: string, position: Position): Promise<SignatureHelp | undefined>;
     /**
@@ -286,6 +286,8 @@ export interface LintConfiguration extends LintConfig {
 export interface Parser {
     config: ConfigData | string;
     i18n: Record<string, string> | string | undefined;
+    /** @since v1.22.0 */
+    lintConfig: LintConfiguration;
     /** @since v1.9.0 */
     viewOnly: boolean;
     /**

package/dist/bin/config.js

@@ -7,7 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const strict_1 = __importDefault(require("assert/strict"));
-const cm_1 = require("@bhsd/common/dist/cm");
+const cm_util_1 = require("@bhsd/cm-util");
 const diff_1 = require("../util/diff");
 /**
  * Converts an array to an object.
@@ -85,11 +85,23 @@ let mwConfig;
  * @param internal for internal use
  */
 exports.default = async (site, url, force, internal) => {
+    // wrong calls
     if (!site || !url) {
-        (0, diff_1.error)('Usage: npx getParserConfig <site> <script path> [force]');
-        process.exit(1);
+        if (internal) {
+            throw new RangeError('Site nickname and script path are required!');
+        }
+        else {
+            (0, diff_1.error)('Usage: npx getParserConfig <site> <script path> [force]');
+            process.exit(1);
+        }
+    }
+    // internal calls with stored configuration
+    const dir = path_1.default.join('..', '..', 'config'), file = path_1.default.join(__dirname, dir, `${site}.json`);
+    if (internal && !force && fs_1.default.existsSync(file)) {
+        return require(file);
     }
-    else if (/(?:\.php|\/)$/u.test(url)) {
+    // fetching configuration
+    if (/(?:\.php|\/)$/u.test(url)) {
         url = url.slice(0, url.lastIndexOf('/'));
     }
     const m = await (await fetch(`${url}/load.php?modules=ext.CodeMirror.data|ext.CodeMirror`)).text(), params = {
@@ -103,14 +115,14 @@ exports.default = async (site, url, force, internal) => {
     if (!mwConfig) {
         throw new RangeError('Extension:CodeMirror is not installed!');
     }
-    const dir = path_1.default.join('..', '..', 'config'), ns = Object.entries(namespaces).filter(([id]) => filterGadget(id))
+    const ns = Object.entries(namespaces).filter(([id]) => filterGadget(id))
         .flatMap(([id, { name, canonical = '' }]) => [
         [id, name],
         ...name === canonical ? [] : [[id, canonical]],
     ]), config = {
-        ...(0, cm_1.getParserConfig)(require(path_1.default.join(dir, 'minimum')), mwConfig),
-        ...(0, cm_1.getKeywords)(magicwords),
-        variants: (0, cm_1.getVariants)(variants),
+        ...(0, cm_util_1.getParserConfig)(require(path_1.default.join(dir, 'minimum')), mwConfig),
+        ...(0, cm_util_1.getKeywords)(magicwords),
+        variants: (0, cm_util_1.getVariants)(variants),
         namespaces: Object.fromEntries(ns),
         nsid: Object.fromEntries([
             ...ns.map(([id, canonical]) => [canonical.toLowerCase(), Number(id)]),
@@ -120,7 +132,7 @@ exports.default = async (site, url, force, internal) => {
     };
     config.doubleUnderscore[0] = [];
     config.doubleUnderscore[1] = [];
-    Object.assign(config.parserFunction[0], (0, cm_1.getConfig)(magicwords, ({ name }) => name === 'msgnw'));
+    Object.assign(config.parserFunction[0], (0, cm_util_1.getConfig)(magicwords, ({ name }) => name === 'msgnw'));
     config.parserFunction[2] = getAliases(magicwords, new Set(['msg', 'raw']));
     config.parserFunction[3] = getAliases(magicwords, new Set(['subst', 'safesubst']));
     if (!mwConfig.functionHooks) {
@@ -137,11 +149,11 @@ exports.default = async (site, url, force, internal) => {
             config.variable.splice(i, 1);
         }
     }
-    const file = path_1.default.join(__dirname, dir, `${site}.json`);
+    // saving configuration
     if (force || !fs_1.default.existsSync(file)) {
         fs_1.default.writeFileSync(file, `${JSON.stringify(config, null, '\t')}\n`);
     }
-    else if (!internal) {
+    else {
         const oldConfig = arrToObj(require(file)), newConfig = arrToObj(config);
         for (const [k, v] of Object.entries(newConfig)) {
             try {

package/dist/index.d.ts

@@ -1,8 +1,11 @@
 import type { Config, ConfigData, LintError, LintConfiguration, TokenTypes, Parser as ParserBase, Stage, AST } from './base';
 import type { Title, TitleOptions } from './lib/title';
 import type { LanguageService, QuickFixData } from './lib/lsp';
-import type { Token } from './internal';
+import type { Token, TranscludeToken, ExtToken } from './internal';
+declare type FunctionHook = (token: TranscludeToken, context?: TranscludeToken) => string;
+declare type TagHook = (token: ExtToken) => string;
 declare interface Parser extends ParserBase {
+    default: Parser;
     /** @since v1.5.1 */
     rules: readonly LintError.Rule[];
     conversionTable: Map<string, string>;
@@ -38,6 +41,14 @@ declare interface Parser extends ParserBase {
      * @since v1.16.1
      */
     createLanguageService(uri?: object): LanguageService;
+    /**
+     * get the name of a WMF site from a URL
+     *
+     * 获取一个WMF网站的名称
+     * @param url script path
+     * @since v1.22.0
+     */
+    getWMFSite(url: string): [string, string];
     /**
      * Get the parser configuration for a MediaWiki project with Extension:CodeMirror installed
      *
@@ -47,11 +58,29 @@ declare interface Parser extends ParserBase {
      * @since v1.18.4
      */
     fetchConfig(site: string, url: string): Promise<Config>;
+    /**
+     * Define how to expand a parser function
+     *
+     * 定义如何展开一个解析器函数
+     * @param name parser function name / 解析器函数名
+     * @param hook handler function / 处理函数
+     * @since v1.22.0
+     */
+    setFunctionHook(name: string, hook: FunctionHook): void;
+    /**
+     * Define how to convert an extension tag to HTML
+     *
+     * 定义如何将一个扩展标签转换为HTML
+     * @param name tag name / 标签名
+     * @param hook handler function / 处理函数
+     * @since v1.22.0
+     */
+    setHook(name: string, hook: TagHook): void;
     /**
      * Check if the title is an interwiki link
      *
      * 是否是跨维基链接
-     * @param title 链接标题
+     * @param title title / 链接标题
      */
     isInterwiki(title: string, config?: Config): RegExpExecArray | null;
 }

package/dist/index.js

@@ -15,9 +15,11 @@ const redirectMap_1 = require("./lib/redirectMap");
 /* NOT FOR BROWSER ONLY */
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const common_2 = require("@bhsd/common");
 const diff_1 = require("./util/diff");
 const config_1 = __importDefault(require("./bin/config"));
 /* NOT FOR BROWSER ONLY */
+const re = new RegExp(String.raw `^https?:\/\/([^./]+)\.(${common_2.wmf})\.org`, 'iu');
 /**
  * 从根路径require
  * @param file 文件名
@@ -72,6 +74,8 @@ const Parser = {
     templates: new redirectMap_1.RedirectMap(undefined, false),
     warning: true,
     debugging: false,
+    functionHooks: new Map(),
+    tagHooks: new Map(),
     /* NOT FOR BROWSER END */
     /* NOT FOR BROWSER ONLY */
     lintCSS: true,
@@ -145,6 +149,7 @@ const Parser = {
                 root.type = 'root';
                 root.parseOnce(0, include).parseOnce();
                 const t = new Title(root.toString(), defaultNs, config, opt);
+                root.build();
                 for (const key of ['main', 'fragment']) {
                     const str = t[key];
                     if (str?.includes('\0')) {
@@ -271,14 +276,31 @@ const Parser = {
         }
     },
     /* NOT FOR BROWSER ONLY */
+    /** @implements */
+    getWMFSite(url) {
+        const mt = re.exec(url);
+        if (!mt) {
+            throw new RangeError('Not a recognizable WMF site!');
+        }
+        const type = mt[2].toLowerCase();
+        return [mt[1].toLowerCase() + (type === 'wikipedia' ? 'wiki' : type), mt[0]];
+    },
     /* istanbul ignore next */
     /** @implements */
     async fetchConfig(site, url) {
         return this.getConfig(await (0, config_1.default)(site, url, false, true));
     },
-    /* NOT FOR BROWSER ONLY */
+    /* NOT FOR BROWSER ONLY END */
     /* NOT FOR BROWSER */
     /** @implements */
+    setFunctionHook(name, hook) {
+        this.functionHooks.set(name, hook);
+    },
+    /** @implements */
+    setHook(name, hook) {
+        this.tagHooks.set(name, hook);
+    },
+    /** @implements */
     warn(msg, ...args) {
         /* istanbul ignore if */
         if (this.warning) {
@@ -372,9 +394,13 @@ const Parser = {
 const def = {
     default: { value: Parser },
 }, enumerable = new Set([
+    'lintConfig',
     'normalizeTitle',
     'parse',
     'createLanguageService',
+    /* NOT FOR BROWSER ONLY */
+    'fetchConfig',
+    /* NOT FOR BROWSER ONLY END */
     /* NOT FOR BROWSER */
     'warning',
     'debugging',

package/dist/lib/document.js

@@ -113,7 +113,7 @@ class EmbeddedDocument {
         this.languageId = id;
         this.lineCount = root.getLines().length;
         this.#root = root;
-        this.#content = String(token);
+        this.#content = token.toString();
         this.#offset = token.getAbsoluteIndex();
         this.pre = pre;
         this.#post = post;

package/dist/lib/element.d.ts

@@ -69,21 +69,21 @@ export declare abstract class AstElement extends AstNode {
      * Get the closest ancestor node that matches the selector
      *
      * 最近的符合选择器的祖先节点
-     * @param selector 选择器
+     * @param selector selector / 选择器
      */
     closest<T = Token>(selector: string): T | undefined;
     /**
      * Get the first descendant that matches the selector
      *
      * 符合选择器的第一个后代节点
-     * @param selector 选择器
+     * @param selector selector / 选择器
      */
     querySelector<T = Token>(selector: string): T | undefined;
     /**
      * Get all descendants that match the selector
      *
      * 符合选择器的所有后代节点
-     * @param selector 选择器
+     * @param selector selector / 选择器
      */
     querySelectorAll<T = Token>(selector: string): T[];
     /**
@@ -143,7 +143,7 @@ export declare abstract class AstElement extends AstNode {
      * Check if the current element matches the selector
      *
      * 检查是否符合选择器
-     * @param selector 选择器
+     * @param selector selector / 选择器
      */
     matches<T>(selector?: string): this is T;
     /**

package/dist/lib/element.js

@@ -215,7 +215,7 @@ let AstElement = (() => {
          * Get the closest ancestor node that matches the selector
          *
          * 最近的符合选择器的祖先节点
-         * @param selector 选择器
+         * @param selector selector / 选择器
          */
         closest(selector) {
             const condition = (0, selector_1.getCondition)(selector, this);
@@ -251,7 +251,7 @@ let AstElement = (() => {
          * Get the first descendant that matches the selector
          *
          * 符合选择器的第一个后代节点
-         * @param selector 选择器
+         * @param selector selector / 选择器
          */
         querySelector(selector) {
             const condition = (0, selector_1.getCondition)(selector, this);
@@ -260,9 +260,9 @@ let AstElement = (() => {
         /**
          * 符合条件的所有后代节点
          * @param condition 条件
+         * @param descendants 已经找到的后代节点
          */
-        #getElementsBy(condition) {
-            let descendants = [];
+        #getElementsBy(condition, descendants = []) {
             for (const child of this.childNodes) {
                 if (child.type === 'text') {
                     continue;
@@ -270,7 +270,7 @@ let AstElement = (() => {
                 else if (condition(child)) {
                     descendants.push(child);
                 }
-                descendants = [...descendants, ...child.#getElementsBy(condition)];
+                child.#getElementsBy(condition, descendants);
             }
             return descendants;
         }
@@ -278,7 +278,7 @@ let AstElement = (() => {
          * Get all descendants that match the selector
          *
          * 符合选择器的所有后代节点
-         * @param selector 选择器
+         * @param selector selector / 选择器
          */
         querySelectorAll(selector) {
             const condition = (0, selector_1.getCondition)(selector, this);
@@ -469,7 +469,7 @@ let AstElement = (() => {
          * Check if the current element matches the selector
          *
          * 检查是否符合选择器
-         * @param selector 选择器
+         * @param selector selector / 选择器
          */
         matches(selector) {
             return selector === undefined || (0, selector_1.getCondition)(selector, this)(this);

package/dist/lib/lintConfig.js

@@ -11,10 +11,23 @@ const severities = new Set([0, 1, 2]), dict = new Map([
     [2, 'error'],
 ]);
 const defaultLintConfig = {
+    'bold-header': [
+        1,
+        {
+        // b: 1,
+        // strong: 1,
+        },
+    ],
     'format-leakage': [
-        2,
+        1,
+        {
+        // apostrophe: 1,
+        },
+    ],
+    'fostered-content': [
+        1,
         {
-        // apostrophe: 2,
+        // transclusion: 1,
         },
     ],
     h1: [
@@ -23,11 +36,20 @@ const defaultLintConfig = {
         // html: 1,
         },
     ],
+    'illegal-attr': [
+        2,
+        {
+        // tabindex: 2,
+        // unknown: 2,
+        // value: 2,
+        },
+    ],
+    'insecure-style': 2,
     'invalid-gallery': [
         2,
         {
-        // image: 2,
-        // parameter: 2,
+            // image: 2,
+            parameter: 1,
         },
     ],
     'invalid-imagemap': [
@@ -37,24 +59,68 @@ const defaultLintConfig = {
         // link: 2,
         },
     ],
+    'invalid-invoke': [
+        2,
+        {
+        // function: 2,
+        // name: 2,
+        },
+    ],
+    'invalid-isbn': 2,
+    'lonely-apos': [
+        1,
+        {
+        // word: 1,
+        },
+    ],
+    'lonely-bracket': [
+        1,
+        {
+            // converter: 1,
+            // double: 1,
+            extLink: 2,
+            // single: 1,
+        },
+    ],
+    'lonely-http': [
+        1,
+        {
+        // ISBN: 1,
+        // PMID: 1,
+        // RFC: 1,
+        },
+    ],
     'nested-link': [
         2,
         {
         // file: 2,
         },
     ],
+    'no-arg': 1,
     'no-duplicate': [
         2,
         {
-            // category: 2,
+            // attribute: 2,
+            category: 1,
             id: 1,
+            // imageParameter: 2,
+            // parameter: 2,
+            unknownImageParameter: 1,
         },
     ],
     'no-ignored': [
         2,
         {
+            // arg: 2,
+            // closingTag: 2,
             // conversionFlag: 2,
+            fragment: 1,
+            galleryComment: 1,
+            // galleryImage: 2,
+            galleryNoImage: 1,
             include: 1,
+            // invalidAttributes: 2,
+            nonWordAttributes: 1,
             redirect: 1,
             // choose: 2,
             // combobox: 2,
@@ -63,6 +129,33 @@ const defaultLintConfig = {
             // references: 2,
         },
     ],
+    'obsolete-attr': 1,
+    'obsolete-tag': 1,
+    'parsing-order': [
+        2,
+        {
+            // ext: 2,
+            // heading: 2,
+            // html: 2,
+            templateInTable: 1,
+        },
+    ],
+    'pipe-like': [
+        1,
+        {
+            double: 2,
+            // link: 1,
+            // td: 1,
+        },
+    ],
+    'table-layout': 1,
+    'tag-like': [
+        2,
+        {
+            disallowed: 1,
+            invalid: 1,
+        },
+    ],
     'unbalanced-header': 2,
     'unclosed-comment': [
         1,
@@ -70,7 +163,27 @@ const defaultLintConfig = {
         // include: 1,
         },
     ],
+    'unclosed-quote': 1,
+    'unclosed-table': 2,
     unescaped: 2,
+    'unknown-page': 1,
+    'unmatched-tag': [
+        1,
+        {
+        // both: 1,
+        // closing: 1,
+        // conditional: 1,
+        // opening: 1,
+        // selfClosing: 1,
+        },
+    ],
+    'unterminated-url': [
+        1,
+        {
+        // pipe: 1,
+        // punctuation: 1,
+        },
+    ],
     'url-encoding': [
         1,
         {
@@ -87,9 +200,10 @@ const defaultLintConfig = {
     'void-ext': [
         2,
         {
+        // img: 2,
         // languages: 2,
-        // templatestyles: 2,
         // section: 2,
+        // templatestyles: 2,
         },
     ],
     /* NOT FOR BROWSER ONLY */
@@ -144,6 +258,9 @@ class LintConfiguration {
     }
     /** @implements */
     getSeverity(rule, key) {
+        if (!(rule in this)) {
+            throw new RangeError(`Unknown rule: ${rule}`);
+        }
         const value = this[rule];
         if (typeof value === 'number') {
             return dict.get(value);

package/dist/lib/lsp.d.ts

@@ -48,7 +48,7 @@ export declare class LanguageService implements LanguageServiceBase {
      *
      * 提供自动补全
      * @param text source Wikitext / 源代码
-     * @param position 位置
+     * @param position position / 位置
      */
     provideCompletionItems(text: string, position: Position): Promise<CompletionItem[] | undefined>;
     /**
@@ -78,7 +78,7 @@ export declare class LanguageService implements LanguageServiceBase {
      *
      * 提供引用
      * @param text source Wikitext / 源代码
-     * @param position 位置
+     * @param position position / 位置
      */
     provideReferences(text: string, position: Position): Promise<Omit<Location, 'uri'>[] | undefined>;
     /**
@@ -86,7 +86,7 @@ export declare class LanguageService implements LanguageServiceBase {
      *
      * 提供定义
      * @param text source Wikitext / 源代码
-     * @param position 位置
+     * @param position position / 位置
      */
     provideDefinition(text: string, position: Position): Promise<Omit<Location, 'uri'>[] | undefined>;
     /**
@@ -94,7 +94,7 @@ export declare class LanguageService implements LanguageServiceBase {
      *
      * 提供变量更名准备
      * @param text source Wikitext / 源代码
-     * @param position 位置
+     * @param position position / 位置
      */
     resolveRenameLocation(text: string, position: Position): Promise<Range | undefined>;
     /**
@@ -102,7 +102,7 @@ export declare class LanguageService implements LanguageServiceBase {
      *
      * 变量更名
      * @param text source Wikitext / 源代码
-     * @param position 位置
+     * @param position position / 位置
      * @param newName new name / 新名称
      */
     provideRenameEdits(text: string, position: Position, newName: string): Promise<WorkspaceEdit | undefined>;
@@ -111,7 +111,7 @@ export declare class LanguageService implements LanguageServiceBase {
      *
      * 提供悬停信息
      * @param text source Wikitext / 源代码
-     * @param position 位置
+     * @param position position / 位置
      */
     provideHover(text: string, position: Position): Promise<Hover | undefined>;
     /**
@@ -119,7 +119,7 @@ export declare class LanguageService implements LanguageServiceBase {
      *
      * 提供魔术字帮助
      * @param text source Wikitext / 源代码
-     * @param position 位置
+     * @param position position / 位置
      */
     provideSignatureHelp(text: string, position: Position): Promise<SignatureHelp | undefined>;
     /**