wikilint 2.16.3 → 2.16.5

package/dist/lib/element.d.ts

@@ -1,53 +1,99 @@
 import { AstNode } from './node';
 import type { LintError } from '../base';
 import type { AstNodes, Token } from '../internal';
-/** 类似HTMLElement */
+export interface CaretPosition {
+    readonly offsetNode: AstNodes;
+    readonly offset: number;
+}
+/**
+ * HTMLElement-like
+ *
+ * 类似HTMLElement
+ */
 export declare abstract class AstElement extends AstNode {
     #private;
     readonly name?: string;
     readonly data: undefined;
-    /** 子节点总数 */
+    /** number of child nodes / 子节点总数 */
     get length(): number;
     /**
+     * Remove a child node
+     *
      * 移除子节点
-     * @param i 移除位置
+     * @param i position of the child node / 移除位置
      */
     removeAt(i: number): AstNodes;
     /**
+     * Insert a child node
+     *
      * 插入子节点
-     * @param node 待插入的子节点
-     * @param i 插入位置
+     * @param node node to be inserted / 待插入的子节点
+     * @param i position to be inserted at / 插入位置
      */
     insertAt<T extends AstNodes>(node: T, i?: number): T;
     /**
-     * 最近的祖先节点
+     * Get the closest ancestor node that matches the selector
+     *
+     * 最近的符合选择器的祖先节点
      * @param selector 选择器
      */
     closest<T = Token>(selector: string): T | undefined;
     /**
+     * Get the first descendant that matches the selector
+     *
      * 符合选择器的第一个后代节点
      * @param selector 选择器
      */
     querySelector<T = Token>(selector: string): T | undefined;
     /**
+     * Get all descendants that match the selector
+     *
      * 符合选择器的所有后代节点
      * @param selector 选择器
      */
     querySelectorAll<T = Token>(selector: string): T[];
     /**
+     * Insert a batch of child nodes at the end
+     *
      * 在末尾批量插入子节点
-     * @param elements 插入节点
+     * @param elements nodes to be inserted / 插入节点
      */
     append(...elements: (AstNodes | string)[]): void;
     /**
+     * Replace all child nodes
+     *
      * 批量替换子节点
-     * @param elements 新的子节点
+     * @param elements nodes to be inserted / 新的子节点
      */
     replaceChildren(...elements: (AstNodes | string)[]): void;
     /**
+     * Modify the text child node
+     *
      * 修改文本子节点
-     * @param str 新文本
-     * @param i 子节点位置
+     * @param str new text / 新文本
+     * @param i position of the text child node / 子节点位置
      */
     setText(str: string, i?: number): string;
+    /**
+     * Get the caret position from the character index
+     *
+     * 找到给定位置
+     * @param index character index / 位置
+     */
+    caretPositionFromIndex(index?: number): CaretPosition | undefined;
+    /**
+     * Get the closest ancestor element from the character index
+     *
+     * 找到给定位置所在的最内层非文本节点
+     * @param index character index / 位置
+     */
+    elementFromIndex(index?: number): Token | undefined;
+    /**
+     * Get the closest ancestor element from the position
+     *
+     * 找到给定位置所在的最内层非文本节点
+     * @param x column number / 列数
+     * @param y line number / 行数
+     */
+    elementFromPoint(x: number, y: number): Token | undefined;
 }

package/dist/lib/element.js

@@ -5,9 +5,13 @@ const string_1 = require("../util/string");
 const debug_1 = require("../util/debug");
 const selector_1 = require("../parser/selector");
 const node_1 = require("./node");
-/** 类似HTMLElement */
+/**
+ * HTMLElement-like
+ *
+ * 类似HTMLElement
+ */
 class AstElement extends node_1.AstNode {
-    /** 子节点总数 */
+    /** number of child nodes / 子节点总数 */
     get length() {
         return this.childNodes.length;
     }
@@ -17,7 +21,7 @@ class AstElement extends node_1.AstNode {
     }
     /** @private */
     normalize() {
-        const childNodes = [...this.childNodes];
+        const childNodes = this.getChildNodes();
         /**
          * 移除子节点
          * @param i 移除位置
@@ -39,23 +43,29 @@ class AstElement extends node_1.AstNode {
         this.setAttribute('childNodes', childNodes);
     }
     /**
+     * Remove a child node
+     *
      * 移除子节点
-     * @param i 移除位置
+     * @param i position of the child node / 移除位置
      */
     removeAt(i) {
         return (0, debug_1.setChildNodes)(this, i, 1)[0];
     }
     /**
+     * Insert a child node
+     *
      * 插入子节点
-     * @param node 待插入的子节点
-     * @param i 插入位置
+     * @param node node to be inserted / 待插入的子节点
+     * @param i position to be inserted at / 插入位置
      */
     insertAt(node, i = this.length) {
         (0, debug_1.setChildNodes)(this, i, 0, [node]);
         return node;
     }
     /**
-     * 最近的祖先节点
+     * Get the closest ancestor node that matches the selector
+     *
+     * 最近的符合选择器的祖先节点
      * @param selector 选择器
      */
     closest(selector) {
@@ -89,6 +99,8 @@ class AstElement extends node_1.AstNode {
         return undefined;
     }
     /**
+     * Get the first descendant that matches the selector
+     *
      * 符合选择器的第一个后代节点
      * @param selector 选择器
      */
@@ -114,6 +126,8 @@ class AstElement extends node_1.AstNode {
         return descendants;
     }
     /**
+     * Get all descendants that match the selector
+     *
      * 符合选择器的所有后代节点
      * @param selector 选择器
      */
@@ -122,8 +136,10 @@ class AstElement extends node_1.AstNode {
         return this.#getElementsBy(condition);
     }
     /**
+     * Insert a batch of child nodes at the end
+     *
      * 在末尾批量插入子节点
-     * @param elements 插入节点
+     * @param elements nodes to be inserted / 插入节点
      */
     append(...elements) {
         for (const element of elements) {
@@ -131,8 +147,10 @@ class AstElement extends node_1.AstNode {
         }
     }
     /**
+     * Replace all child nodes
+     *
      * 批量替换子节点
-     * @param elements 新的子节点
+     * @param elements nodes to be inserted / 新的子节点
      */
     replaceChildren(...elements) {
         for (let i = this.length - 1; i >= 0; i--) {
@@ -141,9 +159,11 @@ class AstElement extends node_1.AstNode {
         this.append(...elements);
     }
     /**
+     * Modify the text child node
+     *
      * 修改文本子节点
-     * @param str 新文本
-     * @param i 子节点位置
+     * @param str new text / 新文本
+     * @param i position of the text child node / 子节点位置
      */
     setText(str, i = 0) {
         i += i < 0 ? this.length : 0;
@@ -156,11 +176,77 @@ class AstElement extends node_1.AstNode {
     toString(skip, separator = '') {
         return this.childNodes.map(child => child.toString(skip)).join(separator);
     }
+    /**
+     * Get the caret position from the character index
+     *
+     * 找到给定位置
+     * @param index character index / 位置
+     */
+    caretPositionFromIndex(index) {
+        LSP: { // eslint-disable-line no-unused-labels
+            if (index === undefined) {
+                return undefined;
+            }
+            const { length } = this.toString();
+            if (index > length || index < -length) {
+                return undefined;
+            }
+            index += index < 0 ? length : 0;
+            let self = this, acc = 0, start = 0;
+            while (self.type !== 'text') {
+                const { childNodes } = self;
+                acc += self.getAttribute('padding');
+                for (let i = 0; acc <= index && i < childNodes.length; i++) {
+                    const cur = childNodes[i], { nextSibling } = cur, str = cur.toString(), l = str.length;
+                    acc += l;
+                    // 优先选择靠前的非文本兄弟节点，但永不进入假节点
+                    if (acc > index
+                        || acc === index && l > 0 && (!nextSibling
+                            || nextSibling.type === 'text'
+                            || cur.type !== 'text' && (str.trim() || !nextSibling.toString().trim()))) {
+                        self = cur;
+                        acc -= l;
+                        start = acc;
+                        break;
+                    }
+                    acc += self.getGaps(i);
+                }
+                if (self.childNodes === childNodes) {
+                    return { offsetNode: self, offset: index - start };
+                }
+            }
+            return { offsetNode: self, offset: index - start };
+        }
+    }
+    /**
+     * Get the closest ancestor element from the character index
+     *
+     * 找到给定位置所在的最内层非文本节点
+     * @param index character index / 位置
+     */
+    elementFromIndex(index) {
+        LSP: { // eslint-disable-line no-unused-labels
+            const node = this.caretPositionFromIndex(index)?.offsetNode;
+            return node?.type === 'text' ? node.parentNode : node;
+        }
+    }
+    /**
+     * Get the closest ancestor element from the position
+     *
+     * 找到给定位置所在的最内层非文本节点
+     * @param x column number / 列数
+     * @param y line number / 行数
+     */
+    elementFromPoint(x, y) {
+        // eslint-disable-next-line no-unused-labels
+        LSP: return this.elementFromIndex(this.indexFromPos(y, x));
+    }
     /** @private */
     lint(start = this.getAbsoluteIndex(), re) {
         const errors = [];
         for (let i = 0, cur = start + this.getAttribute('padding'); i < this.length; i++) {
             const child = this.childNodes[i];
+            child.setAttribute('aIndex', cur);
             errors.push(...child.lint(cur, re));
             cur += child.toString().length + this.getGaps(i);
         }

package/dist/lib/lsp.d.ts

@@ -1,13 +1,13 @@
 import Parser from '../index';
-import type { Range, Position, ColorInformation, ColorPresentation, FoldingRange, DocumentSymbol, DocumentLink, Location, WorkspaceEdit, Diagnostic as DiagnosticBase, TextEdit, Hover, SignatureHelp, InlayHint, CodeAction } from 'vscode-languageserver-types';
+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';
+declare interface Diagnostic extends DiagnosticBase {
+    data: QuickFixData[];
+}
 declare interface QuickFixData extends TextEdit {
     title: string;
     fix: boolean;
 }
-declare interface Diagnostic extends DiagnosticBase {
-    data: QuickFixData[];
-}
 export declare const tasks: WeakMap<object, Parser.LanguageService>;
 /** VSCode-style language service */
 export declare class LanguageService implements LanguageServiceBase {
@@ -17,84 +17,119 @@ export declare class LanguageService implements LanguageServiceBase {
     /** @implements */
     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[]>;
-    /** @implements */
-    provideColorPresentations(// eslint-disable-line @typescript-eslint/class-methods-use-this
-    { color: { red, green, blue, alpha }, range }: ColorInformation): ColorPresentation[];
     /**
+     * Provide color pickers
+     *
+     * 颜色选择器
+     * @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>;
     /**
-     * 提供语法诊断
-     * @param wikitext 源代码
-     * @param warning 是否提供警告
+     * Provide grammar check
+     *
+     * 提供语法检查
+     * @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[]>;
-    /** @implements */
+    /**
+     * Provide quick fixes
+     *
+     * 提供快速修复建议
+     * @param diagnostics grammar diagnostics / 语法诊断信息
+     */
     provideCodeAction(diagnostics: Diagnostic[]): CodeAction[];
     /**
+     * Provide document sections
+     *
      * 提供章节
-     * @param text 源代码
+     * @param text source Wikitext / 源代码
      */
     provideDocumentSymbols(text: string): Promise<DocumentSymbol[]>;
 }