wikilint 2.16.4 → 2.16.6

package/dist/base.d.mts

@@ -65,19 +65,33 @@ export interface LintError {
     fix?: LintError.Fix;
     suggestions?: LintError.Fix[];
 }
-/** 类似Node */
+/**
+ * Node-like
+ *
+ * 类似Node
+ */
 export interface AstNode {
     readonly childNodes: readonly AstNode[];
-    /** 节点类型 */
+    /**
+     * node type
+     *
+     * 节点类型
+     */
     type: string;
     toString(...args: unknown[]): string;
     /** Linter */
     lint(): LintError[];
 }
-/** 所有节点的基类 */
+/**
+ * base class for all tokens
+ *
+ * 所有节点的基类
+ */
 interface Token extends AstNode {
     readonly name?: string;
     /**
+     * Get all descendants that match the selector
+     *
      * 符合选择器的所有后代节点
      * @param selector 选择器
      */
@@ -101,108 +115,151 @@ export type CompletionItem = Omit<CompletionItemBase, 'kind'> & {
     kind: keyof typeof CompletionItemKind;
 };
 export interface LanguageService {
-    /** 销毁实例 */
+    /**
+     * Destroy the instance
+     *
+     * 销毁实例
+     */
     destroy(): void;
     /**
+     * Provide color decorators
+     *
      * 提供颜色指示
-     * @param rgba 颜色解析函数
-     * @param text 源代码
-     * @param hsl 是否允许HSL颜色
+     * @param rgba color parser / 颜色解析函数
+     * @param text source Wikitext / 源代码
+     * @param hsl whether HSL colors are treated / 是否允许HSL颜色
      */
     provideDocumentColors(rgba: (s: string) => [number, number, number, number] | [], text: string, hsl?: boolean): Promise<ColorInformation[]>;
     /**
+     * Provide color pickers
+     *
      * 颜色选择器
-     * @param color 颜色信息
+     * @param color color information / 颜色信息
      */
     provideColorPresentations(color: ColorInformation): ColorPresentation[];
     /**
+     * Provide auto-completion
+     *
      * 提供自动补全
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     provideCompletionItems(text: string, position: Position): Promise<CompletionItem[] | undefined>;
     /**
+     * Provide grammar check
+     *
      * 提供语法检查
-     * @param wikitext 源代码
+     * @param text source Wikitext / 源代码
+     * @param warning whether to include warnings / 是否包含警告
      */
-    provideDiagnostics(wikitext: string, warning?: boolean): Promise<Diagnostic[]>;
+    provideDiagnostics(text: string, warning?: boolean): Promise<Diagnostic[]>;
     /**
+     * Provide folding ranges
+     *
      * 提供折叠范围
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     provideFoldingRanges(text: string): Promise<FoldingRange[]>;
     /**
+     * Provide links
+     *
      * 提供链接
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     provideLinks(text: string): Promise<DocumentLink[]>;
     /**
+     * Provide references
+     *
      * 提供引用
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     provideReferences(text: string, position: Position): Promise<Omit<Location, 'uri'>[] | undefined>;
     /**
+     * Provide definitions
+     *
      * 提供定义
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     provideDefinition(text: string, position: Position): Promise<Omit<Location, 'uri'>[] | undefined>;
     /**
+     * Provide locations for renaming
+     *
      * 提供变量更名准备
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     resolveRenameLocation(text: string, position: Position): Promise<Range | undefined>;
     /**
+     * Provide rename edits
+     *
      * 变量更名
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
-     * @param newName 新名称
+     * @param newName new name / 新名称
      */
     provideRenameEdits(text: string, position: Position, newName: string): Promise<WorkspaceEdit | undefined>;
     /**
+     * Provide hover information
+     *
      * 提供悬停信息
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     provideHover(text: string, position: Position): Promise<Hover | undefined>;
     /**
+     * Provide signature help for magic words
+     *
      * 提供魔术字帮助
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     provideSignatureHelp(text: string, position: Position): Promise<SignatureHelp | undefined>;
     /**
+     * Provide CodeLens
+     *
      * 提供 CodeLens
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     provideInlayHints(text: string): Promise<InlayHint[]>;
     /**
+     * Provide quick fixes
+     *
      * 提供快速修复建议
-     * @param diagnostics 语法诊断信息
+     * @param diagnostics grammar diagnostics / 语法诊断信息
      */
     provideCodeAction(diagnostics: Diagnostic[]): CodeAction[];
     /**
+     * Provide document sections
+     *
      * 提供章节
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     provideDocumentSymbols(text: string): Promise<DocumentSymbol[]>;
 }
 export interface Parser {
     config: Config | string;
     i18n: Record<string, string> | string | undefined;
-    /** 获取当前的解析设置 */
+    /**
+     * Get the current parser configuration
+     *
+     * 获取当前的解析设置
+     */
     getConfig(): Config;
     /**
+     * Parse wikitext
+     *
      * 解析wikitext
-     * @param include 是否嵌入
-     * @param maxStage 最大解析层级
+     * @param include whether to be transcluded / 是否嵌入
+     * @param maxStage max stage for parsing / 最大解析层级
      */
     parse(wikitext: string, include?: boolean, maxStage?: number | Stage | Stage[], config?: Config): Token;
     /**
+     * Create a language server
+     *
      * 创建语言服务
-     * @param uri 文档标识
+     * @param uri document URI / 文档标识
      */
     createLanguageService(uri: object): LanguageService;
 }

package/dist/base.d.ts

@@ -65,19 +65,33 @@ export interface LintError {
     fix?: LintError.Fix;
     suggestions?: LintError.Fix[];
 }
-/** 类似Node */
+/**
+ * Node-like
+ *
+ * 类似Node
+ */
 export interface AstNode {
     readonly childNodes: readonly AstNode[];
-    /** 节点类型 */
+    /**
+     * node type
+     *
+     * 节点类型
+     */
     type: string;
     toString(...args: unknown[]): string;
     /** Linter */
     lint(): LintError[];
 }
-/** 所有节点的基类 */
+/**
+ * base class for all tokens
+ *
+ * 所有节点的基类
+ */
 interface Token extends AstNode {
     readonly name?: string;
     /**
+     * Get all descendants that match the selector
+     *
      * 符合选择器的所有后代节点
      * @param selector 选择器
      */
@@ -101,108 +115,151 @@ export type CompletionItem = Omit<CompletionItemBase, 'kind'> & {
     kind: keyof typeof CompletionItemKind;
 };
 export interface LanguageService {
-    /** 销毁实例 */
+    /**
+     * Destroy the instance
+     *
+     * 销毁实例
+     */
     destroy(): void;
     /**
+     * Provide color decorators
+     *
      * 提供颜色指示
-     * @param rgba 颜色解析函数
-     * @param text 源代码
-     * @param hsl 是否允许HSL颜色
+     * @param rgba color parser / 颜色解析函数
+     * @param text source Wikitext / 源代码
+     * @param hsl whether HSL colors are treated / 是否允许HSL颜色
      */
     provideDocumentColors(rgba: (s: string) => [number, number, number, number] | [], text: string, hsl?: boolean): Promise<ColorInformation[]>;
     /**
+     * Provide color pickers
+     *
      * 颜色选择器
-     * @param color 颜色信息
+     * @param color color information / 颜色信息
      */
     provideColorPresentations(color: ColorInformation): ColorPresentation[];
     /**
+     * Provide auto-completion
+     *
      * 提供自动补全
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     provideCompletionItems(text: string, position: Position): Promise<CompletionItem[] | undefined>;
     /**
+     * Provide grammar check
+     *
      * 提供语法检查
-     * @param wikitext 源代码
+     * @param text source Wikitext / 源代码
+     * @param warning whether to include warnings / 是否包含警告
      */
-    provideDiagnostics(wikitext: string, warning?: boolean): Promise<Diagnostic[]>;
+    provideDiagnostics(text: string, warning?: boolean): Promise<Diagnostic[]>;
     /**
+     * Provide folding ranges
+     *
      * 提供折叠范围
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     provideFoldingRanges(text: string): Promise<FoldingRange[]>;
     /**
+     * Provide links
+     *
      * 提供链接
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     provideLinks(text: string): Promise<DocumentLink[]>;
     /**
+     * Provide references
+     *
      * 提供引用
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     provideReferences(text: string, position: Position): Promise<Omit<Location, 'uri'>[] | undefined>;
     /**
+     * Provide definitions
+     *
      * 提供定义
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     provideDefinition(text: string, position: Position): Promise<Omit<Location, 'uri'>[] | undefined>;
     /**
+     * Provide locations for renaming
+     *
      * 提供变量更名准备
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     resolveRenameLocation(text: string, position: Position): Promise<Range | undefined>;
     /**
+     * Provide rename edits
+     *
      * 变量更名
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
-     * @param newName 新名称
+     * @param newName new name / 新名称
      */
     provideRenameEdits(text: string, position: Position, newName: string): Promise<WorkspaceEdit | undefined>;
     /**
+     * Provide hover information
+     *
      * 提供悬停信息
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     provideHover(text: string, position: Position): Promise<Hover | undefined>;
     /**
+     * Provide signature help for magic words
+     *
      * 提供魔术字帮助
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     provideSignatureHelp(text: string, position: Position): Promise<SignatureHelp | undefined>;
     /**
+     * Provide CodeLens
+     *
      * 提供 CodeLens
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     provideInlayHints(text: string): Promise<InlayHint[]>;
     /**
+     * Provide quick fixes
+     *
      * 提供快速修复建议
-     * @param diagnostics 语法诊断信息
+     * @param diagnostics grammar diagnostics / 语法诊断信息
      */
     provideCodeAction(diagnostics: Diagnostic[]): CodeAction[];
     /**
+     * Provide document sections
+     *
      * 提供章节
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     provideDocumentSymbols(text: string): Promise<DocumentSymbol[]>;
 }
 export interface Parser {
     config: Config | string;
     i18n: Record<string, string> | string | undefined;
-    /** 获取当前的解析设置 */
+    /**
+     * Get the current parser configuration
+     *
+     * 获取当前的解析设置
+     */
     getConfig(): Config;
     /**
+     * Parse wikitext
+     *
      * 解析wikitext
-     * @param include 是否嵌入
-     * @param maxStage 最大解析层级
+     * @param include whether to be transcluded / 是否嵌入
+     * @param maxStage max stage for parsing / 最大解析层级
      */
     parse(wikitext: string, include?: boolean, maxStage?: number | Stage | Stage[], config?: Config): Token;
     /**
+     * Create a language server
+     *
      * 创建语言服务
-     * @param uri 文档标识
+     * @param uri document URI / 文档标识
      */
     createLanguageService(uri: object): LanguageService;
 }

package/dist/bin/cli.js

@@ -16,7 +16,8 @@ Available options:
 -s, --strict                            Exit when there is an error or warning
                                         Override -q or --quiet
 -v, --version                           Print package version
-`, preset = new Set((0, fs_1.readdirSync)('./config').filter(file => file.endsWith('.json')).map(file => file.slice(0, -5))), { argv } = process, files = [];
+`, preset = new Set((0, fs_1.readdirSync)('./config').filter(file => file.endsWith('.json'))
+    .map(file => file.slice(0, -5))), { argv } = process, files = [];
 let include = false, quiet = false, strict = false, exit = false, fixing = false, nErr = 0, nWarn = 0, nFixableErr = 0, nFixableWarn = 0, option, config, lang;
 /**
  * throw if `-c` or `--config` option is incorrect

package/dist/index.d.ts

@@ -5,16 +5,20 @@ import type { Token } from './internal';
 declare interface Parser extends ParserBase {
     rules: readonly LintError.Rule[];
     /**
+     * Normalize page title
+     *
      * 规范化页面标题
-     * @param title 标题（含或不含命名空间前缀）
-     * @param defaultNs 命名空间
-     * @param include 是否嵌入
+     * @param title title (with or without the namespace prefix) / 标题（含或不含命名空间前缀）
+     * @param defaultNs default namespace number / 命名空间
+     * @param include whether to be transcluded / 是否嵌入
      */
     normalizeTitle(title: string, defaultNs?: number, include?: boolean, config?: Config): Title;
     parse(wikitext: string, include?: boolean, maxStage?: number | Stage | Stage[], config?: Config): Token;
     /**
+     * Create a language server
+     *
      * 创建语言服务
-     * @param uri 文档标识
+     * @param uri document URI / 文档标识
      */
     createLanguageService(uri: object): LanguageService;
 }

package/dist/index.js

@@ -1,24 +1,30 @@
 "use strict";
 /* eslint n/exports-style: 0 */
-const fs = require("fs");
-const path = require("path");
 const base_1 = require("./base");
 const debug_1 = require("./util/debug");
 const constants_1 = require("./util/constants");
 const string_1 = require("./util/string");
+/* NOT FOR BROWSER ONLY */
+const fs = require("fs");
+const path = require("path");
 const diff_1 = require("./util/diff");
+/* NOT FOR BROWSER ONLY */
 /**
  * 从根路径require
  * @param file 文件名
  * @param dir 子路径
  */
-const rootRequire = (file, dir) => require(path.isAbsolute(file) ? /* istanbul ignore next */ file : path.join('..', file.includes('/') ? '' : dir, file));
+const rootRequire = (file, dir) => require(path.isAbsolute(file)
+    ? /* istanbul ignore next */ file
+    : path.join('..', file.includes('/') ? '' : dir, file));
+/* NOT FOR BROWSER ONLY END */
 const Parser = {
     config: 'default',
     i18n: undefined,
     rules: base_1.rules,
     /** @implements */
     getConfig() {
+        /* NOT FOR BROWSER ONLY */
         if (typeof this.config === 'string') {
             this.config = rootRequire(this.config, 'config');
             /* istanbul ignore if */
@@ -27,6 +33,7 @@ const Parser = {
             }
             return this.getConfig();
         }
+        /* NOT FOR BROWSER ONLY END */
         const { doubleUnderscore } = this.config;
         for (let i = 0; i < 2; i++) {
             if (doubleUnderscore.length > i + 2 && doubleUnderscore[i].length === 0) {
@@ -40,18 +47,20 @@ const Parser = {
     },
     /** @implements */
     msg(msg, arg = '') {
+        /* NOT FOR BROWSER ONLY */
         if (typeof this.i18n === 'string') {
             this.i18n = rootRequire(this.i18n, 'i18n');
             return this.msg(msg, arg);
         }
+        /* NOT FOR BROWSER ONLY END */
         return msg && (this.i18n?.[msg] ?? msg).replace('$1', this.msg(arg));
     },
     /** @implements */
-    normalizeTitle(title, defaultNs = 0, include, config = Parser.getConfig(), halfParsed, decode = false, selfLink = false) {
+    normalizeTitle(title, defaultNs = 0, include, config = Parser.getConfig(), temporary = false, halfParsed, decode = false, selfLink = false) {
         const { Title } = require('./lib/title');
         let titleObj;
         if (halfParsed) {
-            titleObj = new Title(title, defaultNs, config, decode, selfLink);
+            titleObj = new Title(title, defaultNs, config, temporary, decode, selfLink);
         }
         else {
             const { Token } = require('./src/index');
@@ -59,7 +68,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, decode, selfLink);
+                const t = new Title(root.toString(), defaultNs, config, temporary, decode, selfLink);
                 for (const key of ['main', 'fragment']) {
                     const str = t[key];
                     if (str?.includes('\0')) {
@@ -90,6 +99,7 @@ const Parser = {
             token.type = 'root';
             try {
                 return token.parse(maxStage, include);
+                /* NOT FOR BROWSER ONLY */
             }
             catch (e) /* istanbul ignore next */ {
                 if (e instanceof Error) {
@@ -105,16 +115,50 @@ const Parser = {
                 }
                 throw e;
             }
+            /* NOT FOR BROWSER ONLY END */
         });
         return root;
     },
     /** @implements */
+    async partialParse(wikitext, watch, include, config = Parser.getConfig()) {
+        const { Token } = require('./src/index');
+        const set = typeof setImmediate === 'function' ? setImmediate : /* istanbul ignore next */ setTimeout, { running } = debug_1.Shadow;
+        debug_1.Shadow.running = true;
+        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);
+        });
+        debug_1.Shadow.running = running;
+        return token;
+    },
+    /** @implements */
     createLanguageService(uri) {
-        let mod;
-        // eslint-disable-next-line no-unused-labels
-        LSP: mod = require('./lib/lsp');
-        const { LanguageService, tasks } = mod;
-        return tasks.get(uri) ?? new LanguageService(uri);
+        LSP: { // eslint-disable-line no-unused-labels
+            const mod = require('./lib/lsp');
+            const { LanguageService, tasks } = mod;
+            return tasks.get(uri) ?? new LanguageService(uri);
+        }
     },
 };
 const def = {