WIP

Author: vinistock

vscode/src/sorbet.ts

@@ -0,0 +1,53 @@
+import * as vscode from "vscode";
+import {
+  LanguageClient,
+  ServerOptions,
+  LanguageClientOptions,
+  RevealOutputChannelOn,
+} from "vscode-languageclient/node";
+
+import { WorkspaceChannel } from "./workspaceChannel";
+import { Ruby } from "./ruby";
+
+// Experimental Sorbet client to be used along with the Ruby LSP
+// TODO required to move forward:
+// - Before starting the Sorbet client
+//   - we need to check if the Sorbet extension is installed
+//   - we need to check if sorbet/config exists
+//
+// TODO later:
+// - Automatic restarts when sorbet/config changes
+// - Allow starting, stopping and restarting the Sorbet client separately
+// - Allow automatic restarts to target a specific client (so that we don't have to restart Sorbet on a rubocop.yml
+// change)
+// - Report Sorbet status (have the server send WorkDoneProgress notifications instead of using a custom built status
+// bar)
+export default class SorbetClient extends LanguageClient {
+  constructor(
+    ruby: Ruby,
+    workspaceFolder: vscode.WorkspaceFolder,
+    outputChannel: WorkspaceChannel,
+  ) {
+    const serverOptions: ServerOptions = {
+      command: "bundle",
+      args: ["exec", "srb", "tc", "--lsp"],
+      options: {
+        cwd: workspaceFolder.uri.fsPath,
+        env: ruby.env,
+        shell: true,
+      },
+    };
+
+    const clientOptions: LanguageClientOptions = {
+      documentSelector: [
+        { language: "ruby", pattern: `${workspaceFolder.uri.fsPath}/**/*` },
+      ],
+      workspaceFolder,
+      diagnosticCollectionName: "sorbet",
+      outputChannel,
+      revealOutputChannelOn: RevealOutputChannelOn.Never,
+    };
+
+    super("sorbet", serverOptions, clientOptions);
+  }
+}

vscode/src/workspace.ts

@@ -10,7 +10,8 @@ import {
   STATUS_EMITTER,
   debounce,
 } from "./common";
-import { WorkspaceChannel } from "./workspaceChannel";
+import { SorbetWorkspaceChannel, WorkspaceChannel } from "./workspaceChannel";
+import SorbetClient from "./sorbet";
 
 export class Workspace implements WorkspaceInterface {
   public lspClient?: Client;
@@ -22,6 +23,7 @@ export class Workspace implements WorkspaceInterface {
   private readonly isMainWorkspace: boolean;
   private readonly telemetry: vscode.TelemetryLogger;
   private needsRestart = false;
+  private sorbetClient?: SorbetClient;
   #rebaseInProgress = false;
   #error = false;
 
@@ -96,6 +98,10 @@ export class Workspace implements WorkspaceInterface {
       await this.lspClient.stop();
       await this.lspClient.dispose();
     }
+    if (this.sorbetClient) {
+      await this.sorbetClient.stop();
+      await this.sorbetClient.dispose();
+    }
 
     this.lspClient = new Client(
       this.context,
@@ -106,11 +112,17 @@ export class Workspace implements WorkspaceInterface {
       this.outputChannel,
       this.isMainWorkspace,
     );
+    this.sorbetClient = new SorbetClient(
+      this.ruby,
+      this.workspaceFolder,
+      new SorbetWorkspaceChannel(this.workspaceFolder.name, LOG_CHANNEL),
+    );
 
     try {
       STATUS_EMITTER.fire(this);
       await this.lspClient.start();
       await this.lspClient.afterStart();
+      await this.sorbetClient.start();
       STATUS_EMITTER.fire(this);
 
       // If something triggered a restart while we were still booting, then now we need to perform the restart since the
@@ -126,7 +138,19 @@ export class Workspace implements WorkspaceInterface {
   }
 
   async stop() {
-    await this.lspClient?.stop();
+    try {
+      await this.lspClient?.stop();
+    } catch (error: any) {
+      this.outputChannel.error(`Error stopping the Ruby LSP: ${error.message}`);
+    }
+
+    try {
+      await this.sorbetClient?.stop();
+    } catch (error: any) {
+      this.outputChannel.error(
+        `Error stopping the Sorbet server: ${error.message}`,
+      );
+    }
   }
 
   async restart() {
@@ -138,28 +162,30 @@ export class Workspace implements WorkspaceInterface {
       this.error = false;
 
       // If there's no client, then we can just start a new one
-      if (!this.lspClient) {
+      if (!this.lspClient && !this.sorbetClient) {
         return this.start();
       }
 
-      switch (this.lspClient.state) {
+      switch (this.lspClient!.state) {
         // If the server is still starting, then it may not be ready to handle a shutdown request yet. Trying to send
-        // one could lead to a hanging process. Instead we set a flag and only restart once the server finished booting
-        // in `start`
+        // one could lead to a hanging process. Instead we set a flag and only restart once the server finished
+        // booting in `start`
         case State.Starting:
           this.needsRestart = true;
           break;
         // If the server is running, we want to stop it, dispose of the client and start a new one
         case State.Running:
           await this.stop();
-          await this.lspClient.dispose();
+          await this.dispose();
           this.lspClient = undefined;
+          this.sorbetClient = undefined;
           await this.start();
           break;
         // If the server is already stopped, then we need to dispose it and start a new one
         case State.Stopped:
-          await this.lspClient.dispose();
+          await this.dispose();
           this.lspClient = undefined;
+          this.sorbetClient = undefined;
           await this.start();
           break;
       }
@@ -171,6 +197,7 @@ export class Workspace implements WorkspaceInterface {
 
   async dispose() {
     await this.lspClient?.dispose();
+    await this.sorbetClient?.dispose();
   }
 
   // Install or update the `ruby-lsp` gem globally with `gem install ruby-lsp` or `gem update ruby-lsp`. We only try to

vscode/src/workspaceChannel.ts

@@ -73,3 +73,9 @@ export class WorkspaceChannel implements vscode.LogOutputChannel {
     this.actualChannel.dispose();
   }
 }
+
+export class SorbetWorkspaceChannel extends WorkspaceChannel {
+  constructor(workspaceName: string, actualChannel: vscode.LogOutputChannel) {
+    super(`${workspaceName} [Sorbet]`, actualChannel);
+  }
+}