wikiparser-node 1.17.1 → 1.18.1

package/dist/base.d.mts

@@ -266,6 +266,13 @@ export interface LanguageService {
      * @param text source Wikitext / 源代码
      */
     provideDocumentSymbols(text: string): Promise<DocumentSymbol[]>;
+    /**
+     * Set the target Wikipedia
+     *
+     * 设置目标维基百科
+     * @param wiki Wikipedia URL / 维基百科网址
+     */
+    setTargetWikipedia(wiki: string): Promise<void>;
 }
 export interface Parser {
     config: Config | string;
@@ -275,8 +282,9 @@ export interface Parser {
      * Get the current parser configuration
      *
      * 获取当前的解析设置
+     * @param config unprocessed parser configuration / 未处理的解析设置
      */
-    getConfig(): Config;
+    getConfig(config?: Config): Config;
     /**
      * Parse wikitext
      *

package/dist/base.d.ts

@@ -266,6 +266,13 @@ export interface LanguageService {
      * @param text source Wikitext / 源代码
      */
     provideDocumentSymbols(text: string): Promise<DocumentSymbol[]>;
+    /**
+     * Set the target Wikipedia
+     *
+     * 设置目标维基百科
+     * @param wiki Wikipedia URL / 维基百科网址
+     */
+    setTargetWikipedia(wiki: string): Promise<void>;
 }
 export interface Parser {
     config: Config | string;
@@ -275,8 +282,9 @@ export interface Parser {
      * Get the current parser configuration
      *
      * 获取当前的解析设置
+     * @param config unprocessed parser configuration / 未处理的解析设置
      */
-    getConfig(): Config;
+    getConfig(config?: Config): Config;
     /**
      * Parse wikitext
      *

package/dist/bin/config.js

@@ -0,0 +1,118 @@
+"use strict";
+/* eslint-disable n/no-process-exit */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const assert_1 = __importDefault(require("assert"));
+const cm_1 = require("@bhsd/common/dist/cm");
+/**
+ * Get the parser configuration for a Wikimedia Foundation project.
+ * @param site site nickname
+ * @param url script path
+ * @param force whether to overwrite the existing configuration
+ * @param old whether to target an older version of MediaWiki
+ */
+exports.default = async (site, url, force, old) => {
+    if (!site || !url) {
+        console.error('Usage: npx getParserConfig <site> <script path> [force]');
+        process.exit(1);
+    }
+    else if (/(?:\.php|\/)$/u.test(url)) {
+        url = url.slice(0, url.lastIndexOf('/'));
+    }
+    let mwConfig;
+    const mw = {
+        loader: {
+            /** @ignore */
+            impl(callback) {
+                Object.entries(callback()[1].files).find(([k]) => k.endsWith('.data.js'))[1]();
+            },
+            /** @ignore */
+            implement(_, callback) {
+                callback();
+            },
+        },
+        config: {
+            /** @ignore */
+            set({ extCodeMirrorConfig }) {
+                mwConfig = extCodeMirrorConfig;
+            },
+        },
+    };
+    /**
+     * Converts an array to an object.
+     * @param config parser configuration
+     * @param config.articlePath article path
+     */
+    const arrToObj = ({ articlePath, ...obj }) => {
+        for (const [k, v] of Object.entries(obj)) {
+            if (Array.isArray(v) && v.every(x => typeof x === 'string')) {
+                Object.assign(obj, { [k]: Object.fromEntries(v.map(x => [x, true])) });
+            }
+        }
+        return obj;
+    };
+    /**
+     * Gets the aliases of magic words.
+     * @param magicwords magic words
+     * @param targets magic word names
+     */
+    const getAliases = (magicwords, targets) => magicwords
+        .filter(({ name }) => targets.has(name))
+        .flatMap(({ aliases }) => aliases.map(s => s.replace(/:$/u, '').toLowerCase()));
+    /**
+     * Filters out gadget-related namespaces.
+     * @param id namespace ID
+     */
+    const filterGadget = (id) => {
+        const n = Number(id);
+        return n < 2300 || n > 2303; // Gadget, Gadget talk, Gadget definition, Gadget definition talk
+    };
+    const m = await (await fetch(`${url}/load.php?modules=ext.CodeMirror${old ? '.data' : ''}`)).text(), params = {
+        action: 'query',
+        meta: 'siteinfo',
+        siprop: `general|magicwords|namespaces|namespacealiases${old ? '|variables' : ''}`,
+        format: 'json',
+        formatversion: '2',
+    }, { query: { general: { variants }, magicwords, namespaces, namespacealiases, variables } } = await (await fetch(`${url}/api.php?${new URLSearchParams(params).toString()}`)).json();
+    eval(m); // eslint-disable-line no-eval
+    const dir = path_1.default.join('..', '..', 'config'), 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),
+        namespaces: Object.fromEntries(ns),
+        nsid: Object.fromEntries([
+            ...ns.map(([id, canonical]) => [canonical.toLowerCase(), Number(id)]),
+            ...namespacealiases.filter(({ id }) => filterGadget(id)).map(({ id, alias }) => [alias.toLowerCase(), id]),
+        ]),
+        ...old && { variable: [...variables, '='] },
+        articlePath: '/wiki/$1',
+    };
+    config.doubleUnderscore[0] = [];
+    config.doubleUnderscore[1] = [];
+    Object.assign(config.parserFunction[0], (0, cm_1.getConfig)(magicwords, ({ name }) => name === 'msgnw'));
+    if ('#choose' in config.parserFunction[0]) {
+        delete config.parserFunction[0]['choose'];
+        const i = config.variable.indexOf('choose');
+        if (i !== -1) {
+            config.variable.splice(i, 1);
+        }
+    }
+    config.parserFunction[2] = getAliases(magicwords, new Set(['msg', 'raw']));
+    config.parserFunction[3] = getAliases(magicwords, new Set(['subst', 'safesubst']));
+    const file = path_1.default.join(__dirname, dir, `${site}.json`), exists = fs_1.default.existsSync(file);
+    if (exists) {
+        assert_1.default.deepStrictEqual(arrToObj(require(file)), arrToObj(config));
+    }
+    if (force || !exists) {
+        fs_1.default.writeFileSync(file, `${JSON.stringify(config, null, '\t')}\n`);
+    }
+    return config;
+};

package/dist/index.js

@@ -74,9 +74,9 @@ const Parser = {
     debugging: false,
     /* NOT FOR BROWSER END */
     /** @implements */
-    getConfig() {
+    getConfig(config) {
         /* NOT FOR BROWSER ONLY */
-        if (typeof this.config === 'string') {
+        if (!config && typeof this.config === 'string') {
             this.config = rootRequire(this.config, 'config');
             /* istanbul ignore if */
             if (this.config.doubleUnderscore.length < 3 || Array.isArray(this.config.parserFunction[1])) {
@@ -96,14 +96,14 @@ const Parser = {
             return this.getConfig();
         }
         /* NOT FOR BROWSER ONLY END */
-        const { doubleUnderscore } = this.config;
+        const parserConfig = config ?? this.config, { doubleUnderscore } = parserConfig;
         for (let i = 0; i < 2; i++) {
             if (doubleUnderscore.length > i + 2 && doubleUnderscore[i].length === 0) {
                 doubleUnderscore[i] = Object.keys(doubleUnderscore[i + 2]);
             }
         }
         return {
-            ...this.config,
+            ...parserConfig,
             excludes: [],
         };
     },

package/dist/lib/document.d.ts

@@ -5,7 +5,8 @@ import type { LanguageService as CSSLanguageService, Stylesheet } from 'vscode-c
 import type { PublicApi } from 'stylelint';
 import type { Token } from '../internal';
 export declare const jsonTags: string[];
-declare let jsonLSP: JSONLanguageService | undefined, cssLSP: CSSLanguageService | undefined, stylelint: Promise<PublicApi> | undefined;
+declare let jsonLSP: JSONLanguageService | undefined, cssLSP: CSSLanguageService | undefined;
+declare const stylelint: Promise<PublicApi | undefined>;
 export { jsonLSP, cssLSP, stylelint };
 /** embedded document */
 declare class EmbeddedDocument implements TextDocument {

package/dist/lib/document.js

@@ -10,7 +10,7 @@ const common_1 = require("@bhsd/common");
 const constants_1 = require("../util/constants");
 /* NOT FOR BROWSER END */
 exports.jsonTags = ['templatedata', 'mapframe', 'maplink'];
-let jsonLSP, cssLSP, stylelint;
+let jsonLSP, cssLSP;
 try {
     exports.jsonLSP = jsonLSP = require('vscode-json-languageservice')
         .getLanguageService({
@@ -42,10 +42,15 @@ try {
         .getCSSLanguageService();
 }
 catch { }
-try {
-    exports.stylelint = stylelint = eval('(async () => (await import("stylelint")).default)()'); // eslint-disable-line no-eval
-}
-catch { }
+const stylelint = (async () => {
+    try {
+        return (await import('stylelint')).default;
+    }
+    catch {
+        return undefined;
+    }
+})();
+exports.stylelint = stylelint;
 /** embedded document */
 class EmbeddedDocument {
     uri = '';

package/dist/lib/lsp.d.ts

@@ -1,16 +1,27 @@
 import Parser from '../index';
 import type { Range, Position, ColorInformation, ColorPresentation, FoldingRange, DocumentLink, Location, WorkspaceEdit, Diagnostic as DiagnosticBase, TextEdit, Hover, SignatureHelp, InlayHint, CodeAction, DocumentSymbol } from 'vscode-languageserver-types';
-import type { LanguageService as LanguageServiceBase, CompletionItem, SignatureData } from '../base';
-import type { AttributeToken } from '../internal';
+import type { Config, LanguageService as LanguageServiceBase, CompletionItem, SignatureData } from '../base';
+import type { Token, AttributeToken } from '../internal';
 export interface QuickFixData extends TextEdit {
     title: string;
     fix: boolean;
 }
 export declare const tasks: WeakMap<object, Parser.LanguageService>;
+/**
+ * Check if a token is a plain attribute.
+ * @param token
+ * @param token.type
+ * @param token.parentNode
+ * @param token.length
+ * @param token.firstChild
+ * @param style whether it is a style attribute
+ */
+export declare const isAttr: ({ type, parentNode, length, firstChild }: Token, style?: boolean) => boolean | undefined;
 /** VSCode-style language service */
 export declare class LanguageService implements LanguageServiceBase {
     #private;
     include: boolean;
+    lilypond: string;
     /** @param uri 任务标识 */
     constructor(uri: object);
     /** @implements */
@@ -131,4 +142,12 @@ export declare class LanguageService implements LanguageServiceBase {
      * @param text source Wikitext / 源代码
      */
     provideDocumentSymbols(text: string): Promise<DocumentSymbol[]>;
+    /**
+     * Set the target Wikipedia
+     *
+     * 设置目标维基百科
+     * @param wiki Wikipedia URL / 维基百科网址
+     * @throws `RangeError` 不是有效的维基百科网址
+     */
+    setTargetWikipedia(wiki: string): Promise<void>;
 }