wikilint 2.18.0 → 2.18.2

package/dist/base.d.mts

@@ -5,6 +5,7 @@ export interface Config {
     readonly namespaces: Record<string, string>;
     readonly nsid: Record<string, number>;
     readonly variable: string[];
+    readonly functionHook: string[];
     readonly parserFunction: [Record<string, string>, Record<string, string> | string[], string[], string[]];
     readonly doubleUnderscore: [string[], string[], Record<string, string>?, Record<string, string>?];
     readonly protocol: string;
@@ -239,6 +240,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;
@@ -247,8 +255,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

@@ -5,6 +5,7 @@ export interface Config {
     readonly namespaces: Record<string, string>;
     readonly nsid: Record<string, number>;
     readonly variable: string[];
+    readonly functionHook: string[];
     readonly parserFunction: [Record<string, string>, Record<string, string> | string[], string[], string[]];
     readonly doubleUnderscore: [string[], string[], Record<string, string>?, Record<string, string>?];
     readonly protocol: string;
@@ -239,6 +240,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;
@@ -247,8 +255,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

@@ -8,34 +8,6 @@ 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");
-const { argv } = process, [, , site, , force, old] = argv;
-let [, , , url] = argv;
-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
@@ -65,14 +37,66 @@ const filterGadget = (id) => {
     const n = Number(id);
     return n < 2300 || n > 2303; // Gadget, Gadget talk, Gadget definition, Gadget definition talk
 };
-(async () => {
-    const m = await (await fetch(`${url}/load.php?modules=ext.CodeMirror${old ? '.data' : ''}`)).text(), params = {
+/**
+ * Execute the data script.
+ * @param obj MediaWiki module implementation
+ */
+const execute = (obj) => {
+    Object.entries(obj.files).find(([k]) => k.endsWith('.data.js'))[1]();
+};
+const mw = {
+    loader: {
+        done: false,
+        /** @ignore */
+        impl(callback) {
+            execute(callback()[1]);
+        },
+        /** @ignore */
+        implement(name, callback) {
+            if (typeof callback === 'object') {
+                execute(callback);
+            }
+            else if (!this.done) {
+                callback();
+            }
+            if (name.startsWith('ext.CodeMirror.data')) {
+                this.done = true;
+            }
+        },
+        /** @ignore */
+        state() {
+            //
+        },
+    },
+    config: {
+        /** @ignore */
+        set({ extCodeMirrorConfig }) {
+            mwConfig = extCodeMirrorConfig;
+        },
+    },
+};
+let mwConfig;
+/**
+ * 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
+ */
+exports.default = async (site, url, force) => {
+    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('/'));
+    }
+    const m = await (await fetch(`${url}/load.php?modules=ext.CodeMirror.data|ext.CodeMirror`)).text(), params = {
         action: 'query',
         meta: 'siteinfo',
-        siprop: `general|magicwords|namespaces|namespacealiases${old ? '|variables' : ''}`,
+        siprop: 'general|magicwords|functionhooks|namespaces|namespacealiases',
         format: 'json',
         formatversion: '2',
-    }, { query: { general: { variants }, magicwords, namespaces, namespacealiases, variables } } = await (await fetch(`${url}/api.php?${new URLSearchParams(params).toString()}`)).json();
+    }, { query: { general: { articlepath, variants }, magicwords, namespaces, namespacealiases, functionhooks, }, } = await (await fetch(`${url}/api.php?${new URLSearchParams(params).toString()}`)).json(), { query: { variables } } = await (await fetch(`${url}/api.php?${new URLSearchParams({ ...params, siprop: 'variables' }).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 = '' }]) => [
@@ -87,8 +111,8 @@ const filterGadget = (id) => {
             ...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',
+        functionHook: [...functionhooks.map(s => s.toLowerCase()), 'msgnw'],
+        articlePath: articlepath,
     };
     config.doubleUnderscore[0] = [];
     config.doubleUnderscore[1] = [];
@@ -102,11 +126,15 @@ const filterGadget = (id) => {
     }
     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 (!config.variable) { // eslint-disable-line @typescript-eslint/no-unnecessary-condition
+        Object.assign(config, { variable: [...new Set([...variables, '='])] });
     }
-    if (force || !exists) {
+    const file = path_1.default.join(__dirname, dir, `${site}.json`);
+    if (force || !fs_1.default.existsSync(file)) {
         fs_1.default.writeFileSync(file, `${JSON.stringify(config, null, '\t')}\n`);
     }
-})();
+    else {
+        assert_1.default.deepStrictEqual(arrToObj(require(file)), arrToObj(config));
+    }
+    return config;
+};

package/dist/index.js

@@ -26,25 +26,27 @@ const Parser = {
     i18n: undefined,
     rules: base_1.rules,
     /** @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])) {
+            if (this.config.doubleUnderscore.length < 3
+                || Array.isArray(this.config.parserFunction[1])
+                || !('functionHook' in this.config)) {
                 (0, diff_1.error)(`The schema (${path_1.default.resolve(__dirname, '..', 'config', '.schema.json')}) of parser configuration is updated.`);
             }
             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

@@ -1,13 +1,12 @@
 import type { Position } from 'vscode-languageserver-types';
 import type { TextDocument } from 'vscode-languageserver-textdocument';
-import type { LanguageService as JSONLanguageService, JSONDocument } from 'vscode-json-languageservice';
-import type { LanguageService as CSSLanguageService, Stylesheet } from 'vscode-css-languageservice';
-import type { PublicApi } from 'stylelint';
+import type { JSONDocument } from 'vscode-json-languageservice';
+import type { Stylesheet } from 'vscode-css-languageservice';
 import type { Token } from '../internal';
 export declare const jsonTags: string[];
-declare let jsonLSP: JSONLanguageService | undefined, cssLSP: CSSLanguageService | undefined;
-declare const stylelint: Promise<PublicApi | undefined>;
-export { jsonLSP, cssLSP, stylelint };
+export declare const jsonLSP: import("vscode-json-languageservice").LanguageService | undefined;
+export declare const cssLSP: import("vscode-css-languageservice").LanguageService | undefined;
+export declare const stylelint: Promise<import("stylelint").PublicApi | undefined>;
 /** embedded document */
 declare class EmbeddedDocument implements TextDocument {
     #private;
@@ -52,3 +51,4 @@ export declare class EmbeddedCSSDocument extends EmbeddedDocument {
     constructor(root: Token, token: Token);
     getContent(): string;
 }
+export {};

package/dist/lib/document.js

@@ -7,39 +7,47 @@ exports.EmbeddedCSSDocument = exports.EmbeddedJSONDocument = exports.stylelint =
 const path_1 = __importDefault(require("path"));
 const common_1 = require("@bhsd/common");
 exports.jsonTags = ['templatedata', 'mapframe', 'maplink'];
-let jsonLSP, cssLSP;
-try {
-    exports.jsonLSP = jsonLSP = require('vscode-json-languageservice')
-        .getLanguageService({
-        /** @implements */
-        async schemaRequestService(uri) {
-            return (await fetch(uri)).text();
-        },
-    });
-    jsonLSP.configure({
-        schemas: exports.jsonTags.map((tag) => {
-            const uri = path_1.default.join('..', '..', 'data', 'ext', tag);
-            try {
-                const schema = require(uri);
-                return {
-                    uri,
-                    fileMatch: [tag],
-                    schema,
-                };
-            }
-            catch {
-                return false;
-            }
-        }).filter(Boolean),
-    });
-}
-catch { }
-try {
-    exports.cssLSP = cssLSP = require('vscode-css-languageservice')
-        .getCSSLanguageService();
-}
-catch { }
-const stylelint = (async () => {
+exports.jsonLSP = (() => {
+    try {
+        const lsp = require('vscode-json-languageservice')
+            .getLanguageService({
+            /** @implements */
+            async schemaRequestService(uri) {
+                return (await fetch(uri)).text();
+            },
+        });
+        lsp.configure({
+            schemas: exports.jsonTags.map((tag) => {
+                const uri = path_1.default.join('..', '..', 'data', 'ext', tag);
+                try {
+                    const schema = require(uri);
+                    return {
+                        uri,
+                        fileMatch: [tag],
+                        schema,
+                    };
+                }
+                catch {
+                    return false;
+                }
+            }).filter(Boolean),
+        });
+        return lsp;
+    }
+    catch {
+        return undefined;
+    }
+})();
+exports.cssLSP = (() => {
+    try {
+        return require('vscode-css-languageservice')
+            .getCSSLanguageService();
+    }
+    catch {
+        return undefined;
+    }
+})();
+exports.stylelint = (async () => {
     try {
         return (await import('stylelint')).default;
     }
@@ -47,7 +55,6 @@ const stylelint = (async () => {
         return undefined;
     }
 })();
-exports.stylelint = stylelint;
 /** embedded document */
 class EmbeddedDocument {
     uri = '';
@@ -100,7 +107,7 @@ class EmbeddedJSONDocument extends EmbeddedDocument {
     constructor(root, token) {
         super('json', root, token);
         this.uri = token.name;
-        this.jsonDoc = jsonLSP.parseJSONDocument(this);
+        this.jsonDoc = exports.jsonLSP.parseJSONDocument(this);
     }
 }
 exports.EmbeddedJSONDocument = EmbeddedJSONDocument;
@@ -113,7 +120,7 @@ class EmbeddedCSSDocument extends EmbeddedDocument {
     constructor(root, token) {
         const { type, tag } = token.parentNode;
         super('css', root, token, `${type === 'ext-attr' ? 'div' : tag}{`, '}');
-        this.styleSheet = cssLSP.parseStylesheet(this);
+        this.styleSheet = exports.cssLSP.parseStylesheet(this);
     }
     getContent() {
         return (0, common_1.sanitizeInlineStyle)(super.getContent());

package/dist/lib/lsp.d.ts

@@ -1,18 +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;
-    lilypondData: string[];
     /** @param uri 任务标识 */
     constructor(uri: object);
     /** @implements */
@@ -133,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>;
 }