codemirror-languageserver 1.15.0 → 1.17.0

package/dist/plugin.d.ts

@@ -16,6 +16,15 @@ interface LSPRequestMap {
         LSP.DefinitionParams,
         LSP.Location | LSP.Location[] | LSP.LocationLink[] | null
     ];
+    'textDocument/declaration': [
+        LSP.DeclarationParams,
+        LSP.Location | LSP.Location[] | LSP.LocationLink[] | null
+    ];
+    'textDocument/typeDefinition': [
+        LSP.TypeDefinitionParams,
+        LSP.Location | LSP.Location[] | LSP.LocationLink[] | null
+    ];
+    'completionItem/resolve': [LSP.CompletionItem, LSP.CompletionItem];
 }
 interface LSPNotifyMap {
     initialized: LSP.InitializedParams;
@@ -33,6 +42,11 @@ type Notification = {
         params: LSPEventMap[key];
     };
 }[keyof LSPEventMap];
+interface LanguageServerClientLocationMethods {
+    textDocumentDefinition(params: LSP.DefinitionParams): LSP.Location | LSP.Location[] | LSP.LocationLink[] | null;
+    textDocumentDeclaration(params: LSP.DeclarationParams): LSP.Location | LSP.Location[] | LSP.LocationLink[] | null;
+    textDocumentTypeDefinition(params: LSP.TypeDefinitionParams): LSP.Location | LSP.Location[] | LSP.LocationLink[] | null;
+}
 export declare class LanguageServerClient<InitializationOptions = unknown> {
     ready: boolean;
     capabilities: LSP.ServerCapabilities<any>;
@@ -54,21 +68,29 @@ export declare class LanguageServerClient<InitializationOptions = unknown> {
     textDocumentHover(params: LSP.HoverParams): Promise<LSP.Hover>;
     textDocumentCompletion(params: LSP.CompletionParams): Promise<LSP.CompletionList | LSP.CompletionItem[]>;
     textDocumentDefinition(params: LSP.DefinitionParams): Promise<LSP.Location | LSP.Location[] | LSP.LocationLink[]>;
+    textDocumentDeclaration(params: LSP.DeclarationParams): Promise<LSP.Location | LSP.Location[] | LSP.LocationLink[]>;
+    textDocumentTypeDefinition(params: LSP.TypeDefinitionParams): Promise<LSP.Location | LSP.Location[] | LSP.LocationLink[]>;
+    completionItemResolve(params: LSP.CompletionItem): Promise<LSP.CompletionItem>;
     attachPlugin(plugin: LanguageServerPlugin): void;
     detachPlugin(plugin: LanguageServerPlugin): void;
     protected request<K extends keyof LSPRequestMap>(method: K, params: LSPRequestMap[K][0], timeout: number): Promise<LSPRequestMap[K][1]>;
     protected notify<K extends keyof LSPNotifyMap>(method: K, params: LSPNotifyMap[K]): Promise<LSPNotifyMap[K]>;
     protected processNotification(notification: Notification): void;
 }
-declare class LanguageServerPlugin implements PluginValue {
+export declare class LanguageServerPlugin implements PluginValue {
     private view;
-    private allowHTMLContent;
     client: LanguageServerClient;
     private documentUri;
     private languageId;
     private documentVersion;
+    private allowHTMLContent;
     private changesTimeout;
-    constructor(view: EditorView, allowHTMLContent: boolean);
+    constructor(view: EditorView, { client, documentUri, languageId, allowHTMLContent, }: {
+        client: LanguageServerClient;
+        documentUri: string;
+        languageId: string;
+        allowHTMLContent: boolean;
+    });
     update({ docChanged }: ViewUpdate): void;
     destroy(): void;
     initialize({ documentText }: {
@@ -89,6 +111,13 @@ declare class LanguageServerPlugin implements PluginValue {
         triggerKind: CompletionTriggerKind;
         triggerCharacter: string | undefined;
     }): Promise<CompletionResult | null>;
+    requestLocation(view: EditorView, { line, character }: {
+        line: number;
+        character: number;
+    }, capability: keyof LSP.ServerCapabilities<any>, method: keyof LanguageServerClientLocationMethods): Promise<{
+        uri: string;
+        range: LSP.Range;
+    }>;
     requestDefinition(view: EditorView, { line, character }: {
         line: number;
         character: number;
@@ -96,312 +125,38 @@ declare class LanguageServerPlugin implements PluginValue {
         uri: string;
         range: LSP.Range;
     }>;
+    requestDeclaration(view: EditorView, { line, character }: {
+        line: number;
+        character: number;
+    }): Promise<{
+        uri: string;
+        range: LSP.Range;
+    }>;
+    requestTypeDefinition(view: EditorView, { line, character }: {
+        line: number;
+        character: number;
+    }): Promise<{
+        uri: string;
+        range: LSP.Range;
+    }>;
     processNotification(notification: Notification): void;
     processDiagnostics(params: PublishDiagnosticsParams): void;
 }
-export declare const languageServerPlugin: ViewPlugin<LanguageServerPlugin, boolean>;
-interface LanguageServerBaseOptions {
+export declare const languageServerPlugin: ViewPlugin<LanguageServerPlugin, {
+    client: LanguageServerClient;
+    documentUri: string;
+    languageId: string;
+    allowHTMLContent: boolean;
+}>;
+export interface LanguageServerBaseOptions {
     rootUri: string | null;
     workspaceFolders: LSP.WorkspaceFolder[] | null;
     documentUri: string;
     languageId: string;
 }
-interface LanguageServerClientOptions<InitializationOptions = unknown> extends LanguageServerBaseOptions {
+export interface LanguageServerClientOptions<InitializationOptions = unknown> extends LanguageServerBaseOptions {
     transport: Transport;
     autoClose?: boolean;
     initializationOptions?: InitializationOptions;
 }
-interface LanguageServerOptions<InitializationOptions = unknown> extends LanguageServerClientOptions<InitializationOptions> {
-    client?: LanguageServerClient<InitializationOptions>;
-    allowHTMLContent?: boolean;
-}
-interface LanguageServerWebsocketOptions<InitializationOptions = unknown> extends LanguageServerBaseOptions {
-    serverUri: `ws://${string}` | `wss://${string}`;
-    initializationOptions?: InitializationOptions;
-}
-export declare function languageServer<InitializationOptions = unknown>(options: LanguageServerWebsocketOptions<InitializationOptions>): ({
-    extension: import("@codemirror/state").Extension;
-} | readonly import("@codemirror/state").Extension[])[];
-export declare function languageServerWithTransport<InitializationOptions = unknown>(options: LanguageServerOptions<InitializationOptions>): ({
-    extension: import("@codemirror/state").Extension;
-} | readonly import("@codemirror/state").Extension[])[];
-/**
- * Initialization options for Pyright language server
- * @see https://github.com/microsoft/pyright/blob/main/docs/settings.md
- */
-export interface PyrightInitializationOptions {
-    python?: {
-        pythonPath?: string;
-        venvPath?: string;
-        analysis?: {
-            autoSearchPaths?: boolean;
-            extraPaths?: string[];
-            diagnosticMode?: 'workspace' | 'openFilesOnly';
-            stubPath?: string;
-            typeshedPaths?: string[];
-            useLibraryCodeForTypes?: boolean;
-            typeCheckingMode?: 'off' | 'basic' | 'strict';
-            autoImportCompletions?: boolean;
-            indexing?: boolean;
-        };
-    };
-    reportMissingImports?: boolean;
-    reportMissingTypeStubs?: boolean;
-    reportMissingModuleSource?: boolean;
-    reportInvalidTypeVarUse?: boolean;
-    reportOptionalSubscript?: boolean;
-    reportOptionalMemberAccess?: boolean;
-    reportOptionalCall?: boolean;
-    reportOptionalIterable?: boolean;
-    reportOptionalContextManager?: boolean;
-    reportOptionalOperand?: boolean;
-    reportTypedDictNotRequiredAccess?: boolean;
-    reportPrivateImportUsage?: boolean;
-    reportConstantRedefinition?: boolean;
-    reportIncompatibleMethodOverride?: boolean;
-    reportIncompatibleVariableOverride?: boolean;
-    reportInconsistentConstructor?: boolean;
-}
-/**
- * Initialization options for Rust Analyzer language server
- * @see https://rust-analyzer.github.io/manual.html#configuration
- */
-export interface RustAnalyzerInitializationOptions {
-    cargo?: {
-        buildScripts?: {
-            enable?: boolean;
-            invocationStrategy?: 'per_workspace' | 'once';
-            invocationLocation?: 'workspace' | 'root';
-        };
-        allTargets?: boolean;
-        noDefaultFeatures?: boolean;
-        allFeatures?: boolean;
-        features?: string[];
-        target?: string;
-        runBuildScripts?: boolean;
-        useRustcWrapperForBuildScripts?: boolean;
-    };
-    procMacro?: {
-        enable?: boolean;
-        ignored?: Record<string, string[]>;
-        server?: string;
-        attributes?: {
-            enable?: boolean;
-        };
-    };
-    diagnostics?: {
-        enable?: boolean;
-        disabled?: string[];
-        warningsAsHint?: string[];
-        warningsAsInfo?: string[];
-        remapPrefix?: Record<string, string>;
-        experimental?: {
-            enable?: boolean;
-        };
-    };
-    completion?: {
-        addCallArgumentSnippets?: boolean;
-        addCallParenthesis?: boolean;
-        postfix?: {
-            enable?: boolean;
-        };
-        autoimport?: {
-            enable?: boolean;
-        };
-        privateEditable?: {
-            enable?: boolean;
-        };
-    };
-    assist?: {
-        importGranularity?: 'preserve' | 'crate' | 'module' | 'item';
-        importEnforceGranularity?: boolean;
-        importPrefix?: 'plain' | 'by_self' | 'by_crate';
-        allowMergingIntoGlobImports?: boolean;
-    };
-    callInfo?: {
-        full?: boolean;
-    };
-    lens?: {
-        enable?: boolean;
-        run?: boolean;
-        debug?: boolean;
-        implementations?: boolean;
-        refs?: boolean;
-        methodReferences?: boolean;
-        references?: boolean;
-        enumVariantReferences?: boolean;
-    };
-    hover?: {
-        documentation?: boolean;
-        keywords?: boolean;
-        linksInHover?: boolean;
-        memoryLayout?: {
-            enable?: boolean;
-        };
-    };
-    workspace?: {
-        symbol?: {
-            search?: {
-                scope?: 'workspace' | 'workspace_and_dependencies';
-                kind?: 'only_types' | 'all_symbols';
-            };
-        };
-    };
-}
-/**
- * Initialization options for TypeScript/JavaScript language server
- * @see https://github.com/typescript-language-server/typescript-language-server
- */
-export interface TypeScriptInitializationOptions {
-    hostInfo?: string;
-    npmLocation?: string;
-    globalPlugins?: string[];
-    pluginProbeLocations?: string[];
-    preferences?: {
-        includePackageJsonAutoImports?: 'auto' | 'on' | 'off';
-        providePrefixAndSuffixTextForRename?: boolean;
-        allowRenameOfImportPath?: boolean;
-        includeAutomaticOptionalChainCompletions?: boolean;
-        includeCompletionsForModuleExports?: boolean;
-        includeCompletionsForImportStatements?: boolean;
-        includeCompletionsWithSnippetText?: boolean;
-        includeCompletionsWithInsertText?: boolean;
-        allowIncompleteCompletions?: boolean;
-        importModuleSpecifier?: 'shortest' | 'relative' | 'absolute' | 'auto';
-        importModuleSpecifierEnding?: 'minimal' | 'index' | 'js';
-        allowTextChangesInNewFiles?: boolean;
-        lazyConfiguredProjectsFromExternalProject?: boolean;
-        providePrefixAndSuffixTextForQuickInfo?: boolean;
-        includeInlayParameterNameHints?: 'none' | 'literals' | 'all';
-        includeInlayParameterNameHintsWhenArgumentMatchesName?: boolean;
-        includeInlayFunctionParameterTypeHints?: boolean;
-        includeInlayVariableTypeHints?: boolean;
-        includeInlayVariableTypeHintsWhenTypeMatchesName?: boolean;
-        includeInlayPropertyDeclarationTypeHints?: boolean;
-        includeInlayFunctionLikeReturnTypeHints?: boolean;
-        includeInlayEnumMemberValueHints?: boolean;
-    };
-    locale?: string;
-    maxTsServerMemory?: number;
-    tsserver?: {
-        logLevel?: 'off' | 'terse' | 'normal' | 'requestTime' | 'verbose';
-        logVerbosity?: 'off' | 'terse' | 'normal' | 'requestTime' | 'verbose';
-        trace?: 'off' | 'messages' | 'verbose';
-        useSeparateSyntaxServer?: boolean;
-        enableTracing?: boolean;
-        path?: string;
-    };
-}
-/**
- * Initialization options for ESLint language server
- * @see https://github.com/Microsoft/vscode-eslint
- */
-export interface ESLintInitializationOptions {
-    packageManager?: 'npm' | 'yarn' | 'pnpm';
-    nodePath?: string;
-    options?: Record<string, any>;
-    rules?: Record<string, any>;
-    rulesCustomizations?: Array<{
-        rule: string;
-        severity: 'downgrade' | 'upgrade' | 'info' | 'warn' | 'error' | 'off';
-    }>;
-    run?: 'onType' | 'onSave';
-    problems?: {
-        shortenToSingleLine?: boolean;
-    };
-    codeAction?: {
-        disableRuleComment?: {
-            enable?: boolean;
-            location?: 'separateLine' | 'sameLine';
-        };
-        showDocumentation?: {
-            enable?: boolean;
-        };
-    };
-    codeActionOnSave?: {
-        enable?: boolean;
-        mode?: 'all' | 'problems';
-    };
-    format?: {
-        enable?: boolean;
-    };
-    quiet?: boolean;
-    onIgnoredFiles?: 'off' | 'warn';
-    useESLintClass?: boolean;
-    experimental?: {
-        useFlatConfig?: boolean;
-    };
-    workingDirectory?: {
-        mode?: 'auto' | 'location';
-    };
-}
-/**
- * Initialization options for Clangd language server
- * @see https://clangd.llvm.org/config
- */
-export interface ClangdInitializationOptions {
-    compilationDatabasePath?: string;
-    compilationDatabaseChanges?: Record<string, any>;
-    fallbackFlags?: string[];
-    clangdFileStatus?: boolean;
-    utf8?: boolean;
-    offsetEncoding?: ('utf-8' | 'utf-16' | 'utf-32')[];
-    index?: {
-        background?: 'Build' | 'Skip';
-        threads?: number;
-    };
-    completion?: {
-        detailedLabel?: boolean;
-        allScopes?: boolean;
-    };
-    hover?: {
-        showAKA?: boolean;
-    };
-    inlayHints?: {
-        enabled?: boolean;
-        parameterNames?: boolean;
-        deducedTypes?: boolean;
-        designators?: boolean;
-    };
-    semanticHighlighting?: boolean;
-    diagnostics?: {
-        unusedIncludes?: 'None' | 'Strict';
-        missingIncludes?: 'None' | 'Strict';
-        clangTidy?: boolean;
-        suppressAll?: boolean;
-    };
-}
-/**
- * Initialization options for Gopls (Go language server)
- * @see https://github.com/golang/tools/blob/master/gopls/doc/settings.md
- */
-export interface GoplsInitializationOptions {
-    buildFlags?: string[];
-    env?: Record<string, string>;
-    directoryFilters?: string[];
-    templateExtensions?: string[];
-    memoryMode?: 'DegradeClosed' | 'Normal';
-    gofumpt?: boolean;
-    staticcheck?: boolean;
-    analyses?: Record<string, boolean>;
-    codelenses?: Record<string, boolean>;
-    usePlaceholders?: boolean;
-    completionBudget?: string;
-    diagnosticsDelay?: string;
-    experimentalPostfixCompletions?: boolean;
-    experimentalWorkspaceModule?: boolean;
-    experimentalTemplateSupport?: boolean;
-    semanticTokens?: boolean;
-    noSemanticString?: boolean;
-    noSemanticNumber?: boolean;
-    expandWorkspaceToModule?: boolean;
-    experimentalUseInvalidMetadata?: boolean;
-    hoverKind?: 'FullDocumentation' | 'NoDocumentation' | 'SingleLine' | 'Structured' | 'SynopsisDocumentation';
-    linkTarget?: string;
-    linksInHover?: boolean;
-    importShortcut?: 'Both' | 'Definition' | 'Link';
-    symbolMatcher?: 'CaseInsensitive' | 'CaseSensitive' | 'FastFuzzy' | 'Fuzzy';
-    symbolStyle?: 'Dynamic' | 'Full' | 'Package';
-    verboseOutput?: boolean;
-}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "codemirror-languageserver",
-    "version": "1.15.0",
+    "version": "1.17.0",
     "description": "Language Server Plugin for CodeMirror 6",
     "main": "dist/index.js",
     "type": "module",