feat: apply additionalTextEdits after completion

See https://microsoft.github.io/language-server-protocol/specification#textDocument_completion

Co-Authored-By: Alex Butler <[email protected]>

Author: aminya

lib/adapters/autocomplete-adapter.ts

@@ -421,6 +421,8 @@ export default class AutocompleteAdapter {
       onDidConvertCompletionItem(item, suggestion as ac.AnySuggestion, request)
     }
 
+    suggestion.completionItem = item
+
     return suggestion
   }
 

lib/auto-languageclient.ts

@@ -35,6 +35,7 @@ import {
 } from "./server-manager.js"
 import { Disposable, CompositeDisposable, Point, Range, TextEditor } from "atom"
 import * as ac from "atom/autocomplete-plus"
+import { SuggestionBase } from "./types/autocomplete-extended"
 import { basename } from "path"
 
 export { ActiveServer, LanguageClientConnection, LanguageServerProcess }
@@ -638,7 +639,10 @@ export default class AutoLanguageClient {
       excludeLowerPriority: false,
       filterSuggestions: true,
       getSuggestions: this.getSuggestions.bind(this),
-      onDidInsertSuggestion: this.onDidInsertSuggestion.bind(this),
+      onDidInsertSuggestion: (event) => {
+        this.handleAdditionalTextEdits(event)
+        this.onDidInsertSuggestion(event)
+      },
       getSuggestionDetailsOnSelect: this.getSuggestionDetailsOnSelect.bind(this),
     }
   }
@@ -678,6 +682,16 @@ export default class AutoLanguageClient {
     _request: ac.SuggestionsRequestedEvent
   ): void {}
 
+  /** Handle additional text edits after a suggestion insert, e.g. `additionalTextEdits`. */
+  private handleAdditionalTextEdits(event: ac.SuggestionInsertedEvent): void {
+    const suggestion = event.suggestion as SuggestionBase
+    const additionalEdits = suggestion.completionItem?.additionalTextEdits
+    const buffer = event.editor.getBuffer()
+
+    ApplyEditAdapter.applyEdits(buffer, Convert.convertLsTextEdits(additionalEdits))
+    buffer.groupLastChanges()
+  }
+
   protected onDidInsertSuggestion(_arg: ac.SuggestionInsertedEvent): void {}
 
   // Definitions via LS documentHighlight and gotoDefinition------------

lib/convert.ts

@@ -199,7 +199,7 @@ export default class Convert {
    * @param textEdits The language server protocol {atomIde.TextEdit} objects to convert.
    * @returns An {Array} of Atom {atomIde.TextEdit} objects.
    */
-  public static convertLsTextEdits(textEdits: ls.TextEdit[] | null): atomIde.TextEdit[] {
+  public static convertLsTextEdits(textEdits?: ls.TextEdit[] | null): atomIde.TextEdit[] {
     return (textEdits || []).map(Convert.convertLsTextEdit)
   }
 

lib/types/autocomplete-extended.ts

@@ -2,9 +2,10 @@
 // See this PR: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/51284
 
 import * as ac from "atom/autocomplete-plus"
+import { CompletionItem } from "../languageclient"
 
 /** Adds LSP specific properties to the Atom SuggestionBase type */
-interface SuggestionBase extends ac.SuggestionBase {
+export interface SuggestionBase extends ac.SuggestionBase {
   /**
    * A string that is used when filtering and sorting a set of completion items with a prefix present. When `falsy` the
    * [displayText](#ac.SuggestionBase.displayText) is used. When no prefix, the `sortText` property is used.
@@ -16,6 +17,9 @@ interface SuggestionBase extends ac.SuggestionBase {
    * the suggestion was gathered from.
    */
   customReplacmentPrefix?: string
+
+  /** Original completion item, if available */
+  completionItem?: CompletionItem
 }
 export type TextSuggestion = SuggestionBase & ac.TextSuggestion
 export type SnippetSuggestion = SuggestionBase & ac.SnippetSuggestion