Merge pull request #214 from atom-haskell/clean-up-atom-typings

Clean up atom typings

Author: damieng

lib/adapters/autocomplete-adapter.ts

@@ -16,17 +16,16 @@ import {
   TextEdit,
 } from '../languageclient';
 import {
-  AutocompleteSuggestion,
-  AutocompleteRequest,
   Point,
   TextEditor,
 } from 'atom';
+import * as ac from 'atom/autocomplete-plus';
 
 interface SuggestionCacheEntry {
   isIncomplete: boolean;
   triggerPoint: Point;
   triggerChar: string;
-  suggestionMap: Map<AutocompleteSuggestion, [CompletionItem, boolean]>;
+  suggestionMap: Map<ac.AnySuggestion, [CompletionItem, boolean]>;
 }
 
 // Public: Adapts the language server protocol "textDocument/completion" to the Atom
@@ -56,11 +55,11 @@ export default class AutocompleteAdapter {
   // AutoComplete+ suggestions to display.
   public async getSuggestions(
     server: ActiveServer,
-    request: AutocompleteRequest,
-    onDidConvertCompletionItem?: (item: CompletionItem, suggestion: AutocompleteSuggestion,
-                                  request: AutocompleteRequest) => void,
+    request: ac.SuggestionsRequestedEvent,
+    onDidConvertCompletionItem?: (item: CompletionItem, suggestion: ac.AnySuggestion,
+                                  request: ac.SuggestionsRequestedEvent) => void,
     minimumWordLength?: number,
-  ): Promise<AutocompleteSuggestion[]> {
+  ): Promise<ac.AnySuggestion[]> {
     const triggerChars =
       server.capabilities.completionProvider != null ?
         server.capabilities.completionProvider.triggerCharacters || [] : [];
@@ -119,11 +118,11 @@ export default class AutocompleteAdapter {
   // Returns a {Promise} of an {atom$AutocompleteSuggestion} with the resolved AutoComplete+ suggestion.
   public async completeSuggestion(
     server: ActiveServer,
-    suggestion: AutocompleteSuggestion,
-    request: AutocompleteRequest,
-    onDidConvertCompletionItem?: (item: CompletionItem, suggestion: AutocompleteSuggestion,
-                                  request: AutocompleteRequest) => void,
-  ): Promise<AutocompleteSuggestion> {
+    suggestion: ac.AnySuggestion,
+    request: ac.SuggestionsRequestedEvent,
+    onDidConvertCompletionItem?: (item: CompletionItem, suggestion: ac.AnySuggestion,
+                                  request: ac.SuggestionsRequestedEvent) => void,
+  ): Promise<ac.AnySuggestion> {
     const cache = this._suggestionCache.get(server);
     if (cache) {
       const originalCompletionItem = cache.suggestionMap.get(suggestion);
@@ -144,7 +143,7 @@ export default class AutocompleteAdapter {
   //
   // * `suggestions` An {Array} of {atom$AutocompleteSuggestion}s to set the replacementPrefix on.
   // * `prefix` The {string} containing the prefix that should be set as replacementPrefix on all suggestions.
-  public static setReplacementPrefixOnSuggestions(suggestions: AutocompleteSuggestion[], prefix: string): void {
+  public static setReplacementPrefixOnSuggestions(suggestions: ac.AnySuggestion[], prefix: string): void {
     for (const suggestion of suggestions) {
       suggestion.replacementPrefix = prefix;
     }
@@ -158,7 +157,7 @@ export default class AutocompleteAdapter {
   // * `triggerChars` The {Array} of {string}s that can be trigger characters.
   //
   // Returns a {string} containing the matching trigger character or an empty string if one was not matched.
-  public static getTriggerCharacter(request: AutocompleteRequest, triggerChars: string[]): string {
+  public static getTriggerCharacter(request: ac.SuggestionsRequestedEvent, triggerChars: string[]): string {
     // AutoComplete-Plus considers text after a symbol to be a new trigger. So we should look backward
     // from the current cursor position to see if one is there and thus simulate it.
     const buffer = request.editor.getBuffer();
@@ -188,7 +187,7 @@ export default class AutocompleteAdapter {
   // * `triggerPoint` The {atom$Point} where the trigger started.
   //
   // Returns a {string} containing the prefix including the trigger character.
-  public static getPrefixWithTrigger(request: AutocompleteRequest, triggerPoint: Point): string {
+  public static getPrefixWithTrigger(request: ac.SuggestionsRequestedEvent, triggerPoint: Point): string {
     return request.editor
       .getBuffer()
       .getTextInRange([[triggerPoint.row, triggerPoint.column], request.bufferPosition]);
@@ -205,7 +204,7 @@ export default class AutocompleteAdapter {
   //  * `position` the position within the text document to display completion request for.
   //  * `context` containing the trigger character and kind.
   public static createCompletionParams(
-    request: AutocompleteRequest, triggerCharacter: string): CompletionParams {
+    request: ac.SuggestionsRequestedEvent, triggerCharacter: string): CompletionParams {
     return {
       textDocument: Convert.editorToTextDocumentIdentifier(request.editor),
       position: Convert.pointToPosition(request.bufferPosition),
@@ -238,15 +237,16 @@ export default class AutocompleteAdapter {
   // Returns a {Map} of AutoComplete+ suggestions ordered by the CompletionItems sortText.
   public completionItemsToSuggestions(
     completionItems: CompletionItem[] | CompletionList,
-    request: AutocompleteRequest,
-    onDidConvertCompletionItem?: (item: CompletionItem, suggestion: AutocompleteSuggestion,
-                                  request: AutocompleteRequest) => void,
-  ): Map<AutocompleteSuggestion, [CompletionItem, boolean]> {
+    request: ac.SuggestionsRequestedEvent,
+    onDidConvertCompletionItem?: (item: CompletionItem, suggestion: ac.AnySuggestion,
+                                  request: ac.SuggestionsRequestedEvent) => void,
+  ): Map<ac.AnySuggestion, [CompletionItem, boolean]> {
     return new Map((Array.isArray(completionItems) ? completionItems : completionItems.items || [])
       .sort((a, b) => (a.sortText || a.label).localeCompare(b.sortText || b.label))
-      .map<[AutocompleteSuggestion, [CompletionItem, boolean]]>(
+      .map<[ac.AnySuggestion, [CompletionItem, boolean]]>(
         (s) => [
-          AutocompleteAdapter.completionItemToSuggestion(s, { }, request, onDidConvertCompletionItem),
+          AutocompleteAdapter.completionItemToSuggestion(
+            s, {} as ac.AnySuggestion, request, onDidConvertCompletionItem),
           [s, false]]));
   }
 
@@ -261,14 +261,14 @@ export default class AutocompleteAdapter {
   // Returns the {atom$AutocompleteSuggestion} passed in as suggestion with the conversion applied.
   public static completionItemToSuggestion(
     item: CompletionItem,
-    suggestion: AutocompleteSuggestion,
-    request: AutocompleteRequest,
-    onDidConvertCompletionItem?: (item: CompletionItem, suggestion: AutocompleteSuggestion,
-                                  request: AutocompleteRequest) => void,
-  ): AutocompleteSuggestion {
-    AutocompleteAdapter.applyCompletionItemToSuggestion(item, suggestion);
-    AutocompleteAdapter.applyTextEditToSuggestion(item.textEdit, request.editor, suggestion);
-    AutocompleteAdapter.applySnippetToSuggestion(item, suggestion);
+    suggestion: ac.AnySuggestion,
+    request: ac.SuggestionsRequestedEvent,
+    onDidConvertCompletionItem?: (item: CompletionItem, suggestion: ac.AnySuggestion,
+                                  request: ac.SuggestionsRequestedEvent) => void,
+  ): ac.AnySuggestion {
+    AutocompleteAdapter.applyCompletionItemToSuggestion(item, suggestion as ac.TextSuggestion);
+    AutocompleteAdapter.applyTextEditToSuggestion(item.textEdit, request.editor, suggestion as ac.TextSuggestion);
+    AutocompleteAdapter.applySnippetToSuggestion(item, suggestion as ac.SnippetSuggestion);
     if (onDidConvertCompletionItem != null) {
       onDidConvertCompletionItem(item, suggestion, request);
     }
@@ -282,7 +282,7 @@ export default class AutocompleteAdapter {
   // * `suggestion` The {atom$AutocompleteSuggestion} to merge the conversion into.
   //
   // Returns an {atom$AutocompleteSuggestion} created from the {CompletionItem}.
-  public static applyCompletionItemToSuggestion(item: CompletionItem, suggestion: AutocompleteSuggestion) {
+  public static applyCompletionItemToSuggestion(item: CompletionItem, suggestion: ac.TextSuggestion) {
     suggestion.text = item.insertText || item.label;
     suggestion.displayText = item.label;
     suggestion.type = AutocompleteAdapter.completionKindToSuggestionType(item.kind);
@@ -313,7 +313,7 @@ export default class AutocompleteAdapter {
   public static applyTextEditToSuggestion(
     textEdit: TextEdit | undefined,
     editor: TextEditor,
-    suggestion: AutocompleteSuggestion,
+    suggestion: ac.TextSuggestion,
   ): void {
     if (textEdit) {
       suggestion.replacementPrefix = editor.getTextInBufferRange(Convert.lsRangeToAtomRange(textEdit.range));
@@ -327,9 +327,9 @@ export default class AutocompleteAdapter {
   // * `item` An {CompletionItem} containing the completion items to be merged into.
   // * `suggestion` The {atom$AutocompleteSuggestion} to merge the conversion into.
   //
-  public static applySnippetToSuggestion(item: CompletionItem, suggestion: AutocompleteSuggestion): void {
+  public static applySnippetToSuggestion(item: CompletionItem, suggestion: ac.SnippetSuggestion): void {
     if (item.insertTextFormat === InsertTextFormat.Snippet) {
-      suggestion.snippet = item.textEdit != null ? item.textEdit.newText : item.insertText;
+      suggestion.snippet = item.textEdit != null ? item.textEdit.newText : (item.insertText || '');
     }
   }
 

lib/adapters/document-sync-adapter.ts

@@ -14,9 +14,9 @@ import ApplyEditAdapter from './apply-edit-adapter';
 import {
   CompositeDisposable,
   Disposable,
-  DidStopChangingEvent,
-  TextEditEvent,
   TextEditor,
+  BufferStoppedChangingEvent,
+  TextChange,
 } from 'atom';
 import * as Utils from '../utils';
 
@@ -241,7 +241,7 @@ export class TextEditorSyncAdapter {
   //           text editor.
   // Note: The order of changes in the event is guaranteed top to bottom.  Language server
   // expects this in reverse.
-  public sendIncrementalChanges(event: DidStopChangingEvent): void {
+  public sendIncrementalChanges(event: BufferStoppedChangingEvent): void {
     if (event.changes.length > 0) {
       if (!this._isPrimaryAdapter()) { return; } // Multiple editors, we are not first
 
@@ -259,7 +259,7 @@ export class TextEditorSyncAdapter {
   // * `change` The Atom {TextEditEvent} to convert.
   //
   // Returns a {TextDocumentContentChangeEvent} that represents the converted {TextEditEvent}.
-  public static textEditToContentChange(change: TextEditEvent): TextDocumentContentChangeEvent {
+  public static textEditToContentChange(change: TextChange): TextDocumentContentChangeEvent {
     return {
       range: Convert.atomRangeToLSRange(change.oldRange),
       rangeLength: change.oldText.length,

lib/adapters/notifications-adapter.ts

@@ -7,7 +7,6 @@ import {
 } from '../languageclient';
 import {
   Notification,
-  NotificationButton,
   NotificationOptions,
   NotificationExt,
 } from 'atom';
@@ -93,7 +92,7 @@ export default class NotificationsAdapter {
   // Returns a {NotificationButton} equivalent to the {MessageActionItem} given.
   public static actionItemToNotificationButton(
     actionItem: MessageActionItem,
-  ): NotificationButton {
+  ) {
     return {
       text: actionItem.title,
     };

lib/auto-languageclient.ts

@@ -33,16 +33,13 @@ import {
   ActiveServer,
 } from './server-manager.js';
 import {
-  AutocompleteDidInsert,
-  AutocompleteProvider,
-  AutocompleteRequest,
-  AutocompleteSuggestion,
-  CompositeDisposable,
   Disposable,
+  CompositeDisposable,
   Point,
   Range,
   TextEditor,
 } from 'atom';
+import * as ac from 'atom/autocomplete-plus';
 
 export { ActiveServer, LanguageClientConnection, LanguageServerProcess };
 export type ConnectionType = 'stdio' | 'socket' | 'ipc';
@@ -63,7 +60,7 @@ export default class AutoLanguageClient {
   private _consoleDelegate?: atomIde.ConsoleService;
   private _linterDelegate?: linter.IndieDelegate;
   private _signatureHelpRegistry?: atomIde.SignatureHelpRegistry;
-  private _lastAutocompleteRequest?: AutocompleteRequest;
+  private _lastAutocompleteRequest?: ac.SuggestionsRequestedEvent;
   private _isDeactivating: boolean = false;
   private _serverAdapters = new WeakMap<ActiveServer, ServerAdapters>();
 
@@ -439,11 +436,11 @@ export default class AutoLanguageClient {
   }
 
   protected isFileInProject(editor: TextEditor, projectPath: string): boolean {
-    return (editor.getURI() || '').startsWith(projectPath);
+    return (editor.getPath() || '').startsWith(projectPath);
   }
 
   // Autocomplete+ via LS completion---------------------------------------
-  public provideAutocomplete(): AutocompleteProvider {
+  public provideAutocomplete(): ac.AutocompleteProvider {
     return {
       selector: this.getGrammarScopes()
         .map((g) => g.includes('.') ? '.' + g : g)
@@ -458,8 +455,8 @@ export default class AutoLanguageClient {
   }
 
   protected async getSuggestions(
-    request: AutocompleteRequest,
-  ): Promise<AutocompleteSuggestion[]> {
+    request: ac.SuggestionsRequestedEvent,
+  ): Promise<ac.AnySuggestion[]> {
     const server = await this._serverManager.getServer(request.editor);
     if (server == null || !AutocompleteAdapter.canAdapt(server.capabilities)) {
       return [];
@@ -472,7 +469,8 @@ export default class AutoLanguageClient {
   }
 
   protected async getSuggestionDetailsOnSelect(
-    suggestion: AutocompleteSuggestion): Promise<AutocompleteSuggestion | null> {
+    suggestion: ac.AnySuggestion,
+  ): Promise<ac.AnySuggestion | null> {
     const request = this._lastAutocompleteRequest;
     if (request == null) { return null; }
     const server = await this._serverManager.getServer(request.editor);
@@ -485,12 +483,12 @@ export default class AutoLanguageClient {
 
   protected onDidConvertAutocomplete(
     completionItem: ls.CompletionItem,
-    suggestion: AutocompleteSuggestion,
-    request: AutocompleteRequest,
+    suggestion: ac.AnySuggestion,
+    request: ac.SuggestionsRequestedEvent,
   ): void {
   }
 
-  protected onDidInsertSuggestion(arg: AutocompleteDidInsert): void {}
+  protected onDidInsertSuggestion(arg: ac.SuggestionInsertedEvent): void {}
 
   // Definitions via LS documentHighlight and gotoDefinition------------
   public provideDefinitions(): atomIde.DefinitionProvider {

lib/convert.ts

@@ -3,7 +3,7 @@ import * as ls from './languageclient';
 import * as URL from 'url';
 import {
   Point,
-  ProjectFileEvent,
+  FilesystemChange,
   Range,
   TextEditor,
 } from 'atom';
@@ -159,7 +159,7 @@ export default class Convert {
   // * 'fileEvent' An {atom$ProjectFileEvent} to be converted.
   //
   // Returns an array of LSP {ls.FileEvent} objects that equivalent conversions to the fileEvent parameter.
-  public static atomFileEventToLSFileEvents(fileEvent: ProjectFileEvent): ls.FileEvent[] {
+  public static atomFileEventToLSFileEvents(fileEvent: FilesystemChange): ls.FileEvent[] {
     switch (fileEvent.action) {
       case 'created':
         return [{uri: Convert.pathToUri(fileEvent.path), type: ls.FileChangeType.Created}];

lib/server-manager.ts

@@ -6,7 +6,7 @@ import { EventEmitter } from 'events';
 import { Logger } from './logger';
 import {
   CompositeDisposable,
-  ProjectFileEvent,
+  FilesystemChangeEvent,
   TextEditor,
 } from 'atom';
 import { ReportBusyWhile } from './utils';
@@ -277,7 +277,7 @@ export class ServerManager {
     this.updateNormalizedProjectPaths();
   }
 
-  public projectFilesChanged(fileEvents: ProjectFileEvent[]): void {
+  public projectFilesChanged(fileEvents: FilesystemChangeEvent): void {
     if (this._activeServers.length === 0) {
       return;
     }
@@ -289,7 +289,7 @@ export class ServerManager {
           changes.push(Convert.atomFileEventToLSFileEvents(fileEvent)[0]);
         }
         if (
-          fileEvent.oldPath &&
+          fileEvent.action === 'renamed' &&
           fileEvent.oldPath.startsWith(activeServer.projectPath) &&
           this._changeWatchedFileFilter(fileEvent.oldPath)
         ) {

package.json

@@ -15,7 +15,7 @@
     "test": "npm run compile && npm run lint && atom --test build/test"
   },
   "dependencies": {
-    "@types/atom": "~1.25.0",
+    "@types/atom": "~1.25.1",
     "@types/node": "^8.0.41",
     "fuzzaldrin-plus": "^0.6.0",
     "vscode-jsonrpc": "^3.5.0",