Merge branch 'master' into update-eslint

Author: aminya

.github/workflows/CI.yml

@@ -41,20 +41,14 @@ jobs:
       - name: Commit lint ✨
         uses: wagoid/commitlint-github-action@v2
 
-      - uses: UziTech/action-setup-atom@v1
-      - name: Setup PNPM
-        uses: pnpm/[email protected]
-        with:
-          version: latest
-
       - name: Install dependencies
-        run: pnpm install
+        run: npm install
 
       - name: Format ✨
-        run: pnpm test.format
+        run: npm run test.format
 
       - name: Lint ✨
-        run: pnpm test.lint
+        run: npm run test.lint
 
   Release:
     needs: [Test, Lint]

.github/workflows/bump_deps.yml

@@ -13,7 +13,7 @@ jobs:
         with:
           node-version: "12"
       - name: Setup PNPM
-        uses: pnpm/action-setup@v1.2.1
+        uses: pnpm/action-setup@master
         with:
           version: latest
 
@@ -32,8 +32,8 @@ jobs:
       - uses: peter-evans/create-pull-request@v3
         with:
           token: ${{ steps.generate-token.outputs.token }}
-          commit-message: "chore: Update Dependencies"
-          title: "fix: Update Dependencies"
+          commit-message: "fix: update Dependencies"
+          title: "fix: update Dependencies"
           labels: Dependencies
           branch: "Bump_Dependencies"
 
@@ -45,7 +45,7 @@ jobs:
         with:
           node-version: "12"
       - name: Setup PNPM
-        uses: pnpm/action-setup@v1.2.1
+        uses: pnpm/action-setup@master
         with:
           version: latest
 
@@ -64,7 +64,7 @@ jobs:
       - uses: peter-evans/create-pull-request@v3
         with:
           token: ${{ steps.generate-token.outputs.token }}
-          commit-message: "chore: Update devDependencies"
-          title: "chore: Update devDependencies"
+          commit-message: "chore: update devDependencies"
+          title: "chore: update devDependencies"
           labels: Dependencies
           branch: "Bump_devDependencies"

CHANGELOG.md

@@ -1,3 +1,56 @@
+# [1.6.0](https://github.com/atom-ide-community/atom-languageclient/compare/v1.5.0...v1.6.0) (2021-03-21)
+
+
+### Bug Fixes
+
+* consider showing the document in external programs a sucess ([fabf882](https://github.com/atom-ide-community/atom-languageclient/commit/fabf88299c6e221743d3da0d14fcf07861182bc6))
+* fix the doc for onShowDocument ([03b9b20](https://github.com/atom-ide-community/atom-languageclient/commit/03b9b202e9ac1215f064f6de64ad45420faa95ca))
+* params.selection can be undefined ([921613b](https://github.com/atom-ide-community/atom-languageclient/commit/921613b491dc820ad9e0234954d42fd9d4092294))
+* rename onShowDocument function to showDocument ([f9549c6](https://github.com/atom-ide-community/atom-languageclient/commit/f9549c6f27e762f7e122d731f17bf827b8117fb1))
+* return success false if view is undefined ([7bede25](https://github.com/atom-ide-community/atom-languageclient/commit/7bede25205135bdbf716c55a695b307eb8ee9142))
+* try-catch showDocument ([6e8770c](https://github.com/atom-ide-community/atom-languageclient/commit/6e8770ced9d4e77d056db6386d0584b351adbd65))
+* use free functions instead of static methods ([38441c9](https://github.com/atom-ide-community/atom-languageclient/commit/38441c9d24c6336b87b17686d63ed062437ef112))
+
+
+### Features
+
+* implement window/showDocument ([ff1aa7a](https://github.com/atom-ide-community/atom-languageclient/commit/ff1aa7ab0993c6de1c8e76c87e76c10387694935))
+
+# [1.5.0](https://github.com/atom-ide-community/atom-languageclient/compare/v1.4.0...v1.5.0) (2021-03-19)
+
+
+### Bug Fixes
+
+* add and use normalizeGrammarScope ([889f1da](https://github.com/atom-ide-community/atom-languageclient/commit/889f1da34bc0edb2ee2565e96db93e5f8d042df5)), closes [/github.com/atom-community/atom-languageclient/pull/136#discussion_r597451879](https://github.com//github.com/atom-community/atom-languageclient/pull/136/issues/discussion_r597451879)
+* add filterSuggestion: true to provideAutocomplete ([d143451](https://github.com/atom-ide-community/atom-languageclient/commit/d143451d0213d0b2f802c6f7ebe983efbf24d891))
+* add locale to getInitializeParams ([dfce15a](https://github.com/atom-ide-community/atom-languageclient/commit/dfce15a97352b5c0403c50f131d1cbcdcae50299))
+* simplify provideAutocomplete.selector ([1f10d7b](https://github.com/atom-ide-community/atom-languageclient/commit/1f10d7b546e75355d07df3f61d585cf4db141138))
+
+
+### Features
+
+* add more compeletion properties in AutoLanguageClient ([45d7d19](https://github.com/atom-ide-community/atom-languageclient/commit/45d7d1931c9e8104e309b8b660c9331e4262f57e))
+* allow disabling autocomplete for some scopes ([a6e3244](https://github.com/atom-ide-community/atom-languageclient/commit/a6e324458ce2fe601f95e4532a522acc3224e4f8))
+
+# [1.4.0](https://github.com/atom-ide-community/atom-languageclient/compare/v1.3.0...v1.4.0) (2021-03-17)
+
+
+### Features
+
+* handling custom requests ([543cd6e](https://github.com/atom-ide-community/atom-languageclient/commit/543cd6e74936f078f389f34166bdf947d4c4bee0))
+
+# [1.3.0](https://github.com/atom-ide-community/atom-languageclient/compare/v1.2.2...v1.3.0) (2021-03-16)
+
+
+### Bug Fixes
+
+* use ShouldReplace ([6601427](https://github.com/atom-ide-community/atom-languageclient/commit/66014277fd95007cb6ab500a7727c7475e7fcae1))
+
+
+### Features
+
+* upgrade to LSP 3.16 and fix compiler errors ([db07b3c](https://github.com/atom-ide-community/atom-languageclient/commit/db07b3c4972842f3f5b8a4e221c8e406aed52e96))
+
 ## [1.2.2](https://github.com/atom-ide-community/atom-languageclient/compare/v1.2.1...v1.2.2) (2021-02-23)
 
 

lib/adapters/autocomplete-adapter.ts

@@ -11,14 +11,25 @@ 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`.
+ * - if `false` -> the edits are inserted : const|ole
+ * - if `true`` -> the edits are replaced: const|
+ */
+type ShouldReplace = boolean
+
 /**
  * Holds a list of suggestions generated from the CompletionItem[]
  * list sent by the server, as well as metadata about the context
@@ -73,14 +84,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 shouldReplace The behavior of suggestion acceptance (see {ShouldReplace}).
    * @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,
+    shouldReplace: ShouldReplace = false
   ): Promise<ac.AnySuggestion[]> {
     const triggerChars =
       server.capabilities.completionProvider != null
@@ -101,6 +114,7 @@ export default class AutocompleteAdapter {
       request,
       triggerChar,
       triggerOnly,
+      shouldReplace,
       onDidConvertCompletionItem
     )
 
@@ -140,6 +154,7 @@ export default class AutocompleteAdapter {
     request: ac.SuggestionsRequestedEvent,
     triggerChar: string,
     triggerOnly: boolean,
+    shouldReplace: ShouldReplace,
     onDidConvertCompletionItem?: CompletionItemAdjuster
   ): Promise<Suggestion[]> {
     const cache = this._suggestionCache.get(server)
@@ -181,6 +196,7 @@ export default class AutocompleteAdapter {
       completions,
       request,
       triggerColumns,
+      shouldReplace,
       onDidConvertCompletionItem
     )
     this._suggestionCache.set(server, {
@@ -339,6 +355,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 shouldReplace The behavior of suggestion acceptance (see {ShouldReplace}).
    * @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 +364,7 @@ export default class AutocompleteAdapter {
     completionItems: CompletionItem[] | CompletionList | null,
     request: ac.SuggestionsRequestedEvent,
     triggerColumns: [number, number],
+    shouldReplace: ShouldReplace,
     onDidConvertCompletionItem?: CompletionItemAdjuster
   ): Map<Suggestion, PossiblyResolvedCompletionItem> {
     const completionsArray = Array.isArray(completionItems)
@@ -361,6 +379,7 @@ export default class AutocompleteAdapter {
             {} as Suggestion,
             request,
             triggerColumns,
+            shouldReplace,
             onDidConvertCompletionItem
           ),
           new PossiblyResolvedCompletionItem(s, false),
@@ -374,6 +393,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 shouldReplace The behavior of suggestion acceptance (see {ShouldReplace}).
    * @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 +403,7 @@ export default class AutocompleteAdapter {
     suggestion: Suggestion,
     request: ac.SuggestionsRequestedEvent,
     triggerColumns: [number, number],
+    shouldReplace: ShouldReplace,
     onDidConvertCompletionItem?: CompletionItemAdjuster
   ): Suggestion {
     AutocompleteAdapter.applyCompletionItemToSuggestion(item, suggestion as TextSuggestion)
@@ -391,7 +412,8 @@ export default class AutocompleteAdapter {
       request.editor,
       triggerColumns,
       request.bufferPosition,
-      suggestion as TextSuggestion
+      suggestion as TextSuggestion,
+      shouldReplace
     )
     AutocompleteAdapter.applySnippetToSuggestion(item, suggestion as SnippetSuggestion)
     if (onDidConvertCompletionItem != null) {
@@ -442,20 +464,31 @@ 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 shouldReplace The behavior of suggestion acceptance (see {ShouldReplace}).
    */
   public static applyTextEditToSuggestion(
-    textEdit: TextEdit | undefined,
+    textEdit: TextEdit | InsertReplaceEdit | undefined,
     editor: TextEditor,
     triggerColumns: [number, number],
     originalBufferPosition: Point,
-    suggestion: TextSuggestion
+    suggestion: TextSuggestion,
+    shouldReplace: ShouldReplace
   ): void {
     if (!textEdit) {
       return
     }
-    if (textEdit.range.start.character !== triggerColumns[0]) {
-      const range = Convert.lsRangeToAtomRange(textEdit.range)
-      suggestion.customReplacmentPrefix = editor.getTextInBufferRange([range.start, originalBufferPosition])
+    let range: Range
+    if ("range" in textEdit) {
+      range = textEdit.range
+    } else if (shouldReplace) {
+      range = textEdit.replace
+    } else {
+      range = textEdit.insert
+    }
+
+    if (range.start.character !== triggerColumns[0]) {
+      const atomRange = Convert.lsRangeToAtomRange(range)
+      suggestion.customReplacmentPrefix = editor.getTextInBufferRange([atomRange.start, originalBufferPosition])
     }
     suggestion.text = textEdit.newText
   }
@@ -525,3 +558,13 @@ export default class AutocompleteAdapter {
     }
   }
 }
+
+/**
+ * Normalizes the given grammar scope for autoComplete package so it always starts with `.`
+ * Based on https://github.com/atom/autocomplete-plus/wiki/Autocomplete-Providers
+ * @param grammarScope such as 'source.python' or '.source.python'
+ * @returns the normalized grammarScope such as `.source.python`
+ */
+export function grammarScopeToAutoCompleteSelector(grammarScope: string): string {
+  return grammarScope.includes(".") && grammarScope[0] !== "." ? `.${grammarScope}` : grammarScope
+}

lib/adapters/document-sync-adapter.ts

@@ -412,7 +412,7 @@ export class TextEditorSyncAdapter {
     const didSaveNotification = {
       textDocument: { uri, version: this._getVersion(uri) },
     } as DidSaveTextDocumentParams
-    if (this._documentSync.save && this._documentSync.save.includeText) {
+    if (typeof this._documentSync.save === "object" && this._documentSync.save.includeText) {
       didSaveNotification.text = this._editor.getText()
     }
     this._connection.didSaveTextDocument(didSaveNotification)

lib/adapters/notifications-adapter.ts

@@ -5,7 +5,7 @@ import {
   ShowMessageParams,
   ShowMessageRequestParams,
 } from "../languageclient"
-import { Notification, NotificationOptions, NotificationExt } from "atom"
+import { Notification, NotificationOptions } from "atom"
 
 export interface NotificationButton {
   text: string
@@ -109,7 +109,7 @@ function addNotificationForMessage(
   message: string,
   options: NotificationOptions
 ): Notification | null {
-  function isDuplicate(note: NotificationExt): boolean {
+  function isDuplicate(note: Notification): boolean {
     const noteDismissed = note.isDismissed && note.isDismissed()
     const noteOptions = (note.getOptions && note.getOptions()) || {}
     return (

lib/adapters/show-document-adapter.ts

@@ -0,0 +1,57 @@
+import { shell } from "electron"
+import { LanguageClientConnection, ShowDocumentParams, ShowDocumentResult } from "../languageclient"
+import { TextEditor } from "atom"
+import Convert from "../convert"
+
+/** Public: Adapts the window/showDocument command to Atom's text editors or external programs. */
+const ShowDocumentAdapter = {
+  /** {@inheritDoc attach} */
+  attach,
+  /** {@inheritDoc showDocument} */
+  showDocument,
+}
+// for consistency with other adapters
+export default ShowDocumentAdapter
+
+/**
+ * Public: Attach to a {LanguageClientConnection} to recieve requests to show documents.
+ */
+export function attach(connection: LanguageClientConnection): void {
+  connection.onShowDocument(showDocument)
+}
+
+/**
+ * Public: show documents inside Atom text editor or in external programs
+ *
+ * @param params The {ShowDocumentParams} received from the language server
+ *   indicating the document to be displayed as well as other metadata.
+ * @returns {Promise<ShowDocumentResult>} with a `success: boolean` property specifying if the operation was sucessful
+ * {@inheritDoc ShowDocumentParams}
+ */
+export async function showDocument(params: ShowDocumentParams): Promise<ShowDocumentResult> {
+  try {
+    if (!params.external) {
+      // open using atom.workspace
+      const view = await atom.workspace.open(Convert.uriToPath(params.uri), {
+        activateItem: params.takeFocus,
+        activatePane: params.takeFocus,
+        pending: true,
+        initialLine: params.selection?.start.line ?? 0,
+        initialColumn: params.selection?.start.character ?? 0,
+      })
+      if (!view) {
+        return { success: false }
+      }
+      if (view instanceof TextEditor && params.selection !== undefined) {
+        view.selectToBufferPosition(Convert.positionToPoint(params.selection.end))
+      }
+    } else {
+      // open using Electron
+      shell.openExternal(params.uri, { activate: params.takeFocus })
+    }
+    return { success: true }
+  } catch (e) {
+    atom.notifications.addError(e)
+    return { success: false }
+  }
+}