feat: implement window/showDocument

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

Author: aminya

lib/adapters/show-document-adapter.ts

@@ -0,0 +1,41 @@
+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. */
+export default class ShowDocumentAdapter {
+  /**
+   * Public: Attach to a {LanguageClientConnection} to recieve requests to show documents.
+   */
+  public static attach(connection: LanguageClientConnection): void {
+    connection.onShowDocument(ShowDocumentAdapter.onShowDocument)
+  }
+
+  /**
+   * Public: Show a notification message with buttons using the Atom notifications API.
+   *
+   * @param params The {ShowDocumentParams} received from the language server
+   *   indicating the document to be displayed as well as other metadata.
+   */
+  public static async onShowDocument(params: ShowDocumentParams): Promise<ShowDocumentResult> {
+    if (!params.external) {
+      // open using atom.workspace
+      const view = await atom.workspace.open(params.uri, {
+        activateItem: params.takeFocus,
+        activatePane: params.takeFocus,
+        pending: true,
+        initialLine: params.selection?.start.line ?? 0,
+        initialColumn: params.selection?.start.character ?? 0,
+      })
+      if (view instanceof TextEditor && params.selection != null) {
+        view.selectToBufferPosition(Convert.positionToPoint(params.selection.end))
+      }
+      return { success: true }
+    } else {
+      // open using Electron
+      shell.openExternal(params.uri, { activate: params.takeFocus })
+      return { success: false }
+    }
+  }
+}

lib/auto-languageclient.ts

@@ -21,6 +21,7 @@ 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 ShowDocumentAdapter from "./adapters/show-document-adapter"
 import * as Utils from "./utils"
 import { Socket } from "net"
 import { LanguageClientConnection } from "./languageclient"
@@ -197,6 +198,11 @@ export default class AutoLanguageClient {
           colorProvider: undefined,
           foldingRange: undefined,
         },
+        window: {
+          workDoneProgress: false, // TODO: support
+          showMessage: undefined,
+          showDocument: { support: true },
+        },
         experimental: {},
       },
     }
@@ -506,6 +512,8 @@ export default class AutoLanguageClient {
       loggingConsole,
       signatureHelpAdapter,
     })
+
+    ShowDocumentAdapter.attach(server.connection)
   }
 
   public shouldSyncForEditor(editor: TextEditor, projectPath: string): boolean {

lib/languageclient.ts

@@ -15,6 +15,7 @@ export interface KnownNotifications {
 }
 
 export interface KnownRequests {
+  "window/showDocument": [lsp.ShowDocumentParams, lsp.ShowDocumentResult]
   "window/showMessageRequest": [lsp.ShowMessageRequestParams, lsp.MessageActionItem | null]
   "workspace/applyEdit": [lsp.ApplyWorkspaceEditParams, lsp.ApplyWorkspaceEditResponse]
   [custom: string]: [Record<string, any>, Record<string, any> | null]
@@ -166,6 +167,16 @@ export class LanguageClientConnection extends EventEmitter {
     this._onRequest({ method: "window/showMessageRequest" }, callback)
   }
 
+  /**
+   * Public: Register a callback for the `window/showDocument` message.
+   *
+   * @param callback The function to be called when the `window/showDocument` message is
+   *   received with {ShowDocumentParams} being passed.
+   */
+  public onShowDocument(callback: (params: lsp.ShowDocumentParams) => Promise<lsp.ShowDocumentResult>): void {
+    this._onRequest({ method: "window/showDocument" }, callback)
+  }
+
   /**
    * Public: Register a callback for the `window/logMessage` message.
    *

typings/electron/index.d.ts

@@ -0,0 +1,10 @@
+interface OpenExternalOptions {
+  activate?: boolean
+  workingDirectory?: string
+}
+
+declare module "electron" {
+  export const shell: {
+    openExternal(url: string, options?: OpenExternalOptions): void
+  }
+}