wikiparser-node 1.16.0 → 1.16.1

package/dist/base.d.mts

@@ -1,4 +1,4 @@
-import type { Range, Position, ColorInformation, ColorPresentation, CompletionItem, FoldingRange, DocumentSymbol, DocumentLink, Location, WorkspaceEdit } from 'vscode-languageserver-types';
+import type { Range, Position, ColorInformation, ColorPresentation, CompletionItem as CompletionItemBase, CompletionItemKind, FoldingRange, DocumentLink, Location, WorkspaceEdit, Diagnostic, Hover, DocumentSymbol, CodeAction, SignatureHelp } from 'vscode-languageserver-types';
 export interface Config {
     ext: string[];
     readonly html: [string[], string[], string[]];
@@ -96,7 +96,26 @@ interface Token extends AstNode {
     /** 保存为JSON */
     json(): AST;
 }
+interface SignatureParameter {
+    label: string;
+    const?: boolean;
+    rest?: boolean;
+}
+export interface SignatureInfo {
+    aliases: string[];
+    description: string;
+    signatures?: SignatureParameter[][];
+}
+export interface SignatureData {
+    behaviorSwitches: SignatureInfo[];
+    parserFunctions: SignatureInfo[];
+}
+export type CompletionItem = Omit<CompletionItemBase, 'kind'> & {
+    kind: keyof typeof CompletionItemKind;
+};
 export interface LanguageService {
+    /** 销毁实例 */
+    destroy(): void;
     /**
      * 提供颜色指示
      * @param rgba 颜色解析函数
@@ -106,10 +125,9 @@ export interface LanguageService {
     provideDocumentColors(rgba: (s: string) => [number, number, number, number] | [], text: string, hsl?: boolean): Promise<ColorInformation[]>;
     /**
      * 颜色选择器
-     * @ignore
+     * @param color 颜色信息
      */
-    provideColorPresentations(// eslint-disable-line @typescript-eslint/class-methods-use-this
-    { color: { red, green, blue, alpha }, range }: ColorInformation): ColorPresentation[];
+    provideColorPresentations(color: ColorInformation): ColorPresentation[];
     /**
      * 提供自动补全
      * @param text 源代码
@@ -117,15 +135,15 @@ export interface LanguageService {
      */
     provideCompletionItems(text: string, position: Position): Promise<CompletionItem[] | undefined>;
     /**
-     * 提供折叠范围
-     * @param text 源代码
+     * 提供语法检查
+     * @param wikitext 源代码
      */
-    provideFoldingRanges(text: string): Promise<FoldingRange[]>;
+    provideDiagnostics(wikitext: string): Promise<Diagnostic[]>;
     /**
-     * 提供章节
+     * 提供折叠范围
      * @param text 源代码
      */
-    provideDocumentSymbols(text: string): Promise<DocumentSymbol[]>;
+    provideFoldingRanges(text: string): Promise<FoldingRange[]>;
     /**
      * 提供链接
      * @param text 源代码
@@ -156,6 +174,28 @@ export interface LanguageService {
      * @param newName 新名称
      */
     provideRenameEdits(text: string, position: Position, newName: string): Promise<WorkspaceEdit | undefined>;
+    /**
+     * 提供悬停信息
+     * @param text 源代码
+     * @param position 位置
+     */
+    provideHover(text: string, position: Position): Promise<Hover | undefined>;
+    /**
+     * 提供魔术字帮助
+     * @param text 源代码
+     * @param position 位置
+     */
+    provideSignatureHelp(text: string, position: Position): Promise<SignatureHelp | undefined>;
+    /**
+     * 提供快速修复建议
+     * @param diagnostics 语法诊断信息
+     */
+    provideCodeAction(diagnostics: Diagnostic[]): CodeAction[];
+    /**
+     * 提供章节
+     * @param text 源代码
+     */
+    provideDocumentSymbols(text: string): Promise<DocumentSymbol[]>;
 }
 export interface Parser {
     config: Config | string;

package/dist/base.d.ts

@@ -1,4 +1,4 @@
-import type { Range, Position, ColorInformation, ColorPresentation, CompletionItem, FoldingRange, DocumentSymbol, DocumentLink, Location, WorkspaceEdit } from 'vscode-languageserver-types';
+import type { Range, Position, ColorInformation, ColorPresentation, CompletionItem as CompletionItemBase, CompletionItemKind, FoldingRange, DocumentLink, Location, WorkspaceEdit, Diagnostic, Hover, DocumentSymbol, CodeAction, SignatureHelp } from 'vscode-languageserver-types';
 export interface Config {
     ext: string[];
     readonly html: [string[], string[], string[]];
@@ -96,7 +96,26 @@ interface Token extends AstNode {
     /** 保存为JSON */
     json(): AST;
 }
+interface SignatureParameter {
+    label: string;
+    const?: boolean;
+    rest?: boolean;
+}
+export interface SignatureInfo {
+    aliases: string[];
+    description: string;
+    signatures?: SignatureParameter[][];
+}
+export interface SignatureData {
+    behaviorSwitches: SignatureInfo[];
+    parserFunctions: SignatureInfo[];
+}
+export type CompletionItem = Omit<CompletionItemBase, 'kind'> & {
+    kind: keyof typeof CompletionItemKind;
+};
 export interface LanguageService {
+    /** 销毁实例 */
+    destroy(): void;
     /**
      * 提供颜色指示
      * @param rgba 颜色解析函数
@@ -106,10 +125,9 @@ export interface LanguageService {
     provideDocumentColors(rgba: (s: string) => [number, number, number, number] | [], text: string, hsl?: boolean): Promise<ColorInformation[]>;
     /**
      * 颜色选择器
-     * @ignore
+     * @param color 颜色信息
      */
-    provideColorPresentations(// eslint-disable-line @typescript-eslint/class-methods-use-this
-    { color: { red, green, blue, alpha }, range }: ColorInformation): ColorPresentation[];
+    provideColorPresentations(color: ColorInformation): ColorPresentation[];
     /**
      * 提供自动补全
      * @param text 源代码
@@ -117,15 +135,15 @@ export interface LanguageService {
      */
     provideCompletionItems(text: string, position: Position): Promise<CompletionItem[] | undefined>;
     /**
-     * 提供折叠范围
-     * @param text 源代码
+     * 提供语法检查
+     * @param wikitext 源代码
      */
-    provideFoldingRanges(text: string): Promise<FoldingRange[]>;
+    provideDiagnostics(wikitext: string): Promise<Diagnostic[]>;
     /**
-     * 提供章节
+     * 提供折叠范围
      * @param text 源代码
      */
-    provideDocumentSymbols(text: string): Promise<DocumentSymbol[]>;
+    provideFoldingRanges(text: string): Promise<FoldingRange[]>;
     /**
      * 提供链接
      * @param text 源代码
@@ -156,6 +174,28 @@ export interface LanguageService {
      * @param newName 新名称
      */
     provideRenameEdits(text: string, position: Position, newName: string): Promise<WorkspaceEdit | undefined>;
+    /**
+     * 提供悬停信息
+     * @param text 源代码
+     * @param position 位置
+     */
+    provideHover(text: string, position: Position): Promise<Hover | undefined>;
+    /**
+     * 提供魔术字帮助
+     * @param text 源代码
+     * @param position 位置
+     */
+    provideSignatureHelp(text: string, position: Position): Promise<SignatureHelp | undefined>;
+    /**
+     * 提供快速修复建议
+     * @param diagnostics 语法诊断信息
+     */
+    provideCodeAction(diagnostics: Diagnostic[]): CodeAction[];
+    /**
+     * 提供章节
+     * @param text 源代码
+     */
+    provideDocumentSymbols(text: string): Promise<DocumentSymbol[]>;
 }
 export interface Parser {
     config: Config | string;

package/dist/index.d.ts

@@ -34,6 +34,6 @@ declare const Parser: Parser;
 // @ts-expect-error mixed export styles
 export = Parser;
 export default Parser;
-export type { Config, LintError, TokenTypes, AST, };
+export type { Config, LintError, TokenTypes, LanguageService, AST, };
 export type * from './internal';
 declare global { type Acceptable = unknown; }

package/dist/lib/lsp.d.ts

@@ -1,11 +1,14 @@
-import type { Range, Position, ColorInformation, ColorPresentation, CompletionItem, FoldingRange, DocumentSymbol, DocumentLink, Location, WorkspaceEdit } from 'vscode-languageserver-types';
-import type { LanguageService as LanguageServiceBase } from '../base';
-export declare const tasks: WeakMap<object, LanguageService>;
+import Parser from '../index';
+import type { Range, Position, ColorInformation, ColorPresentation, FoldingRange, DocumentSymbol, DocumentLink, Location, WorkspaceEdit, Diagnostic, Hover, CodeAction, SignatureHelp } from 'vscode-languageserver-types';
+import type { LanguageService as LanguageServiceBase, CompletionItem, SignatureData } from '../base';
+export declare const tasks: WeakMap<object, Parser.LanguageService>;
 /** VSCode-style language service */
 export declare class LanguageService implements LanguageServiceBase {
     #private;
     /** @param uri 任务标识 */
     constructor(uri: object);
+    /** @implements */
+    destroy(): void;
     /**
      * 提供颜色指示
      * @param rgba 颜色解析函数
@@ -13,10 +16,7 @@ export declare class LanguageService implements LanguageServiceBase {
      * @param hsl 是否允许HSL颜色
      */
     provideDocumentColors(rgba: (s: string) => [number, number, number, number] | [], text: string, hsl?: boolean): Promise<ColorInformation[]>;
-    /**
-     * 颜色选择器
-     * @ignore
-     */
+    /** @implements */
     provideColorPresentations(// eslint-disable-line @typescript-eslint/class-methods-use-this
     { color: { red, green, blue, alpha }, range }: ColorInformation): ColorPresentation[];
     /**
@@ -26,15 +26,15 @@ export declare class LanguageService implements LanguageServiceBase {
      */
     provideCompletionItems(text: string, position: Position): Promise<CompletionItem[] | undefined>;
     /**
-     * 提供折叠范围
-     * @param text 源代码
+     * 提供语法诊断
+     * @param wikitext 源代码
      */
-    provideFoldingRanges(text: string): Promise<FoldingRange[]>;
+    provideDiagnostics(wikitext: string): Promise<Diagnostic[]>;
     /**
-     * 提供章节
+     * 提供折叠范围
      * @param text 源代码
      */
-    provideDocumentSymbols(text: string): Promise<DocumentSymbol[]>;
+    provideFoldingRanges(text: string): Promise<FoldingRange[]>;
     /**
      * 提供链接
      * @param text 源代码
@@ -65,4 +65,23 @@ export declare class LanguageService implements LanguageServiceBase {
      * @param newName 新名称
      */
     provideRenameEdits(text: string, position: Position, newName: string): Promise<WorkspaceEdit | undefined>;
+    /**
+     * 提供悬停信息
+     * @param text 源代码
+     * @param position 位置
+     */
+    provideHover(text: string, position: Position): Promise<Hover | undefined>;
+    /**
+     * 提供魔术字帮助
+     * @param text 源代码
+     * @param position 位置
+     */
+    provideSignatureHelp(text: string, position: Position): Promise<SignatureHelp | undefined>;
+    /** @implements */
+    provideCodeAction(diagnostics: Diagnostic[]): CodeAction[];
+    /**
+     * 提供章节
+     * @param text 源代码
+     */
+    provideDocumentSymbols(text: string): Promise<DocumentSymbol[]>;
 }