wikiparser-node 1.16.4 → 1.16.5

package/dist/lib/lsp.js

@@ -213,23 +213,18 @@ class LanguageService {
      * - 总是返回最新的解析结果
      */
     async #parse() {
-        return new Promise(resolve => {
-            (typeof setImmediate === 'function' ? setImmediate : /* istanbul ignore next */ setTimeout)(() => {
-                const config = index_1.default.getConfig();
-                this.#config = index_1.default.config;
-                const text = this.#text, root = index_1.default.parse(text, true, undefined, config);
-                if (this.#text === text && this.#config === index_1.default.config) {
-                    this.#done = root;
-                    this.#running = undefined;
-                    resolve(root);
-                    return;
-                }
-                /* istanbul ignore next */
-                this.#running = this.#parse();
-                /* istanbul ignore next */
-                resolve(this.#running);
-            }, 0);
-        });
+        const config = index_1.default.getConfig();
+        this.#config = index_1.default.config;
+        const text = this.#text, root = await index_1.default.partialParse(text, () => this.#text, true, config);
+        if (this.#text === text && this.#config === index_1.default.config) {
+            this.#done = root;
+            this.#running = undefined;
+            return root;
+        }
+        /* istanbul ignore next */
+        this.#running = this.#parse();
+        /* istanbul ignore next */
+        return this.#running;
     }
     /**
      * 检查是否为签名语言服务器
@@ -242,10 +237,12 @@ class LanguageService {
         }
     }
     /**
+     * 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颜色
      */
     async provideDocumentColors(rgba, text, hsl = true) {
         this.#checkSignature();
@@ -277,10 +274,15 @@ class LanguageService {
             });
         });
     }
-    /** @implements */
-    provideColorPresentations(// eslint-disable-line @typescript-eslint/class-methods-use-this
-    { color: { red, green, blue, alpha }, range }) {
-        const newText = `#${(0, common_1.numToHex)(red)}${(0, common_1.numToHex)(green)}${(0, common_1.numToHex)(blue)}${alpha < 1 ? (0, common_1.numToHex)(alpha) : ''}`;
+    /**
+     * Provide color pickers
+     *
+     * 颜色选择器
+     * @param color color information / 颜色信息
+     */
+    // eslint-disable-next-line @typescript-eslint/class-methods-use-this
+    provideColorPresentations(color) {
+        const { color: { red, green, blue, alpha }, range } = color, newText = `#${(0, common_1.numToHex)(red)}${(0, common_1.numToHex)(green)}${(0, common_1.numToHex)(blue)}${alpha < 1 ? (0, common_1.numToHex)(alpha) : ''}`;
         return [
             {
                 label: newText,
@@ -327,8 +329,10 @@ class LanguageService {
         return this.#completionConfig;
     }
     /**
+     * Provide auto-completion
+     *
      * 提供自动补全
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     async provideCompletionItems(text, position) {
@@ -386,7 +390,8 @@ class LanguageService {
             return [
                 ...getCompletion(params, 'Property', match, position)
                     .filter(({ label }) => !equal || !/[= ]$/u.test(label)),
-                ...getCompletion(root.querySelectorAll('image-parameter#width').filter(token => token !== cur)
+                ...getCompletion(root.querySelectorAll('image-parameter#width')
+                    .filter(token => token !== cur)
                     .map(width => width.text()), 'Unit', match, position),
             ];
         }
@@ -412,20 +417,20 @@ class LanguageService {
         }
         else if (type === 'parameter-key' || type === 'parameter-value' && parentNode.anon) {
             // parameter key
-            const transclusion = parentNode.parentNode;
-            if (transclusion.type === 'magic-word' && transclusion.name !== 'invoke') {
+            const transclusion = parentNode.parentNode, { type: t, name: n } = transclusion;
+            if (t === 'magic-word' && n !== 'invoke') {
                 return undefined;
             }
-            const key = cur.toString().trimStart(), [module, func] = transclusion.type === 'magic-word' ? transclusion.getModule() : [];
+            const key = cur.toString().trimStart(), [module, func] = t === 'magic-word' ? transclusion.getModule() : [];
             return key
                 ? getCompletion(root.querySelectorAll('parameter').filter(token => {
                     if (token === parentNode
                         || token.anon
-                        || token.parentNode.type !== transclusion.type
-                        || token.parentNode.name !== transclusion.name) {
+                        || token.parentNode.type !== t
+                        || token.parentNode.name !== n) {
                         return false;
                     }
-                    else if (transclusion.type === 'template') {
+                    else if (t === 'template') {
                         return true;
                     }
                     const [m, f] = token.parentNode.getModule();
@@ -436,13 +441,15 @@ class LanguageService {
         return undefined;
     }
     /**
-     * 提供语法诊断
-     * @param wikitext 源代码
-     * @param warning 是否提供警告
+     * Provide grammar check
+     *
+     * 提供语法检查
+     * @param text source Wikitext / 源代码
+     * @param warning whether to include warnings / 是否包含警告
      */
-    async provideDiagnostics(wikitext, warning = true) {
+    async provideDiagnostics(text, warning = true) {
         this.#checkSignature();
-        const root = await this.#queue(wikitext), errors = root.lint();
+        const root = await this.#queue(text), errors = root.lint();
         return (warning ? errors : errors.filter(({ severity }) => severity === 'error'))
             .map(({ startLine, startCol, endLine, endCol, severity, rule, message, fix, suggestions }) => ({
             range: {
@@ -461,8 +468,10 @@ class LanguageService {
         }));
     }
     /**
+     * Provide folding ranges
+     *
      * 提供折叠范围
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     async provideFoldingRanges(text) {
         this.#checkSignature();
@@ -507,8 +516,10 @@ class LanguageService {
         return ranges;
     }
     /**
+     * Provide links
+     *
      * 提供链接
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     async provideLinks(text) {
         this.#checkSignature();
@@ -559,7 +570,8 @@ class LanguageService {
                     else if (type === 'invoke-module') {
                         ns = 828;
                     }
-                    const title = index_1.default.normalizeTitle(target, ns);
+                    const title = index_1.default
+                        .normalizeTitle(target, ns, false, undefined, true);
                     /* istanbul ignore if */
                     if (!title.valid) {
                         return false;
@@ -588,8 +600,10 @@ class LanguageService {
         }).filter(Boolean);
     }
     /**
+     * Provide references
+     *
      * 提供引用
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     async provideReferences(text, position) {
@@ -608,15 +622,17 @@ class LanguageService {
         return refs.length === 0 ? undefined : refs;
     }
     /**
+     * Provide definitions
+     *
      * 提供定义
-     * @param text 源代码
-     * @param pos 位置
-     * @param pos.line 行号
-     * @param pos.character 列号
+     * @param text source Wikitext / 源代码
+     * @param position 位置
      */
-    async provideDefinition(text, { line, character }) {
+    async provideDefinition(text, position) {
         this.#checkSignature();
-        const root = await this.#queue(text), node = root.elementFromPoint(character, line), ext = node.is('ext') && node.name === 'ref' ? node : node.closest('ext#ref'), refName = getRefTagAttr(ext, 'name');
+        const root = await this.#queue(text), node = root.elementFromPoint(position.character, position.line), ext = node.is('ext') && node.name === 'ref'
+            ? node
+            : node.closest('ext#ref'), refName = getRefTagAttr(ext, 'name');
         if (!refName) {
             return undefined;
         }
@@ -628,15 +644,15 @@ class LanguageService {
         return refs.length === 0 ? undefined : refs;
     }
     /**
+     * Provide locations for renaming
+     *
      * 提供变量更名准备
-     * @param text 源代码
-     * @param pos 位置
-     * @param pos.line 行号
-     * @param pos.character 列号
+     * @param text source Wikitext / 源代码
+     * @param position 位置
      */
-    async resolveRenameLocation(text, { line, character }) {
+    async resolveRenameLocation(text, position) {
         this.#checkSignature();
-        const root = await this.#queue(text), node = root.elementFromPoint(character, line), { type } = node, refName = getRefName(node), refGroup = getRefGroup(node);
+        const root = await this.#queue(text), node = root.elementFromPoint(position.character, position.line), { type } = node, refName = getRefName(node), refGroup = getRefGroup(node);
         return !refName && !refGroup && (!renameTypes.has(type)
             || type === 'parameter-key' && /^[1-9]\d*$/u.test(node.parentNode.name)
             || type === 'link-target' && !['link', 'redirect-target'].includes(node.parentNode.type))
@@ -644,16 +660,16 @@ class LanguageService {
             : createNodeRange(node);
     }
     /**
+     * Provide rename edits
+     *
      * 变量更名
-     * @param text 源代码
-     * @param pos 位置
-     * @param pos.line 行号
-     * @param pos.character 列号
-     * @param newName 新名称
+     * @param text source Wikitext / 源代码
+     * @param position 位置
+     * @param newName new name / 新名称
      */
-    async provideRenameEdits(text, { line, character }, newName) {
+    async provideRenameEdits(text, position, newName) {
         this.#checkSignature();
-        const root = await this.#queue(text), node = root.elementFromPoint(character, line), { type } = node, refName = getRefName(node), refNameGroup = refName && getRefTagAttr(node.parentNode.parentNode, 'group'), refGroup = getRefGroup(node), name = getName(node), refs = root.querySelectorAll(type).filter(token => {
+        const root = await this.#queue(text), node = root.elementFromPoint(position.character, position.line), { type } = node, refName = getRefName(node), refNameGroup = refName && getRefTagAttr(node.parentNode.parentNode, 'group'), refGroup = getRefGroup(node), name = getName(node), refs = root.querySelectorAll(type).filter(token => {
             const { type: t } = token.parentNode;
             if (type === 'link-target' && t !== 'link' && t !== 'redirect-target') {
                 return false;
@@ -680,11 +696,14 @@ class LanguageService {
      * @param name 函数名
      */
     #getParserFunction(name) {
-        return this.data.parserFunctions.find(({ aliases }) => aliases.some(alias => alias.replace(/^#/u, '') === name));
+        return this.data.parserFunctions
+            .find(({ aliases }) => aliases.some(alias => alias.replace(/^#/u, '') === name));
     }
     /**
+     * Provide hover information
+     *
      * 提供悬停信息
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     async provideHover(text, position) {
@@ -695,17 +714,15 @@ class LanguageService {
         this.#checkSignature();
         const root = await this.#queue(text), { offsetNode, offset } = caretPositionFromWord(root, position), token = offsetNode.type === 'text' ? offsetNode.parentNode : offsetNode, { type, parentNode, length, name } = token;
         let info, f, range;
-        if (token.is('double-underscore')) {
-            if (offset === 0 && token.getBoundingClientRect().left > position.character) {
-                return undefined;
-            }
+        if (token.is('double-underscore') && offset > 0) {
             info = this.data.behaviorSwitches.find(({ aliases }) => aliases.includes(token.innerText.toLowerCase()));
         }
         else if (type === 'magic-word-name') {
             info = this.#getParserFunction(parentNode.name);
             f = token.toString(true).trim();
         }
-        else if (token.is('magic-word') && length === 1 && !token.modifier) {
+        else if (token.is('magic-word') && !token.modifier && length === 1
+            && (offset > 0 || token.getBoundingClientRect().left === position.character)) {
             info = this.#getParserFunction(name);
             f = token.firstChild.toString(true).trim();
         }
@@ -733,8 +750,10 @@ class LanguageService {
         };
     }
     /**
+     * Provide signature help for magic words
+     *
      * 提供魔术字帮助
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      * @param position 位置
      */
     async provideSignatureHelp(text, position) {
@@ -784,8 +803,10 @@ class LanguageService {
         };
     }
     /**
+     * Provide CodeLens
+     *
      * 提供 CodeLens
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     async provideInlayHints(text) {
         this.#checkSignature();
@@ -802,7 +823,12 @@ class LanguageService {
         return hints;
     }
     /* NOT FOR BROWSER ONLY */
-    /** @implements */
+    /**
+     * Provide quick fixes
+     *
+     * 提供快速修复建议
+     * @param diagnostics grammar diagnostics / 语法诊断信息
+     */
     // eslint-disable-next-line @typescript-eslint/class-methods-use-this
     provideCodeAction(diagnostics) {
         return diagnostics.flatMap(diagnostic => diagnostic.data.map((data) => ({
@@ -816,8 +842,10 @@ class LanguageService {
         })));
     }
     /**
+     * Provide document sections
+     *
      * 提供章节
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     async provideDocumentSymbols(text) {
         this.#checkSignature();

package/dist/lib/node.d.ts

@@ -1,5 +1,9 @@
 import type { LintError, AstNode as AstNodeBase, TokenTypes } from '../base';
 import type { AstText, Token } from '../internal';
+export interface Font {
+    bold: boolean;
+    italic: boolean;
+}
 export type AstNodes = AstText | Token;
 export interface Dimension {
     readonly height: number;
@@ -13,163 +17,228 @@ export interface CaretPosition {
     readonly offsetNode: AstNodes;
     readonly offset: number;
 }
-/** 类似Node */
+/**
+ * Node-like
+ *
+ * 类似Node
+ */
 export declare abstract class AstNode implements AstNodeBase {
     #private;
     data?: string | undefined;
     readonly childNodes: readonly AstNodes[];
     abstract get type(): TokenTypes | 'text';
     abstract set type(value: TokenTypes | "text");
-    /** 可见部分 */
+    /**
+     * Get the visible text
+     *
+     * 可见部分
+     */
     text(): string;
     lint(): LintError[];
     print(): string;
-    /** 首位子节点 */
+    /** first child node / 首位子节点 */
     get firstChild(): AstNodes | undefined;
-    /** 末位子节点 */
+    /** last child node / 末位子节点 */
     get lastChild(): AstNodes | undefined;
-    /** 父节点 */
+    /** parent node / 父节点 */
     get parentNode(): Token | undefined;
-    /** 后一个兄弟节点 */
+    /** next sibling node / 后一个兄弟节点 */
     get nextSibling(): AstNodes | undefined;
-    /** 前一个兄弟节点 */
+    /** previous sibling node / 前一个兄弟节点 */
     get previousSibling(): AstNodes | undefined;
-    /** 行数 */
+    /** number of lines / 行数 */
     get offsetHeight(): number;
-    /** 最后一行的列数 */
+    /** number of columns of the last line / 最后一行的列数 */
     get offsetWidth(): number;
-    /** 后一个非文本兄弟节点 */
+    /** next sibling element / 后一个非文本兄弟节点 */
     get nextElementSibling(): Token | undefined;
-    /** 前一个非文本兄弟节点 */
+    /** previous sibling element / 前一个非文本兄弟节点 */
     get previousElementSibling(): Token | undefined;
-    /** 后一个可见的兄弟节点 */
+    /** next visibling sibling node / 后一个可见的兄弟节点 */
     get nextVisibleSibling(): AstNodes | undefined;
-    /** 前一个可见的兄弟节点 */
+    /** previous visible sibling node / 前一个可见的兄弟节点 */
     get previousVisibleSibling(): AstNodes | undefined;
-    /** 是否具有根节点 */
+    /** whether to be connected to a root token / 是否具有根节点 */
     get isConnected(): boolean;
-    /** 后方是否还有其他节点（不含后代） */
+    /** whether to be the end of a document / 后方是否还有其他节点（不含后代） */
     get eof(): boolean | undefined;
-    /** 相对于父容器的行号 */
+    /** line number relative to its parent / 相对于父容器的行号 */
     get offsetTop(): number;
-    /** 相对于父容器的列号 */
+    /** column number of the last line relative to its parent / 相对于父容器的列号 */
     get offsetLeft(): number;
-    /** 位置、大小和padding */
+    /** position, dimension and paddings / 位置、大小和padding */
     get style(): Position & Dimension & {
         padding: number;
     };
-    /** 字体样式 */
-    get font(): {
-        bold: boolean;
-        italic: boolean;
-    };
-    /** 是否粗体 */
+    /** font weigth and style / 字体样式 */
+    get font(): Font;
+    /** whether to be bold / 是否粗体 */
     get bold(): boolean;
-    /** 是否斜体 */
+    /** whether to be italic / 是否斜体 */
     get italic(): boolean;
     constructor();
-    /** 获取根节点 */
+    /**
+     * Get the root node
+     *
+     * 获取根节点
+     */
     getRootNode(): Token | this;
     /**
+     * Convert the position to the character index
+     *
      * 将行列号转换为字符位置
-     * @param top 行号
-     * @param left 列号
+     * @param top line number / 行号
+     * @param left column number / 列号
      */
     indexFromPos(top: number, left: number): number | undefined;
     /**
+     * Convert the character indenx to the position
+     *
      * 将字符位置转换为行列号
-     * @param index 字符位置
+     * @param index character index / 字符位置
      */
     posFromIndex(index: number): Position | undefined;
     /**
+     * Get the relative character index of the current node, or its `j`-th child node
+     *
      * 获取当前节点的相对字符位置，或其第`j`个子节点的相对字符位置
-     * @param j 子节点序号
+     * @param j rank of the child node / 子节点序号
      */
     getRelativeIndex(j?: number): number;
-    /** 获取当前节点的绝对位置 */
+    /**
+     * Get the absolute character index of the current node
+     *
+     * 获取当前节点的绝对位置
+     */
     getAbsoluteIndex(): number;
-    /** 获取当前节点的行列位置和大小 */
+    /**
+     * Get the position and dimension of the current node
+     *
+     * 获取当前节点的行列位置和大小
+     */
     getBoundingClientRect(): Dimension & Position;
     /**
+     * Whether to be of a certain type
+     *
      * 是否是某种类型的节点
-     * @param type 节点类型
+     * @param type token type / 节点类型
      */
     is<T extends Token>(type: TokenTypes): this is T;
-    /** 获取所有行的wikitext和起止位置 */
+    /**
+     * Get the text and the start/end positions of all lines
+     *
+     * 获取所有行的wikitext和起止位置
+     */
     getLines(): [string, number, number][];
     /**
+     * Check if the node is identical
+     *
      * 是否是全同节点
-     * @param node 待比较的节点
+     * @param node node to be compared to / 待比较的节点
      * @throws `assert.AssertionError`
      */
     isEqualNode(node: AstNode): boolean;
     /**
+     * Insert a batch of sibling nodes after the current node
+     *
      * 在后方批量插入兄弟节点
-     * @param nodes 插入节点
+     * @param nodes nodes to be inserted / 插入节点
      */
     after(...nodes: (AstNodes | string)[]): void;
     /**
+     * Insert a batch of sibling nodes before the current node
+     *
      * 在前方批量插入兄弟节点
-     * @param nodes 插入节点
+     * @param nodes nodes to be inserted / 插入节点
      */
     before(...nodes: (AstNodes | string)[]): void;
-    /** 移除当前节点 */
+    /**
+     * Remove the current node
+     *
+     * 移除当前节点
+     */
     remove(): void;
     /**
+     * Replace the current node with new nodes
+     *
      * 将当前节点批量替换为新的节点
-     * @param nodes 插入节点
+     * @param nodes nodes to be inserted / 插入节点
      */
     replaceWith(...nodes: (AstNodes | string)[]): void;
     /**
+     * Check if the node is a descendant
+     *
      * 是自身或后代节点
-     * @param node 待检测节点
+     * @param node node to be compared to / 待检测节点
      */
     contains(node: AstNode): boolean;
     /**
+     * Add an event listener
+     *
      * 添加事件监听
-     * @param types 事件类型
-     * @param listener 监听函数
+     * @param types event type / 事件类型
+     * @param listener listener function / 监听函数
      * @param options 选项
-     * @param options.once 仅执行一次
+     * @param options.once to be executed only once / 仅执行一次
      */
     addEventListener(types: string | string[], listener: (...args: any[]) => void, options?: {
         once?: boolean;
     }): void;
     /**
+     * Remove an event listener
+     *
      * 移除事件监听
-     * @param types 事件类型
-     * @param listener 监听函数
+     * @param types event type / 事件类型
+     * @param listener listener function / 监听函数
      */
     removeEventListener(types: string | string[], listener: (...args: any[]) => void): void;
     /**
+     * Remove all event listeners
+     *
      * 移除事件的所有监听
-     * @param types 事件类型
+     * @param types event type / 事件类型
      */
     removeAllEventListeners(types: string | string[]): void;
     /**
+     * List all event listeners
+     *
      * 列举事件监听
-     * @param type 事件类型
+     * @param type event type / 事件类型
      */
     listEventListeners(type: string): Function[];
     /**
+     * Dispatch an event
+     *
      * 触发事件
-     * @param e 事件对象
-     * @param data 事件数据
+     * @param e event object / 事件对象
+     * @param data event data / 事件数据
      */
     dispatchEvent(e: Event, data: unknown): void;
-    /** 获取所有祖先节点 */
+    /**
+     * Get all the ancestor nodes
+     *
+     * 获取所有祖先节点
+     */
     getAncestors(): Token[];
     /**
+     * Compare the relative position with another node
+     *
      * 比较和另一个节点的相对位置
-     * @param other 待比较的节点
+     * @param other node to be compared with / 待比较的节点
      * @throws `RangeError` 不在同一个语法树
      */
     compareDocumentPosition(other: AstNodes): number;
-    /** 销毁 */
+    /**
+     * Destroy the instance
+     *
+     * 销毁
+     */
     destroy(): void;
     /**
+     * Get the wikitext of a line
+     *
      * 获取某一行的wikitext
-     * @param n 行号
+     * @param n line number / 行号
      */
     getLine(n: number): string | undefined;
 }