codemirror-languageserver 1.17.0 → 1.18.0

package/dist/changes.d.ts

@@ -0,0 +1,3 @@
+import type { Text, ChangeSet } from '@codemirror/state';
+import type * as LSP from 'vscode-languageserver-protocol';
+export declare function changeSetToEvents(doc: Text, changes: ChangeSet): LSP.TextDocumentContentChangeEvent[];

package/dist/index.d.ts

@@ -1,11 +1,12 @@
-export { LanguageServerClient, languageServerPlugin } from './plugin';
+export { LanguageServerClient, languageServerPlugin, SynchronizationMethod, } from './plugin';
 export { jumpToDefinition, jumpToDefinitionPos, jumpToDefinitionKeymap, } from './definition';
 export { PyrightInitializationOptions, RustAnalyzerInitializationOptions, TypeScriptInitializationOptions, ESLintInitializationOptions, ClangdInitializationOptions, GoplsInitializationOptions, } from './initialization';
-import { LanguageServerClient } from './plugin';
+import { LanguageServerClient, SynchronizationMethod } from './plugin';
 import type { LanguageServerClientOptions, LanguageServerBaseOptions } from './plugin';
 interface LanguageServerOptions<InitializationOptions = unknown> extends LanguageServerClientOptions<InitializationOptions> {
     client?: LanguageServerClient<InitializationOptions>;
     allowHTMLContent?: boolean;
+    synchronizationMethod?: SynchronizationMethod;
 }
 interface LanguageServerWebsocketOptions<InitializationOptions = unknown> extends LanguageServerBaseOptions {
     serverUri: `ws://${string}` | `wss://${string}`;

package/dist/index.js

@@ -24,8 +24,28 @@ function offsetToPos(doc, offset) {
     };
 }
 
+function changeSetToEvents(doc, changes) {
+    const events = [];
+    changes.iterChanges((fromA, toA, fromB, toB, inserted) => {
+        events.push({
+            range: {
+                start: offsetToPos(doc, fromA),
+                end: offsetToPos(doc, toA),
+            },
+            text: inserted.toString(),
+        });
+    });
+    events.sort((a, b) => {
+        if (!('range' in a))
+            return 1;
+        if (!('range' in b))
+            return -1;
+        return (posToOffset(doc, b.range.start) - posToOffset(doc, a.range.start));
+    });
+    return events;
+}
+
 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({
@@ -186,32 +206,41 @@ class LanguageServerClient {
         }
     }
 }
+var SynchronizationMethod;
+(function (SynchronizationMethod) {
+    SynchronizationMethod["Full"] = "full";
+    SynchronizationMethod["Incremental"] = "incremental";
+})(SynchronizationMethod || (SynchronizationMethod = {}));
 class LanguageServerPlugin {
-    constructor(view, { client, documentUri, languageId, allowHTMLContent, }) {
+    constructor(view, { client, documentUri, languageId, allowHTMLContent, synchronizationMethod, }) {
         this.view = view;
         this.client = client;
         this.documentUri = documentUri;
         this.languageId = languageId;
         this.allowHTMLContent = allowHTMLContent;
+        this.synchronizationMethod = synchronizationMethod;
         this.documentVersion = 0;
-        this.changesTimeout = 0;
         this.client.attachPlugin(this);
         this.initialize({
             documentText: this.view.state.doc.toString(),
         });
     }
-    update({ docChanged }) {
+    update({ state, changes, startState, docChanged }) {
         if (!docChanged) {
             return;
         }
-        if (this.changesTimeout) {
-            clearTimeout(this.changesTimeout);
+        switch (this.synchronizationMethod) {
+            case SynchronizationMethod.Full:
+                this.sendChanges([
+                    {
+                        text: this.view.state.doc.toString(),
+                    },
+                ]);
+                break;
+            case SynchronizationMethod.Incremental:
+                this.sendChanges(changeSetToEvents(startState.doc, changes));
+                break;
         }
-        this.changesTimeout = self.setTimeout(() => {
-            this.sendChange({
-                documentText: this.view.state.doc.toString(),
-            });
-        }, changesDelay);
     }
     destroy() {
         this.client.detachPlugin(this);
@@ -229,7 +258,7 @@ class LanguageServerPlugin {
             },
         });
     }
-    async sendChange({ documentText }) {
+    async sendChanges(contentChanges) {
         if (!this.client.ready) {
             return;
         }
@@ -239,7 +268,7 @@ class LanguageServerPlugin {
                     uri: this.documentUri,
                     version: this.documentVersion++,
                 },
-                contentChanges: [{ text: documentText }],
+                contentChanges,
             });
         }
         catch (e) {
@@ -247,13 +276,12 @@ class LanguageServerPlugin {
         }
     }
     requestDiagnostics(view) {
-        this.sendChange({ documentText: view.state.doc.toString() });
+        this.sendChanges([{ text: view.state.doc.toString() }]);
     }
     async requestHoverTooltip(view, { line, character }) {
         if (!this.client.ready || !this.client.capabilities.hoverProvider) {
             return null;
         }
-        this.sendChange({ documentText: view.state.doc.toString() });
         const result = await this.client.textDocumentHover({
             textDocument: { uri: this.documentUri },
             position: { line, character },
@@ -291,9 +319,6 @@ class LanguageServerPlugin {
             !this.client.capabilities.completionProvider) {
             return null;
         }
-        this.sendChange({
-            documentText: context.state.doc.toString(),
-        });
         const result = await this.client.textDocumentCompletion({
             textDocument: { uri: this.documentUri },
             position: { line, character },
@@ -622,6 +647,7 @@ function languageServerWithTransport(options) {
             documentUri: options.documentUri,
             languageId: options.languageId,
             allowHTMLContent: options.allowHTMLContent,
+            synchronizationMethod: options.synchronizationMethod,
         }),
         hoverTooltip(),
         autocompletion(),
@@ -630,4 +656,4 @@ function languageServerWithTransport(options) {
     ];
 }
 
-export { LanguageServerClient, jumpToDefinition, jumpToDefinitionKeymap, jumpToDefinitionPos, languageServer, languageServerPlugin, languageServerWithTransport };
+export { LanguageServerClient, SynchronizationMethod, jumpToDefinition, jumpToDefinitionKeymap, jumpToDefinitionPos, languageServer, languageServerPlugin, languageServerWithTransport };

package/dist/plugin.d.ts

@@ -77,6 +77,10 @@ export declare class LanguageServerClient<InitializationOptions = unknown> {
     protected notify<K extends keyof LSPNotifyMap>(method: K, params: LSPNotifyMap[K]): Promise<LSPNotifyMap[K]>;
     protected processNotification(notification: Notification): void;
 }
+export declare enum SynchronizationMethod {
+    Full = "full",
+    Incremental = "incremental"
+}
 export declare class LanguageServerPlugin implements PluginValue {
     private view;
     client: LanguageServerClient;
@@ -84,21 +88,20 @@ export declare class LanguageServerPlugin implements PluginValue {
     private languageId;
     private documentVersion;
     private allowHTMLContent;
-    private changesTimeout;
-    constructor(view: EditorView, { client, documentUri, languageId, allowHTMLContent, }: {
+    private synchronizationMethod;
+    constructor(view: EditorView, { client, documentUri, languageId, allowHTMLContent, synchronizationMethod, }: {
         client: LanguageServerClient;
         documentUri: string;
         languageId: string;
         allowHTMLContent: boolean;
+        synchronizationMethod: SynchronizationMethod;
     });
-    update({ docChanged }: ViewUpdate): void;
+    update({ state, changes, startState, docChanged }: ViewUpdate): void;
     destroy(): void;
     initialize({ documentText }: {
         documentText: string;
     }): Promise<void>;
-    sendChange({ documentText }: {
-        documentText: string;
-    }): Promise<void>;
+    sendChanges(contentChanges: LSP.TextDocumentContentChangeEvent[]): Promise<void>;
     requestDiagnostics(view: EditorView): void;
     requestHoverTooltip(view: EditorView, { line, character }: {
         line: number;
@@ -147,6 +150,7 @@ export declare const languageServerPlugin: ViewPlugin<LanguageServerPlugin, {
     documentUri: string;
     languageId: string;
     allowHTMLContent: boolean;
+    synchronizationMethod: SynchronizationMethod;
 }>;
 export interface LanguageServerBaseOptions {
     rootUri: string | null;

package/package.json

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