codemirror-languageserver 1.18.1 → 1.20.0

package/dist/jsonrpc.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Interface for sending and receiving JSON-RPC messages.
+ *
+ * Implement this to use a custom communication channel (e.g. Web Workers,
+ * MessagePort, or HTTP). See {@link WebSocketTransport} for a reference
+ * implementation.
+ */
+export interface Transport {
+    send(message: string): void;
+    onMessage(callback: (message: string) => void): void;
+    onClose(callback: () => void): void;
+    onError(callback: (error: Error) => void): void;
+    close(): void;
+}
+/** A {@link Transport} that communicates over a browser-native WebSocket. */
+export declare class WebSocketTransport implements Transport {
+    connection: WebSocket;
+    constructor(uri: string);
+    send(message: string): void;
+    onMessage(callback: (message: string) => void): void;
+    onClose(callback: () => void): void;
+    onError(callback: (error: Error) => void): void;
+    close(): void;
+}
+export declare class JSONRPCClient {
+    private transport;
+    private nextId;
+    private pending;
+    private notificationHandlers;
+    private ready;
+    constructor(transport: Transport);
+    request(req: {
+        method: string;
+        params: any;
+    }, timeout: number): Promise<any>;
+    notify(notification: {
+        method: string;
+        params: any;
+    }): Promise<void>;
+    onNotification(handler: (data: any) => void): void;
+    close(): void;
+}

package/dist/plugin.d.ts

@@ -1,8 +1,8 @@
 import { EditorView, Tooltip, ViewPlugin } from '@codemirror/view';
+import type { Transport } from './jsonrpc';
 import { CompletionTriggerKind } from 'vscode-languageserver-protocol';
 import type { CompletionContext, CompletionResult } from '@codemirror/autocomplete';
 import type { PluginValue, ViewUpdate } from '@codemirror/view';
-import { Transport } from '@open-rpc/client-js/build/transports/Transport';
 import type { PublishDiagnosticsParams } from 'vscode-languageserver-protocol';
 import type * as LSP from 'vscode-languageserver-protocol';
 interface LSPRequestMap {
@@ -24,6 +24,26 @@ interface LSPRequestMap {
         LSP.TypeDefinitionParams,
         LSP.Location | LSP.Location[] | LSP.LocationLink[] | null
     ];
+    'textDocument/documentHighlight': [
+        LSP.DocumentHighlightParams,
+        LSP.DocumentHighlight[] | null
+    ];
+    'textDocument/formatting': [
+        LSP.DocumentFormattingParams,
+        LSP.TextEdit[] | null
+    ];
+    'textDocument/rangeFormatting': [
+        LSP.DocumentRangeFormattingParams,
+        LSP.TextEdit[] | null
+    ];
+    'textDocument/prepareRename': [
+        LSP.PrepareRenameParams,
+        LSP.Range | {
+            range: LSP.Range;
+            placeholder: string;
+        } | null
+    ];
+    'textDocument/rename': [LSP.RenameParams, LSP.WorkspaceEdit | null];
     'completionItem/resolve': [LSP.CompletionItem, LSP.CompletionItem];
 }
 interface LSPNotifyMap {
@@ -47,15 +67,22 @@ interface LanguageServerClientLocationMethods {
     textDocumentDeclaration(params: LSP.DeclarationParams): LSP.Location | LSP.Location[] | LSP.LocationLink[] | null;
     textDocumentTypeDefinition(params: LSP.TypeDefinitionParams): LSP.Location | LSP.Location[] | LSP.LocationLink[] | null;
 }
+/**
+ * Manages the JSON-RPC connection to a language server.
+ *
+ * Handles initialization, request/response routing, and notification dispatch.
+ * Can be shared across multiple editor instances via the `client` option.
+ */
 export declare class LanguageServerClient<InitializationOptions = unknown> {
+    /** Whether the server has finished initializing. */
     ready: boolean;
+    /** The server's capabilities, available after initialization. */
     capabilities: LSP.ServerCapabilities<any>;
     initializePromise: Promise<void>;
     private rootUri;
     private workspaceFolders;
     private autoClose?;
     private transport;
-    private requestManager;
     private client;
     private plugins;
     private options;
@@ -63,32 +90,45 @@ export declare class LanguageServerClient<InitializationOptions = unknown> {
     protected getInitializeParams(): LSP.InitializeParams;
     initialize(): Promise<void>;
     close(): void;
-    textDocumentDidOpen(params: LSP.DidOpenTextDocumentParams): Promise<LSP.DidOpenTextDocumentParams>;
-    textDocumentDidChange(params: LSP.DidChangeTextDocumentParams): Promise<LSP.DidChangeTextDocumentParams>;
+    textDocumentDidOpen(params: LSP.DidOpenTextDocumentParams): Promise<void>;
+    textDocumentDidChange(params: LSP.DidChangeTextDocumentParams): Promise<void>;
     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[]>;
+    textDocumentDocumentHighlight(params: LSP.DocumentHighlightParams): Promise<LSP.DocumentHighlight[]>;
+    textDocumentFormatting(params: LSP.DocumentFormattingParams): Promise<LSP.TextEdit[]>;
+    textDocumentRangeFormatting(params: LSP.DocumentRangeFormattingParams): Promise<LSP.TextEdit[]>;
+    textDocumentPrepareRename(params: LSP.PrepareRenameParams): Promise<LSP.Range | {
+        range: LSP.Range;
+        placeholder: string;
+    }>;
+    textDocumentRename(params: LSP.RenameParams): Promise<LSP.WorkspaceEdit>;
     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 notify<K extends keyof LSPNotifyMap>(method: K, params: LSPNotifyMap[K]): Promise<void>;
     protected processNotification(notification: Notification): void;
 }
+/** Controls how document changes are sent to the language server. */
 export declare enum SynchronizationMethod {
+    /** Send the full document text on every change. */
     Full = "full",
+    /** Send only the changed ranges. More efficient for large documents. */
     Incremental = "incremental"
 }
 export declare class LanguageServerPlugin implements PluginValue {
     private view;
     client: LanguageServerClient;
-    private documentUri;
+    documentUri: string;
     private languageId;
     private documentVersion;
     private allowHTMLContent;
     private synchronizationMethod;
+    private changesTimeout;
+    private pendingChanges;
     constructor(view: EditorView, { client, documentUri, languageId, allowHTMLContent, synchronizationMethod, }: {
         client: LanguageServerClient;
         documentUri: string;
@@ -152,15 +192,28 @@ export declare const languageServerPlugin: ViewPlugin<LanguageServerPlugin, {
     allowHTMLContent: boolean;
     synchronizationMethod: SynchronizationMethod;
 }>;
+/** Base options shared by all language server configurations. */
 export interface LanguageServerBaseOptions {
+    /** Root URI of the workspace (e.g. `'file:///'`). */
     rootUri: string | null;
+    /** LSP workspace folders, if applicable. */
     workspaceFolders: LSP.WorkspaceFolder[] | null;
+    /** URI of the document being edited (e.g. `'file:///main.cpp'`). */
     documentUri: string;
+    /** Language identifier as defined by the LSP specification. */
     languageId: string;
 }
+/** Options for creating a {@link LanguageServerClient}. */
 export interface LanguageServerClientOptions<InitializationOptions = unknown> extends LanguageServerBaseOptions {
+    /** The transport used to communicate with the language server. */
     transport: Transport;
+    /** Close the transport when the last plugin detaches. */
     autoClose?: boolean;
+    /** Server-specific initialization options. */
     initializationOptions?: InitializationOptions;
+    /** Locale for the LSP session (e.g. `'en'`). Sent in the `initialize` request. */
+    locale?: string;
+    /** Called once after initialization with the server's capabilities. */
+    onCapabilities?: (capabilities: LSP.ServerCapabilities) => void;
 }
 export {};

package/dist/rename.d.ts

@@ -0,0 +1,10 @@
+import { StateField } from '@codemirror/state';
+import { EditorView } from '@codemirror/view';
+/**
+ * Command: open a rename prompt for the symbol at the cursor.
+ *
+ * Uses `textDocument/prepareRename` to pre-fill the current name if supported
+ * by the server. Press Enter to confirm or Escape to cancel.
+ */
+export declare function renameSymbol(view: EditorView): boolean;
+export declare const renameExtension: () => StateField<string>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "codemirror-languageserver",
-    "version": "1.18.1",
+    "version": "1.20.0",
     "description": "Language Server Plugin for CodeMirror 6",
     "main": "dist/index.js",
     "type": "module",
@@ -40,13 +40,14 @@
         "typescript": "^5.9.2"
     },
     "dependencies": {
+        "marked": "^16.1.2",
+        "vscode-languageserver-protocol": "^3.17.5"
+    },
+    "peerDependencies": {
         "@codemirror/autocomplete": "^6.18.6",
         "@codemirror/lint": "^6.8.5",
         "@codemirror/state": "^6.5.2",
-        "@codemirror/view": "^6.38.1",
-        "@open-rpc/client-js": "^1.8.1",
-        "marked": "^16.1.2",
-        "vscode-languageserver-protocol": "^3.17.5"
+        "@codemirror/view": "^6.38.1"
     },
     "prettier": {
         "tabWidth": 4,