feat: upgrade to LSP 3.16 and fix compiler errors

Co-Authored-By: Lev Chelyadinov <[email protected]>

Author: aminya

lib/adapters/autocomplete-adapter.ts

@@ -11,14 +11,28 @@ import {
   CompletionParams,
   CompletionTriggerKind,
   InsertTextFormat,
+  InsertReplaceEdit,
   LanguageClientConnection,
+  Range,
   ServerCapabilities,
   TextEdit,
 } from "../languageclient"
 import { Point, TextEditor } from "atom"
 import * as ac from "atom/autocomplete-plus"
 import { Suggestion, TextSuggestion, SnippetSuggestion } from "../types/autocomplete-extended"
 
+/**
+ * Defines the behavior of suggestion acceptance.
+ * Assume you have "cons|ole" in the editor (`|` is the cursor position)
+ * and the autocomplete suggestion is `const`.
+ * - insert mode: const|ole
+ * - replace mode: const|
+ */
+enum InsertMode {
+  insert = 'insert',
+  replace = 'replace',
+}
+
 /**
  * Holds a list of suggestions generated from the CompletionItem[]
  * list sent by the server, as well as metadata about the context
@@ -73,14 +87,16 @@ export default class AutocompleteAdapter {
    * @param onDidConvertCompletionItem An optional function that takes a {CompletionItem},
    *   an {atom$AutocompleteSuggestion} and a {atom$AutocompleteRequest}
    *   allowing you to adjust converted items.
+   * @param insertMode The behavior of suggestion acceptance (see {InsertMode}).
    * @returns A {Promise} of an {Array} of {atom$AutocompleteSuggestion}s containing the
    *   AutoComplete+ suggestions to display.
    */
   public async getSuggestions(
     server: ActiveServer,
     request: ac.SuggestionsRequestedEvent,
     onDidConvertCompletionItem?: CompletionItemAdjuster,
-    minimumWordLength?: number
+    minimumWordLength?: number,
+    insertMode: InsertMode = InsertMode.insert
   ): Promise<ac.AnySuggestion[]> {
     const triggerChars =
       server.capabilities.completionProvider != null
@@ -101,6 +117,7 @@ export default class AutocompleteAdapter {
       request,
       triggerChar,
       triggerOnly,
+      insertMode,
       onDidConvertCompletionItem
     )
 
@@ -140,6 +157,7 @@ export default class AutocompleteAdapter {
     request: ac.SuggestionsRequestedEvent,
     triggerChar: string,
     triggerOnly: boolean,
+    insertMode: InsertMode,
     onDidConvertCompletionItem?: CompletionItemAdjuster
   ): Promise<Suggestion[]> {
     const cache = this._suggestionCache.get(server)
@@ -181,6 +199,7 @@ export default class AutocompleteAdapter {
       completions,
       request,
       triggerColumns,
+      insertMode,
       onDidConvertCompletionItem
     )
     this._suggestionCache.set(server, {
@@ -339,6 +358,7 @@ export default class AutocompleteAdapter {
    * @param completionItems An {Array} of {CompletionItem} objects or a {CompletionList} containing completion
    *   items to be converted.
    * @param request The {atom$AutocompleteRequest} to satisfy.
+   * @param insertMode The behavior of suggestion acceptance (see {InsertMode}).
    * @param onDidConvertCompletionItem A function that takes a {CompletionItem}, an {atom$AutocompleteSuggestion}
    *   and a {atom$AutocompleteRequest} allowing you to adjust converted items.
    * @returns A {Map} of AutoComplete+ suggestions ordered by the CompletionItems sortText.
@@ -347,6 +367,7 @@ export default class AutocompleteAdapter {
     completionItems: CompletionItem[] | CompletionList | null,
     request: ac.SuggestionsRequestedEvent,
     triggerColumns: [number, number],
+    insertMode: InsertMode,
     onDidConvertCompletionItem?: CompletionItemAdjuster
   ): Map<Suggestion, PossiblyResolvedCompletionItem> {
     const completionsArray = Array.isArray(completionItems)
@@ -361,6 +382,7 @@ export default class AutocompleteAdapter {
             {} as Suggestion,
             request,
             triggerColumns,
+            insertMode,
             onDidConvertCompletionItem
           ),
           new PossiblyResolvedCompletionItem(s, false),
@@ -374,6 +396,7 @@ export default class AutocompleteAdapter {
    * @param item An {CompletionItem} containing a completion item to be converted.
    * @param suggestion A {atom$AutocompleteSuggestion} to have the conversion applied to.
    * @param request The {atom$AutocompleteRequest} to satisfy.
+   * @param insertMode The behavior of suggestion acceptance (see {InsertMode}).
    * @param onDidConvertCompletionItem A function that takes a {CompletionItem}, an {atom$AutocompleteSuggestion}
    *   and a {atom$AutocompleteRequest} allowing you to adjust converted items.
    * @returns The {atom$AutocompleteSuggestion} passed in as suggestion with the conversion applied.
@@ -383,6 +406,7 @@ export default class AutocompleteAdapter {
     suggestion: Suggestion,
     request: ac.SuggestionsRequestedEvent,
     triggerColumns: [number, number],
+    insertMode: InsertMode,
     onDidConvertCompletionItem?: CompletionItemAdjuster
   ): Suggestion {
     AutocompleteAdapter.applyCompletionItemToSuggestion(item, suggestion as TextSuggestion)
@@ -391,7 +415,8 @@ export default class AutocompleteAdapter {
       request.editor,
       triggerColumns,
       request.bufferPosition,
-      suggestion as TextSuggestion
+      suggestion as TextSuggestion,
+      insertMode
     )
     AutocompleteAdapter.applySnippetToSuggestion(item, suggestion as SnippetSuggestion)
     if (onDidConvertCompletionItem != null) {
@@ -442,20 +467,29 @@ export default class AutocompleteAdapter {
    * @param textEdit A {TextEdit} from a CompletionItem to apply.
    * @param editor An Atom {TextEditor} used to obtain the necessary text replacement.
    * @param suggestion An {atom$AutocompleteSuggestion} to set the replacementPrefix and text properties of.
+   * @param insertMode The behavior of suggestion acceptance (see {InsertMode}).
    */
   public static applyTextEditToSuggestion(
-    textEdit: TextEdit | undefined,
+    textEdit: TextEdit | InsertReplaceEdit | undefined,
     editor: TextEditor,
     triggerColumns: [number, number],
     originalBufferPosition: Point,
-    suggestion: TextSuggestion
+    suggestion: TextSuggestion,
+    insertMode: InsertMode,
   ): void {
-    if (!textEdit) {
-      return
+    if (!textEdit) { return; }
+    let range: Range;
+    if ('range' in textEdit) {
+      range = textEdit.range;
+    } else if (insertMode === InsertMode.insert) {
+      range = textEdit.insert;
+    } else {
+      range = textEdit.replace;
     }
-    if (textEdit.range.start.character !== triggerColumns[0]) {
-      const range = Convert.lsRangeToAtomRange(textEdit.range)
-      suggestion.customReplacmentPrefix = editor.getTextInBufferRange([range.start, originalBufferPosition])
+
+    if (range.start.character !== triggerColumns[0]) {
+      const atomRange = Convert.lsRangeToAtomRange(range);
+      suggestion.customReplacmentPrefix = editor.getTextInBufferRange([atomRange.start, originalBufferPosition]);
     }
     suggestion.text = textEdit.newText
   }

lib/adapters/document-sync-adapter.ts

@@ -410,10 +410,10 @@ export class TextEditorSyncAdapter {
 
     const uri = this.getEditorUri()
     const didSaveNotification = {
-      textDocument: { uri, version: this._getVersion(uri) },
-    } as DidSaveTextDocumentParams
-    if (this._documentSync.save && this._documentSync.save.includeText) {
-      didSaveNotification.text = this._editor.getText()
+      textDocument: { uri, version: this._getVersion((uri)) },
+    } as DidSaveTextDocumentParams;
+    if (typeof this._documentSync.save === 'object' && this._documentSync.save.includeText) {
+      didSaveNotification.text = this._editor.getText();
     }
     this._connection.didSaveTextDocument(didSaveNotification)
     if (this._fakeDidChangeWatchedFiles) {

lib/auto-languageclient.ts

@@ -1,35 +1,50 @@
-import * as cp from "child_process"
-import * as ls from "./languageclient"
-import * as rpc from "vscode-jsonrpc"
-import * as path from "path"
-import type * as atomIde from "atom-ide-base"
-import * as linter from "atom/linter"
-import Convert from "./convert.js"
-import ApplyEditAdapter from "./adapters/apply-edit-adapter"
-import AutocompleteAdapter from "./adapters/autocomplete-adapter"
-import CodeActionAdapter from "./adapters/code-action-adapter"
-import CodeFormatAdapter from "./adapters/code-format-adapter"
-import CodeHighlightAdapter from "./adapters/code-highlight-adapter"
-import DatatipAdapter from "./adapters/datatip-adapter"
-import DefinitionAdapter from "./adapters/definition-adapter"
-import DocumentSyncAdapter from "./adapters/document-sync-adapter"
-import FindReferencesAdapter from "./adapters/find-references-adapter"
-import LinterPushV2Adapter from "./adapters/linter-push-v2-adapter"
-import LoggingConsoleAdapter from "./adapters/logging-console-adapter"
-import NotificationsAdapter from "./adapters/notifications-adapter"
-import OutlineViewAdapter from "./adapters/outline-view-adapter"
-import RenameAdapter from "./adapters/rename-adapter"
-import SignatureHelpAdapter from "./adapters/signature-help-adapter"
-import * as Utils from "./utils"
-import { Socket } from "net"
-import { LanguageClientConnection } from "./languageclient"
-import { ConsoleLogger, FilteredLogger, Logger } from "./logger"
-import { LanguageServerProcess, ServerManager, ActiveServer } from "./server-manager.js"
-import { Disposable, CompositeDisposable, Point, Range, TextEditor } from "atom"
-import * as ac from "atom/autocomplete-plus"
-
-export { ActiveServer, LanguageClientConnection, LanguageServerProcess }
-export type ConnectionType = "stdio" | "socket" | "ipc"
+import * as cp from 'child_process';
+import * as ls from './languageclient';
+import * as rpc from 'vscode-jsonrpc';
+import * as rpcNode from 'vscode-jsonrpc/node';
+import * as path from 'path';
+import * as atomIde from 'atom-ide';
+import * as linter from 'atom/linter';
+import Convert from './convert.js';
+import ApplyEditAdapter from './adapters/apply-edit-adapter';
+import AutocompleteAdapter from './adapters/autocomplete-adapter';
+import CodeActionAdapter from './adapters/code-action-adapter';
+import CodeFormatAdapter from './adapters/code-format-adapter';
+import CodeHighlightAdapter from './adapters/code-highlight-adapter';
+import DatatipAdapter from './adapters/datatip-adapter';
+import DefinitionAdapter from './adapters/definition-adapter';
+import DocumentSyncAdapter from './adapters/document-sync-adapter';
+import FindReferencesAdapter from './adapters/find-references-adapter';
+import LinterPushV2Adapter from './adapters/linter-push-v2-adapter';
+import LoggingConsoleAdapter from './adapters/logging-console-adapter';
+import NotificationsAdapter from './adapters/notifications-adapter';
+import OutlineViewAdapter from './adapters/outline-view-adapter';
+import RenameAdapter from './adapters/rename-adapter';
+import SignatureHelpAdapter from './adapters/signature-help-adapter';
+import * as Utils from './utils';
+import { Socket } from 'net';
+import { LanguageClientConnection } from './languageclient';
+import {
+  ConsoleLogger,
+  FilteredLogger,
+  Logger,
+} from './logger';
+import {
+  LanguageServerProcess,
+  ServerManager,
+  ActiveServer,
+} from './server-manager.js';
+import {
+  Disposable,
+  CompositeDisposable,
+  Point,
+  Range,
+  TextEditor,
+} from 'atom';
+import * as ac from 'atom/autocomplete-plus';
+
+export { ActiveServer, LanguageClientConnection, LanguageServerProcess };
+export type ConnectionType = 'stdio' | 'socket' | 'ipc';
 
 export interface ServerAdapters {
   linterPushV2: LinterPushV2Adapter
@@ -185,6 +200,9 @@ export default class AutoLanguageClient {
           rename: {
             dynamicRegistration: false,
           },
+          moniker: {
+            dynamicRegistration: false,
+          },
 
           // We do not support these features yet.
           // Need to set to undefined to appease TypeScript weak type detection.
@@ -429,17 +447,17 @@ export default class AutoLanguageClient {
     const connectionType = this.getConnectionType()
     switch (connectionType) {
       case "ipc":
-        reader = new rpc.IPCMessageReader(lsProcess as cp.ChildProcess)
-        writer = new rpc.IPCMessageWriter(lsProcess as cp.ChildProcess)
+        reader = new rpcNode.IPCMessageReader(lsProcess as cp.ChildProcess)
+        writer = new rpcNode.IPCMessageWriter(lsProcess as cp.ChildProcess)
         break
       case "socket":
-        reader = new rpc.SocketMessageReader(this.socket)
-        writer = new rpc.SocketMessageWriter(this.socket)
+        reader = new rpcNode.SocketMessageReader(this.socket)
+        writer = new rpcNode.SocketMessageWriter(this.socket)
         break
       case "stdio":
         if (lsProcess.stdin !== null && lsProcess.stdout !== null) {
-          reader = new rpc.StreamMessageReader(lsProcess.stdout)
-          writer = new rpc.StreamMessageWriter(lsProcess.stdin)
+          reader = new rpcNode.StreamMessageReader(lsProcess.stdout)
+          writer = new rpcNode.StreamMessageWriter(lsProcess.stdin)
         } else {
           this.logger.error(
             `The language server process for ${this.getLanguageName()} does not have a valid stdin and stdout`

lib/languageclient.ts

@@ -533,11 +533,12 @@ export class LanguageClientConnection extends EventEmitter {
       this._log.debug(`rpc.sendRequest ${method} received (${Math.floor(took)}ms)`, result)
       return result
     } catch (e) {
-      const responseError = e as jsonrpc.ResponseError<any>
-      if (cancellationToken && responseError.code === jsonrpc.ErrorCodes.RequestCancelled) {
-        this._log.debug(`rpc.sendRequest ${method} was cancelled`)
-      } else {
-        this._log.error(`rpc.sendRequest ${method} threw`, e)
+      const responseError = e as jsonrpc.ResponseError<any>;
+      if (cancellationToken && responseError.code === lsp.LSPErrorCodes.RequestCancelled) {
+        this._log.debug(`rpc.sendRequest ${method} was cancelled`);
+      }
+      else {
+        this._log.error(`rpc.sendRequest ${method} threw`, e);
       }
 
       throw e

package.json

@@ -26,9 +26,9 @@
   "atomTestRunner": "./test/runner",
   "dependencies": {
     "atom-ide-base": "^2.4.0",
-    "vscode-jsonrpc": "5.0.1",
-    "vscode-languageserver-protocol": "3.15.3",
-    "vscode-languageserver-types": "3.15.1",
+    "vscode-jsonrpc": "6.0.0",
+    "vscode-languageserver-protocol": "3.16.0",
+    "vscode-languageserver-types": "3.16.0",
     "zadeh": "^2.0.2"
   },
   "devDependencies": {

pnpm-lock.yaml

@@ -19,7 +19,8 @@ export function createSpyConnection(): rpc.MessageConnection {
     sendProgress: sinon.spy(),
     trace: sinon.spy(),
     inspect: sinon.spy(),
-  }
+    end: sinon.spy(),
+  };
 }
 
 export function createFakeEditor(path?: string): TextEditor {