Revert "chore: import autocomplte-plus types from atom/autocomplete-plus"

This reverts commit 3c8e619.

Author: aminya

lib/adapters/autocomplete-adapter.ts

@@ -20,6 +20,7 @@ import {
   TextEditor,
 } from 'atom';
 import * as ac from 'atom/autocomplete-plus';
+import { Suggestion, TextSuggestion, SnippetSuggestion } from 'atom-ide';
 
 /**
  * Holds a list of suggestions generated from the CompletionItem[]
@@ -35,7 +36,7 @@ interface SuggestionCacheEntry {
   originalBufferPoint: Point;
   /** The trigger string that caused the autocomplete (if any) */
   triggerChar: string;
-  suggestionMap: Map<ac.Suggestion, PossiblyResolvedCompletionItem>;
+  suggestionMap: Map<Suggestion, PossiblyResolvedCompletionItem>;
 }
 
 type CompletionItemAdjuster =
@@ -137,7 +138,7 @@ export default class AutocompleteAdapter {
     triggerChar: string,
     triggerOnly: boolean,
     onDidConvertCompletionItem?: CompletionItemAdjuster,
-  ): Promise<ac.Suggestion[]> {
+  ): Promise<Suggestion[]> {
     const cache = this._suggestionCache.get(server);
 
     const triggerColumn = (triggerChar !== '' && triggerOnly)
@@ -336,16 +337,16 @@ export default class AutocompleteAdapter {
     request: ac.SuggestionsRequestedEvent,
     triggerColumns: [number, number],
     onDidConvertCompletionItem?: CompletionItemAdjuster,
-  ): Map<ac.Suggestion, PossiblyResolvedCompletionItem> {
+  ): Map<Suggestion, PossiblyResolvedCompletionItem> {
     const completionsArray = Array.isArray(completionItems)
       ? completionItems
       : (completionItems && completionItems.items) || [];
     return new Map(completionsArray
       .sort((a, b) => (a.sortText || a.label).localeCompare(b.sortText || b.label))
-      .map<[ac.Suggestion, PossiblyResolvedCompletionItem]>(
+      .map<[Suggestion, PossiblyResolvedCompletionItem]>(
         (s) => [
           AutocompleteAdapter.completionItemToSuggestion(
-            s, {} as ac.Suggestion, request, triggerColumns, onDidConvertCompletionItem),
+            s, {} as Suggestion, request, triggerColumns, onDidConvertCompletionItem),
           new PossiblyResolvedCompletionItem(s, false),
         ],
       ),
@@ -364,16 +365,16 @@ export default class AutocompleteAdapter {
    */
   public static completionItemToSuggestion(
     item: CompletionItem,
-    suggestion: ac.Suggestion,
+    suggestion: Suggestion,
     request: ac.SuggestionsRequestedEvent,
     triggerColumns: [number, number],
     onDidConvertCompletionItem?: CompletionItemAdjuster,
-  ): ac.Suggestion {
-    AutocompleteAdapter.applyCompletionItemToSuggestion(item, suggestion as ac.TextSuggestion);
+  ): Suggestion {
+    AutocompleteAdapter.applyCompletionItemToSuggestion(item, suggestion as TextSuggestion);
     AutocompleteAdapter.applyTextEditToSuggestion(
-      item.textEdit, request.editor, triggerColumns, request.bufferPosition, suggestion as ac.TextSuggestion,
+      item.textEdit, request.editor, triggerColumns, request.bufferPosition, suggestion as TextSuggestion,
     );
-    AutocompleteAdapter.applySnippetToSuggestion(item, suggestion as ac.SnippetSuggestion);
+    AutocompleteAdapter.applySnippetToSuggestion(item, suggestion as SnippetSuggestion);
     if (onDidConvertCompletionItem != null) {
       onDidConvertCompletionItem(item, suggestion as ac.AnySuggestion, request);
     }
@@ -385,12 +386,12 @@ export default class AutocompleteAdapter {
    * Public: Convert the primary parts of a language server protocol CompletionItem to an AutoComplete+ suggestion.
    *
    * @param item An {CompletionItem} containing the completion items to be merged into.
-   * @param suggestion The {ac.Suggestion} to merge the conversion into.
-   * @returns The {ac.Suggestion} with details added from the {CompletionItem}.
+   * @param suggestion The {Suggestion} to merge the conversion into.
+   * @returns The {Suggestion} with details added from the {CompletionItem}.
    */
   public static applyCompletionItemToSuggestion(
     item: CompletionItem,
-    suggestion: ac.TextSuggestion,
+    suggestion: TextSuggestion,
   ): void {
     suggestion.text = item.insertText || item.label;
     suggestion.filterText = item.filterText || item.label;
@@ -401,7 +402,7 @@ export default class AutocompleteAdapter {
 
   public static applyDetailsToSuggestion(
     item: CompletionItem,
-    suggestion: ac.Suggestion,
+    suggestion: Suggestion,
   ): void {
     suggestion.rightLabel = item.detail;
 
@@ -434,7 +435,7 @@ export default class AutocompleteAdapter {
     editor: TextEditor,
     triggerColumns: [number, number],
     originalBufferPosition: Point,
-    suggestion: ac.TextSuggestion,
+    suggestion: TextSuggestion,
   ): void {
     if (!textEdit) { return; }
     if (textEdit.range.start.character !== triggerColumns[0]) {
@@ -451,7 +452,7 @@ export default class AutocompleteAdapter {
    * @param item An {CompletionItem} containing the completion items to be merged into.
    * @param suggestion The {atom$AutocompleteSuggestion} to merge the conversion into.
    */
-  public static applySnippetToSuggestion(item: CompletionItem, suggestion: ac.SnippetSuggestion): void {
+  public static applySnippetToSuggestion(item: CompletionItem, suggestion: SnippetSuggestion): void {
     if (item.insertTextFormat === InsertTextFormat.Snippet) {
       suggestion.snippet = item.textEdit != null ? item.textEdit.newText : (item.insertText || '');
     }

test/adapters/autocomplete-adapter.test.ts

@@ -9,6 +9,7 @@ import {
 import * as ac from 'atom/autocomplete-plus';
 import { expect } from 'chai';
 import { createSpyConnection, createFakeEditor } from '../helpers.js';
+import { TextSuggestion, SnippetSuggestion } from 'atom-ide';
 import { CompletionItem, MarkupContent, InsertTextFormat, TextEdit, Command } from '../../lib/languageclient';
 
 function createRequest({
@@ -244,21 +245,21 @@ describe('AutoCompleteAdapter', () => {
 
       expect(results.length).equals(items.length);
       expect(results[0].displayText).equals('align');
-      expect((results[0] as ac.TextSuggestion).text).equals('hello world');
+      expect((results[0] as TextSuggestion).text).equals('hello world');
       expect(results[0].replacementPrefix).equals('#align');
       expect(results[0].type).equals('snippet');
 
       expect(results[1].displayText).equals('list');
-      expect((results[1] as ac.TextSuggestion).text).equals('shifted');
+      expect((results[1] as TextSuggestion).text).equals('shifted');
       expect(results[1].replacementPrefix).equals('gn'); // TODO: support post replacement too
       expect(results[1].type).equals('constant');
 
       expect(results[2].displayText).equals('minimal');
-      expect((results[2] as ac.TextSuggestion).text).equals('minimal');
+      expect((results[2] as TextSuggestion).text).equals('minimal');
       expect(results[2].replacementPrefix).equals(''); // we sent an empty prefix
 
       expect(results[3].displayText).equals('old');
-      expect((results[3] as ac.SnippetSuggestion).snippet).equals('inserted');
+      expect((results[3] as SnippetSuggestion).snippet).equals('inserted');
       expect(results[3].description).equals('doc string');
       expect(results[3].descriptionMarkdown).equals('doc string');
 
@@ -297,7 +298,7 @@ describe('AutoCompleteAdapter', () => {
        }),
       ]);
       const result = (await autoCompleteAdapter.getSuggestions(server, createRequest({})))[0];
-      expect((result as ac.TextSuggestion).text).equals('insert');
+      expect((result as TextSuggestion).text).equals('insert');
       expect(result.displayText).equals('label');
       expect(result.type).equals('keyword');
       expect(result.rightLabel).equals('keyword');
@@ -333,7 +334,7 @@ describe('AutoCompleteAdapter', () => {
       expect(result.description).equals('a truly useful variable');
       expect(result.descriptionMarkdown).equals('a truly useful variable');
       expect(result.replacementPrefix).equals('#label');
-      expect((result as ac.TextSuggestion).text).equals('newText');
+      expect((result as TextSuggestion).text).equals('newText');
     });
 
     it('converts LSP CompletionItem with insertText and filterText to AutoComplete Suggestion', async () => {
@@ -354,7 +355,7 @@ describe('AutoCompleteAdapter', () => {
       expect(results.length).equals(1);
 
       const result = results[0];
-      expect((result as ac.TextSuggestion).text).equals('insert');
+      expect((result as TextSuggestion).text).equals('insert');
       expect(result.displayText).equals('label');
       expect(result.type).equals('keyword');
       expect(result.rightLabel).equals('detail');
@@ -413,7 +414,7 @@ describe('AutoCompleteAdapter', () => {
       ]);
 
       const result = (await autoCompleteAdapter.getSuggestions(server, createRequest({})))[0];
-      expect((result as ac.TextSuggestion).text).equals('label');
+      expect((result as TextSuggestion).text).equals('label');
       expect(result.displayText).equals('label');
       expect(result.type).equals('keyword');
       expect(result.rightLabel).equals('detail');
@@ -427,7 +428,7 @@ describe('AutoCompleteAdapter', () => {
       ]);
 
       const result = (await autoCompleteAdapter.getSuggestions(server, createRequest({prefix: 'rep'})))[0];
-      expect((result as ac.TextSuggestion).text).equals('');
+      expect((result as TextSuggestion).text).equals('');
       expect(result.displayText).equals('');
       expect(result.replacementPrefix).equals('');
     });
@@ -447,7 +448,7 @@ describe('AutoCompleteAdapter', () => {
       const results = await autoCompleteAdapter.getSuggestions(server, customRequest);
 
       expect(results[0].displayText).equals('align');
-      expect((results[0] as ac.TextSuggestion).text).equals('hello world');
+      expect((results[0] as TextSuggestion).text).equals('hello world');
       expect(results[0].replacementPrefix).equals('#align');
     });
 

typings/atom-ide/index.d.ts

@@ -1,9 +1,36 @@
 declare module 'atom-ide' {
-    // atom-ide-base types for backward compatibility
-    export * from "atom-ide-base/types-packages/main"
 
-    // NotificationButton for backward compatibility (moved to "../../lib/adapters/notifications-adapter")
-    export interface NotificationButton {
-      text: string
-    }
+  // atom-ide-base types for backward compatibility
+  export * from "atom-ide-base/types-packages/main"
+
+  // NotificationButton for backward compatibility (moved to "../../lib/adapters/notifications-adapter")
+  export interface NotificationButton {
+    text: string
+  }
+
+  // Autocomplete extention (the properties added by atom-languageclient)
+  // See this PR: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/51284
+
+  import * as ac from 'atom/autocomplete-plus';
+
+  /** Adds LSP specific properties to the Atom SuggestionBase type */
+  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.
+     */
+    filterText?: string;
+
+    /**
+     * String representing the replacement prefix from the suggestion's
+     * custom start point to the original buffer position the suggestion
+     * was gathered from.
+     */
+    customReplacmentPrefix?: string;
+  }
+  export type TextSuggestion = SuggestionBase & ac.TextSuggestion;
+  export type SnippetSuggestion = SuggestionBase & ac.SnippetSuggestion;
+  export type Suggestion =  TextSuggestion | SnippetSuggestion;
 }