codemirror-languageserver 1.20.0 → 1.22.0

package/README.md

@@ -4,7 +4,7 @@
 
 This plugin connects a [CodeMirror 6](https://codemirror.net/) editor with a [Language Server](https://microsoft.github.io/language-server-protocol/) over WebSocket, providing IDE-like features in the browser.
 
-[How It Works](https://hjr265.me/blog/codemirror-lsp/)
+[How It Works](https://hjr265.me/blog/codemirror-lsp/) | [Live Demo](https://furqansoftware.github.io/codemirror-languageserver/)
 
 ## Features
 
@@ -67,6 +67,28 @@ This sets up all built-in features: completion, hover, diagnostics, go-to-defini
 | `synchronizationMethod` | `SynchronizationMethod` | `'full'` or `'incremental'` document sync (default: `'full'`) |
 | `client` | `LanguageServerClient` | Share a client across multiple editor instances |
 | `onCapabilities` | `(capabilities) => void` | Called when server capabilities are available |
+| `onError` | `(error: Error) => void` | Called when the connection encounters an error |
+| `onClose` | `() => void` | Called when the connection is closed |
+
+## Error Handling
+
+The plugin does not crash on connection failures. Use `onError` and `onClose` to handle disconnections:
+
+```js
+languageServer({
+    serverUri: 'ws://localhost:8080',
+    rootUri: 'file:///',
+    documentUri: `file:///${filename}`,
+    languageId: 'cpp',
+    onError(error) {
+        console.error('LSP error:', error);
+    },
+    onClose() {
+        console.log('LSP connection closed');
+        // Recreate the editor extensions to reconnect
+    },
+})
+```
 
 ## Shared Client
 

package/dist/index.js

@@ -35,8 +35,10 @@ class JSONRPCClient {
         this.nextId = 0;
         this.pending = new Map();
         this.notificationHandlers = [];
+        this.errorHandlers = [];
+        this.closeHandlers = [];
         this.transport = transport;
-        this.ready = new Promise((resolve, reject) => {
+        this.ready = new Promise((resolve) => {
             if (transport instanceof WebSocketTransport) {
                 const ws = transport.connection;
                 if (ws.readyState === WebSocket.OPEN) {
@@ -44,13 +46,27 @@ class JSONRPCClient {
                 }
                 else {
                     ws.addEventListener('open', () => resolve());
-                    ws.addEventListener('error', () => reject(new Error('WebSocket connection failed')));
                 }
             }
             else {
                 resolve();
             }
         });
+        transport.onError((error) => {
+            for (const handler of this.errorHandlers) {
+                handler(error);
+            }
+        });
+        transport.onClose(() => {
+            for (const [, pending] of this.pending) {
+                clearTimeout(pending.timer);
+                pending.reject(new Error('Connection closed'));
+            }
+            this.pending.clear();
+            for (const handler of this.closeHandlers) {
+                handler();
+            }
+        });
         transport.onMessage((raw) => {
             let msg;
             try {
@@ -107,6 +123,12 @@ class JSONRPCClient {
     onNotification(handler) {
         this.notificationHandlers.push(handler);
     }
+    onError(handler) {
+        this.errorHandlers.push(handler);
+    }
+    onClose(handler) {
+        this.closeHandlers.push(handler);
+    }
     close() {
         for (const [id, pending] of this.pending) {
             clearTimeout(pending.timer);
@@ -157,7 +179,6 @@ function changeSetToEvents(doc, changes) {
 }
 
 const timeout = 10000;
-const changesDelay = 500;
 const CompletionItemKindMap = Object.fromEntries(Object.entries(CompletionItemKind).map(([key, value]) => [value, key]));
 const useLast = (values) => values.reduce((_, v) => v, '');
 Facet.define({
@@ -192,7 +213,19 @@ class LanguageServerClient {
             }
             this.processNotification(data);
         });
-        this.initializePromise = this.initialize();
+        this.client.onError((error) => {
+            var _a, _b;
+            (_b = (_a = this.options).onError) === null || _b === void 0 ? void 0 : _b.call(_a, error);
+        });
+        this.client.onClose(() => {
+            var _a, _b;
+            this.ready = false;
+            (_b = (_a = this.options).onClose) === null || _b === void 0 ? void 0 : _b.call(_a);
+        });
+        this.initializePromise = this.initialize().catch((error) => {
+            var _a, _b;
+            (_b = (_a = this.options).onError) === null || _b === void 0 ? void 0 : _b.call(_a, error);
+        });
     }
     getInitializeParams() {
         var _a;
@@ -359,8 +392,6 @@ var SynchronizationMethod;
 class LanguageServerPlugin {
     constructor(view, { client, documentUri, languageId, allowHTMLContent, synchronizationMethod, }) {
         this.view = view;
-        this.changesTimeout = null;
-        this.pendingChanges = null;
         this.client = client;
         this.documentUri = documentUri;
         this.languageId = languageId;
@@ -377,40 +408,20 @@ class LanguageServerPlugin {
         if (!docChanged) {
             return;
         }
-        if (this.changesTimeout) {
-            clearTimeout(this.changesTimeout);
-        }
         switch (this.synchronizationMethod) {
             case SynchronizationMethod.Full:
-                this.pendingChanges = [
+                this.sendChanges([
                     {
                         text: this.view.state.doc.toString(),
                     },
-                ];
+                ]);
                 break;
             case SynchronizationMethod.Incremental:
-                if (!this.pendingChanges) {
-                    this.pendingChanges = [];
-                }
-                this.pendingChanges.push(...changeSetToEvents(startState.doc, changes));
+                this.sendChanges(changeSetToEvents(startState.doc, changes));
                 break;
         }
-        this.changesTimeout = setTimeout(() => {
-            this.changesTimeout = null;
-            if (this.pendingChanges) {
-                this.sendChanges(this.pendingChanges);
-                this.pendingChanges = null;
-            }
-        }, changesDelay);
     }
     destroy() {
-        if (this.changesTimeout) {
-            clearTimeout(this.changesTimeout);
-            if (this.pendingChanges) {
-                this.sendChanges(this.pendingChanges);
-                this.pendingChanges = null;
-            }
-        }
         this.client.detachPlugin(this);
     }
     async initialize({ documentText }) {

package/dist/jsonrpc.d.ts

@@ -27,6 +27,8 @@ export declare class JSONRPCClient {
     private nextId;
     private pending;
     private notificationHandlers;
+    private errorHandlers;
+    private closeHandlers;
     private ready;
     constructor(transport: Transport);
     request(req: {
@@ -38,5 +40,7 @@ export declare class JSONRPCClient {
         params: any;
     }): Promise<void>;
     onNotification(handler: (data: any) => void): void;
+    onError(handler: (error: Error) => void): void;
+    onClose(handler: () => void): void;
     close(): void;
 }

package/dist/plugin.d.ts

@@ -127,8 +127,6 @@ export declare class LanguageServerPlugin implements PluginValue {
     private documentVersion;
     private allowHTMLContent;
     private synchronizationMethod;
-    private changesTimeout;
-    private pendingChanges;
     constructor(view: EditorView, { client, documentUri, languageId, allowHTMLContent, synchronizationMethod, }: {
         client: LanguageServerClient;
         documentUri: string;
@@ -215,5 +213,9 @@ export interface LanguageServerClientOptions<InitializationOptions = unknown> ex
     locale?: string;
     /** Called once after initialization with the server's capabilities. */
     onCapabilities?: (capabilities: LSP.ServerCapabilities) => void;
+    /** Called when the connection encounters an error. */
+    onError?: (error: Error) => void;
+    /** Called when the connection is closed. */
+    onClose?: () => void;
 }
 export {};