wikilint 2.18.2 → 2.18.4

package/README.md

@@ -6,7 +6,7 @@
 
 # WikiLint
 
-This is a minimal version of [WikiParser-Node](https://www.npmjs.com/package/wikiparser-node) customized for [eslint-plugin-wikitext](https://www.npmjs.com/package/eslint-plugin-wikitext).
+This is a minimal version of [WikiParser-Node](https://www.npmjs.com/package/wikiparser-node). The [WikiParser Language Server](https://marketplace.visualstudio.com/items?itemName=Bhsd.vscode-extension-wikiparser) VSCode extension is written based on this package.
 
 You can also directly lint Wikitext articles in the command line using this package:
 

package/bin/cli.js

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 'use strict';
-require('../dist/bin/cli.js');
+require('../dist/bin/cli.js'); // eslint-disable-line n/no-missing-require

package/config/minimum.json

@@ -98,6 +98,13 @@
 	],
 	"parserFunction": [
 		{
+			"msgnw": "msgnw",
+			"pageid": "pageid",
+			"articlepath": "articlepath",
+			"server": "server",
+			"servername": "servername",
+			"scriptpath": "scriptpath",
+			"stylepath": "stylepath",
 			"#language": "language",
 			"#special": "special",
 			"#speciale": "speciale",

package/dist/base.d.mts

@@ -41,6 +41,7 @@ export declare const stages: {
     list: number;
     dd: number;
     converter: number;
+    'list-range': number;
 };
 export type Stage = keyof typeof stages;
 export declare const rules: readonly ["bold-header", "format-leakage", "fostered-content", "h1", "illegal-attr", "insecure-style", "invalid-gallery", "invalid-imagemap", "invalid-invoke", "invalid-isbn", "lonely-apos", "lonely-bracket", "lonely-http", "nested-link", "no-arg", "no-duplicate", "no-ignored", "obsolete-attr", "obsolete-tag", "parsing-order", "pipe-like", "table-layout", "tag-like", "unbalanced-header", "unclosed-comment", "unclosed-quote", "unclosed-table", "unescaped", "unknown-page", "unmatched-tag", "unterminated-url", "url-encoding", "var-anchor", "void-ext", "invalid-css"];
@@ -271,6 +272,7 @@ export interface Parser {
      *
      * 创建语言服务
      * @param uri document URI / 文档标识
+     * @since v1.16.1
      */
     createLanguageService(uri: object): LanguageService;
 }

package/dist/base.d.ts

@@ -41,6 +41,7 @@ export declare const stages: {
     list: number;
     dd: number;
     converter: number;
+    'list-range': number;
 };
 export type Stage = keyof typeof stages;
 export declare const rules: readonly ["bold-header", "format-leakage", "fostered-content", "h1", "illegal-attr", "insecure-style", "invalid-gallery", "invalid-imagemap", "invalid-invoke", "invalid-isbn", "lonely-apos", "lonely-bracket", "lonely-http", "nested-link", "no-arg", "no-duplicate", "no-ignored", "obsolete-attr", "obsolete-tag", "parsing-order", "pipe-like", "table-layout", "tag-like", "unbalanced-header", "unclosed-comment", "unclosed-quote", "unclosed-table", "unescaped", "unknown-page", "unmatched-tag", "unterminated-url", "url-encoding", "var-anchor", "void-ext", "invalid-css"];
@@ -271,6 +272,7 @@ export interface Parser {
      *
      * 创建语言服务
      * @param uri document URI / 文档标识
+     * @since v1.16.1
      */
     createLanguageService(uri: object): LanguageService;
 }

package/dist/base.js

@@ -27,6 +27,7 @@ exports.stages = (() => {
         list: 10,
         dd: 10,
         converter: 11,
+        'list-range': 11,
     };
     Object.setPrototypeOf(obj, null);
     return obj;

package/dist/base.mjs

@@ -23,7 +23,8 @@ const stages = /* @__PURE__ */ (() => {
     "magic-link": 9,
     list: 10,
     dd: 10,
-    converter: 11
+    converter: 11,
+    "list-range": 11
   };
   Object.setPrototypeOf(obj, null);
   return obj;

package/dist/bin/config.js

@@ -81,8 +81,9 @@ let mwConfig;
  * @param site site nickname
  * @param url script path
  * @param force whether to overwrite the existing configuration
+ * @param internal for internal use
  */
-exports.default = async (site, url, force) => {
+exports.default = async (site, url, force, internal) => {
     if (!site || !url) {
         console.error('Usage: npx getParserConfig <site> <script path> [force]');
         process.exit(1);
@@ -133,7 +134,7 @@ exports.default = async (site, url, force) => {
     if (force || !fs_1.default.existsSync(file)) {
         fs_1.default.writeFileSync(file, `${JSON.stringify(config, null, '\t')}\n`);
     }
-    else {
+    else if (!internal) {
         assert_1.default.deepStrictEqual(arrToObj(require(file)), arrToObj(config));
     }
     return config;

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 import type { Config, LintError, TokenTypes, Parser as ParserBase, Stage } from './base';
-import type { Title } from './lib/title';
+import type { Title, TitleOptions } from './lib/title';
 import type { LanguageService, QuickFixData } from './lib/lsp';
 import type { Token } from './internal';
 declare interface Parser extends ParserBase {
+    /** @since v1.5.1 */
     rules: readonly LintError.Rule[];
     /**
      * Normalize page title
@@ -19,8 +20,18 @@ declare interface Parser extends ParserBase {
      *
      * 创建语言服务
      * @param uri document URI / 文档标识
+     * @since v1.16.1
      */
     createLanguageService(uri: object): LanguageService;
+    /**
+     * Get the parser configuration for a MediaWiki project with Extension:CodeMirror installed
+     *
+     * 获取一个安装了CodeMirror扩展的MediaWiki项目的解析设置
+     * @param site site nickname / 网站别名
+     * @param url script path / 脚本路径
+     * @since v1.18.4
+     */
+    fetchConfig(site: string, url: string): Promise<Config>;
 }
 declare const Parser: Parser;
 // @ts-expect-error mixed export styles

package/dist/index.js

@@ -11,6 +11,7 @@ const string_1 = require("./util/string");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const diff_1 = require("./util/diff");
+const config_1 = __importDefault(require("./bin/config"));
 /* NOT FOR BROWSER ONLY */
 /**
  * 从根路径require
@@ -25,6 +26,9 @@ const Parser = {
     config: 'default',
     i18n: undefined,
     rules: base_1.rules,
+    /* NOT FOR BROWSER ONLY */
+    lintCSS: true,
+    /* NOT FOR BROWSER ONLY END */
     /** @implements */
     getConfig(config) {
         /* NOT FOR BROWSER ONLY */
@@ -39,7 +43,7 @@ const Parser = {
             return this.getConfig();
         }
         /* NOT FOR BROWSER ONLY END */
-        const parserConfig = config ?? this.config, { doubleUnderscore } = parserConfig;
+        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]);
@@ -61,11 +65,11 @@ const Parser = {
         return msg && (this.i18n?.[msg] ?? msg).replace('$1', this.msg(arg));
     },
     /** @implements */
-    normalizeTitle(title, defaultNs = 0, include, config = Parser.getConfig(), temporary = false, halfParsed, decode = false, selfLink = false) {
+    normalizeTitle(title, defaultNs = 0, include, config = Parser.getConfig(), opt) {
         const { Title } = require('./lib/title');
         let titleObj;
-        if (halfParsed) {
-            titleObj = new Title(title, defaultNs, config, temporary, decode, selfLink);
+        if (opt?.halfParsed) {
+            titleObj = new Title(title, defaultNs, config, opt);
         }
         else {
             const { Token } = require('./src/index');
@@ -73,7 +77,7 @@ const Parser = {
                 const root = new Token(title, config);
                 root.type = 'root';
                 root.parseOnce(0, include).parseOnce();
-                const t = new Title(root.toString(), defaultNs, config, temporary, decode, selfLink);
+                const t = new Title(root.toString(), defaultNs, config, opt);
                 for (const key of ['main', 'fragment']) {
                     const str = t[key];
                     if (str?.includes('\0')) {
@@ -94,8 +98,9 @@ const Parser = {
     /** @implements */
     parse(wikitext, include, maxStage = constants_1.MAX_STAGE, config = Parser.getConfig()) {
         wikitext = (0, string_1.tidy)(wikitext);
+        let types;
         if (typeof maxStage !== 'number') {
-            const types = Array.isArray(maxStage) ? maxStage : [maxStage];
+            types = Array.isArray(maxStage) ? maxStage : [maxStage];
             maxStage = Math.max(...types.map(t => base_1.stages[t] || constants_1.MAX_STAGE));
         }
         const { Token } = require('./src/index');
@@ -132,28 +137,34 @@ const Parser = {
         const token = new Token((0, string_1.tidy)(wikitext), config);
         token.type = 'root';
         let i = 0;
-        await new Promise(resolve => {
-            const /** @ignore */ check = () => {
-                if (watch() === wikitext) {
-                    i++;
-                    set(parseOnce, 0);
-                }
-                else {
-                    resolve();
-                }
-            }, 
-            /** @ignore */ parseOnce = () => {
-                if (i === constants_1.MAX_STAGE + 1) {
-                    token.afterBuild();
-                    resolve();
-                }
-                else {
-                    token[i === constants_1.MAX_STAGE ? 'build' : 'parseOnce'](i, include);
-                    check();
-                }
-            };
-            set(parseOnce, 0);
-        });
+        try {
+            await new Promise(resolve => {
+                const /** @ignore */ check = () => {
+                    if (watch() === wikitext) {
+                        i++;
+                        set(parseOnce, 0);
+                    }
+                    else {
+                        resolve();
+                    }
+                }, 
+                /** @ignore */ parseOnce = () => {
+                    if (i === constants_1.MAX_STAGE + 1) {
+                        token.afterBuild();
+                        resolve();
+                    }
+                    else {
+                        token[i === constants_1.MAX_STAGE ? 'build' : 'parseOnce'](i, include);
+                        check();
+                    }
+                };
+                set(parseOnce, 0);
+            });
+        }
+        catch (e) /* istanbul ignore next */ {
+            debug_1.Shadow.running = running;
+            throw e;
+        }
         debug_1.Shadow.running = running;
         return token;
     },
@@ -165,6 +176,12 @@ const Parser = {
             return tasks.get(uri) ?? new LanguageService(uri);
         }
     },
+    /* NOT FOR BROWSER ONLY */
+    /** @implements */
+    async fetchConfig(site, url) {
+        return this.getConfig(await (0, config_1.default)(site, url, false, true));
+    },
+    /* NOT FOR BROWSER ONLY */
 };
 const def = {
     default: { value: Parser },

package/dist/lib/lsp.d.ts

@@ -20,6 +20,7 @@ export declare const isAttr: ({ type, parentNode, length, firstChild }: Token, s
 /** VSCode-style language service */
 export declare class LanguageService implements LanguageServiceBase {
     #private;
+    /** @since v1.17.1 */
     include: boolean;
     lilypond: string;
     /** @param uri 任务标识 */

package/dist/lib/lsp.js

@@ -16,13 +16,13 @@ const util_1 = __importDefault(require("util"));
 const child_process_1 = require("child_process");
 const crypto_1 = require("crypto");
 const stylelint_1 = require("@bhsd/common/dist/stylelint");
-const config_1 = __importDefault(require("../bin/config"));
 const document_1 = require("./document");
 /** @see https://www.npmjs.com/package/stylelint-config-recommended */
 const cssRules = {
     'block-no-empty': null,
     'property-no-unknown': null,
 }, jsonSelector = document_1.jsonTags.map(s => `ext-inner#${s}`).join(), scores = new Map();
+let colors;
 /* NOT FOR BROWSER ONLY END */
 exports.tasks = new WeakMap();
 const refTags = new Set(['ref']), referencesTags = new Set(['ref', 'references']), nameAttrs = new Set(['name', 'extends', 'follow']), groupAttrs = new Set(['group']), renameTypes = new Set([
@@ -40,6 +40,7 @@ const refTags = new Set(['ref']), referencesTags = new Set(['ref', 'references']
     'magic-word-name',
     ...renameTypes,
 ]), plainTypes = new Set(['text', 'comment', 'noinclude', 'include']), cssSelector = ['ext', 'html', 'table'].map(s => `${s}-attr#style`).join();
+const getLinkRegex = (0, common_1.getRegex)(protocol => new RegExp(`^(?:${protocol}|//)`, 'iu'));
 /**
  * Check if a token is a plain attribute.
  * @param token
@@ -273,6 +274,7 @@ class LanguageService {
     #config;
     #include;
     #completionConfig;
+    /** @since v1.17.1 */
     include = true;
     /** @private */
     config;
@@ -406,11 +408,14 @@ class LanguageService {
     async provideDocumentColors(rgba, text, hsl = true) {
         const root = await this.#queue(text);
         /* NOT FOR BROWSER ONLY */
-        let colors;
+        /* eslint-disable require-atomic-updates */
         try {
-            colors = new RegExp(String.raw `\b${Object.keys((await import('color-name')).default).join('|')}\b`, 'giu');
+            colors ??= new RegExp(String.raw `\b${Object.keys((await import('color-name')).default).join('|')}\b`, 'giu');
         }
-        catch { }
+        catch {
+            colors = false;
+        }
+        /* eslint-enable require-atomic-updates */
         /* NOT FOR BROWSER ONLY END */
         return root.querySelectorAll('attr-value,parameter-value,arg-default').reverse()
             .flatMap(token => {
@@ -637,7 +642,7 @@ class LanguageService {
             if (t === 'magic-word' && n !== 'invoke') {
                 return undefined;
             }
-            const key = this.#text.slice(cur.getAbsoluteIndex(), root.indexFromPos(line, character)).trimStart(), [module, func] = t === 'magic-word' ? transclusion.getModule() : [];
+            const key = this.#text.slice(cur.getAbsoluteIndex(), root.indexFromPos(line, character)).trimStart(), [mod, func] = t === 'magic-word' ? transclusion.getModule() : [];
             return key
                 ? getCompletion(root.querySelectorAll('parameter').filter(token => {
                     if (token === parentNode
@@ -650,7 +655,7 @@ class LanguageService {
                         return true;
                     }
                     const [m, f] = token.parentNode.getModule();
-                    return m === module && f === func;
+                    return m === mod && f === func;
                 }).map(({ name }) => name), 'Variable', key, position, type === 'parameter-value' ? '=' : '')
                 : undefined;
             /* NOT FOR BROWSER ONLY */
@@ -893,7 +898,7 @@ class LanguageService {
      */
     async provideLinks(text) {
         this.config ??= index_1.default.getConfig();
-        const { articlePath, protocol } = this.config, absolute = articlePath?.includes('//'), protocolRegex = new RegExp(`^(?:${protocol}|//)`, 'iu');
+        const { articlePath, protocol } = this.config, absolute = articlePath?.includes('//'), protocolRegex = getLinkRegex(protocol);
         return (await this.#queue(text))
             .querySelectorAll(`magic-link,ext-link-url,free-ext-link,attr-value,image-parameter#link${absolute ? ',link-target,template-name,invoke-module,magic-word#filepath,magic-word#widget' : ''}`)
             .reverse()
@@ -953,8 +958,8 @@ class LanguageService {
                             ns = name === 'filepath' ? 6 : 274;
                         // no default
                     }
-                    const title = index_1.default.normalizeTitle(target, ns, false, this.config, true);
-                    /* istanbul ignore if */
+                    const title = index_1.default
+                        .normalizeTitle(target, ns, false, this.config, { temporary: true });
                     if (!title.valid) {
                         return false;
                     }
@@ -1110,13 +1115,13 @@ class LanguageService {
         }
         else if (type === 'magic-word-name') {
             info = this.#getParserFunction(parentNode.name);
-            f = offsetNode.toString(true).trim();
+            f = offsetNode.text().trim();
             colon = parentNode.getAttribute('colon');
         }
         else if (offsetNode.is('magic-word') && !offsetNode.modifier && length === 1
             && (offset > 0 || root.posFromIndex(offsetNode.getAbsoluteIndex()).left === position.character)) {
             info = this.#getParserFunction(name);
-            f = offsetNode.firstChild.toString(true).trim();
+            f = offsetNode.firstChild.text().trim();
             colon = offsetNode.getAttribute('colon');
         }
         else if ((offsetNode.is('magic-word') || offsetNode.is('template'))
@@ -1203,7 +1208,7 @@ class LanguageService {
         }
         const n = childNodes.length - 1, candidates = info.signatures.filter(params => (params.length >= n || params[params.length - 1]?.rest)
             && params.every(({ label, const: c }, i) => {
-                const p = c && i < n && childNodes[i + 1]?.toString(true).trim();
+                const p = c && i < n && childNodes[i + 1]?.text().trim();
                 return !p || label.toLowerCase().includes(p.toLowerCase());
             }));
         if (candidates.length === 0) {
@@ -1216,7 +1221,7 @@ class LanguageService {
                 break;
             }
         }
-        const f = firstChild.toString(true).trim(), colon = lastChild.getAttribute('colon');
+        const f = firstChild.text().trim(), colon = lastChild.getAttribute('colon');
         return {
             signatures: candidates.map((params) => ({
                 label: `{{${f}${params.length === 0 ? '' : colon}${params.map(({ label }) => label).join('|')}}}`,
@@ -1331,7 +1336,7 @@ class LanguageService {
             this.config = index_1.default.getConfig(config);
         }
         catch {
-            this.config = index_1.default.getConfig(await (0, config_1.default)(site, `${mt[0]}/w`));
+            this.config = await index_1.default.fetchConfig(site, `${mt[0]}/w`);
         }
         Object.assign(this.config, { articlePath: `${mt[0]}/wiki/` });
     }

package/dist/lib/text.js

@@ -74,7 +74,6 @@ class AstText extends node_1.AstNode {
     constructor(text) {
         super();
         Object.defineProperties(this, {
-            childNodes: { enumerable: false, configurable: false },
             data: {
                 value: text,
             },
@@ -132,12 +131,13 @@ class AstText extends node_1.AstNode {
         ]);
         for (let mt = errorRegex.exec(data); mt; mt = errorRegex.exec(data)) {
             const [, tag, prefix] = mt;
-            let { index } = mt, error = mt[0].toLowerCase();
+            let { index, 0: error } = mt;
             if (prefix && prefix !== ']') {
                 const { length } = prefix;
                 index += length;
                 error = error.slice(length);
             }
+            error = error.toLowerCase();
             const { 0: char, length } = error, magicLink = char === 'r' || char === 'p' || char === 'i';
             if (char === '<' && !tags.has(tag.toLowerCase())
                 || char === '[' && type === 'ext-link-text' && (/&(?:rbrack|#93|#x5[Dd];);/u.test(data.slice(index + 1))

package/dist/lib/title.d.ts

@@ -1,4 +1,10 @@
 import type { Config } from '../base';
+export interface TitleOptions {
+    temporary?: boolean | undefined;
+    decode?: boolean | undefined;
+    selfLink?: boolean | undefined;
+    halfParsed?: boolean | undefined;
+}
 /**
  * title object of a MediaWiki page
  *
@@ -18,21 +24,28 @@ export declare class Title {
     get prefix(): string;
     /** full title / 完整标题 */
     get title(): string;
-    /** file extension / 扩展名 */
+    /**
+     * file extension / 扩展名
+     * @since v1.1.0
+     */
     get extension(): string | undefined;
     /**
      * @see MediaWikiTitleCodec::splitTitleString
      *
      * @param title 标题（含或不含命名空间前缀）
      * @param defaultNs 命名空间
-     * @param decode 是否需要解码
-     * @param selfLink 是否允许selfLink
+     * @param config
+     * @param opt 选项
+     * @param opt.temporary 是否是临时标题
+     * @param opt.decode 是否需要解码
+     * @param opt.selfLink 是否允许selfLink
      */
-    constructor(title: string, defaultNs: number, config: Config, temporary: boolean, decode: boolean, selfLink: boolean);
+    constructor(title: string, defaultNs: number, config: Config, { temporary, decode, selfLink }?: TitleOptions);
     /**
      * Check if the title is a redirect
      *
      * 检测是否是重定向
+     * @since v1.12.2
      */
     getRedirection(): [boolean, string];
     /**
@@ -40,6 +53,7 @@ export declare class Title {
      *
      * 生成URL
      * @param articlePath article path / 条目路径
+     * @since v1.10.0
      */
     getUrl(articlePath?: string): string;
 }

package/dist/lib/title.js

@@ -41,7 +41,10 @@ class Title {
     get title() {
         return this.getRedirection()[1];
     }
-    /** file extension / 扩展名 */
+    /**
+     * file extension / 扩展名
+     * @since v1.1.0
+     */
     get extension() {
         const { main } = this, i = main.lastIndexOf('.');
         return i === -1 ? undefined : main.slice(i + 1).toLowerCase();
@@ -51,10 +54,13 @@ class Title {
      *
      * @param title 标题（含或不含命名空间前缀）
      * @param defaultNs 命名空间
-     * @param decode 是否需要解码
-     * @param selfLink 是否允许selfLink
+     * @param config
+     * @param opt 选项
+     * @param opt.temporary 是否是临时标题
+     * @param opt.decode 是否需要解码
+     * @param opt.selfLink 是否允许selfLink
      */
-    constructor(title, defaultNs, config, temporary, decode, selfLink) {
+    constructor(title, defaultNs, config, { temporary, decode, selfLink } = {}) {
         const subpage = title.trim().startsWith('../');
         if (decode && title.includes('%')) {
             try {
@@ -116,6 +122,7 @@ class Title {
      * Check if the title is a redirect
      *
      * 检测是否是重定向
+     * @since v1.12.2
      */
     getRedirection() {
         // eslint-disable-next-line @typescript-eslint/prefer-destructuring
@@ -133,6 +140,7 @@ class Title {
      *
      * 生成URL
      * @param articlePath article path / 条目路径
+     * @since v1.10.0
      */
     getUrl(articlePath) {
         LSP: { // eslint-disable-line no-unused-labels