Add vscode support for gotoRelevantFile

Shopify · Jan 22, 2025 · da1a48d · da1a48d
1 parent 4bf4ae4
commit da1a48d
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 13 deletions.
diff --git a/vscode/package.json b/vscode/package.json
@@ -59,14 +59,24 @@
           "command": "rubyLsp.fileOperation",
           "when": "rubyLsp.activated && view == 'workbench.explorer.fileView'",
           "group": "navigation"
-        }
+        },
+        {
+          "command": "rubyLsp.gotoRelevantFile",
+          "when": "rubyLsp.activated && view == 'workbench.explorer.fileView'",
+          "group": "navigation"
+        },
       ],
       "explorer/context": [
         {
           "command": "rubyLsp.fileOperation",
           "when": "rubyLsp.activated",
           "group": "2_workspace"
-        }
+        },
+        {
+          "command": "rubyLsp.gotoRelevantFile",
+          "when": "rubyLsp.activated",
+          "group": "2_workspace"
+        },
       ]
     },
     "commands": [
@@ -149,6 +159,11 @@
         "category": "Ruby LSP",
         "icon": "$(ruby)"
       },
+      {
+        "command": "rubyLsp.gotoRelevantFile",
+        "title": "Goto relevant file (test <> source code)",
+        "category": "Ruby LSP"
+      },
       {
         "command": "rubyLsp.collectRubyLspInfo",
         "title": "Collect Ruby LSP information for issue reporting",

diff --git a/vscode/src/client.ts b/vscode/src/client.ts
@@ -296,13 +296,13 @@ class ExperimentalCapabilities implements StaticFeature {
   initialize(
     _capabilities: ServerCapabilities,
     _documentSelector: DocumentSelector | undefined,
-  ): void {}
+  ): void { }
 
   getState(): FeatureState {
     return { kind: "static" };
   }
 
-  clear(): void {}
+  clear(): void { }
 }
 
 export default class Client extends LanguageClient implements ClientInterface {
@@ -433,6 +433,14 @@ export default class Client extends LanguageClient implements ClientInterface {
     });
   }
 
+  async sendGotoRelevantFileRequest(
+    uri: vscode.Uri,
+  ): Promise<{ locations: string[] } | null> {
+    return this.sendRequest("experimental/gotoRelevantFile", {
+      textDocument: { uri: uri.toString() },
+    });
+  }
+
   private async benchmarkMiddleware<T>(
     type: string | MessageSignature,
     params: any,

diff --git a/vscode/src/common.ts b/vscode/src/common.ts
@@ -31,6 +31,7 @@ export enum Command {
   StartServerInDebugMode = "rubyLsp.startServerInDebugMode",
   ShowOutput = "rubyLsp.showOutput",
   MigrateLaunchConfiguration = "rubyLsp.migrateLaunchConfiguration",
+  GotoRelevantFile = "rubyLsp.gotoRelevantFile",
 }
 
 export interface RubyInterface {
@@ -98,7 +99,7 @@ type FeatureFlagConfigurationKey = keyof typeof FEATURE_FLAGS | "all";
 export function debounce(fn: (...args: any[]) => Promise<void>, delay: number) {
   let timeoutID: NodeJS.Timeout | null = null;
 
-  return function (...args: any[]) {
+  return function(...args: any[]) {
     if (timeoutID) {
       clearTimeout(timeoutID);
     }

diff --git a/vscode/src/rubyLsp.ts b/vscode/src/rubyLsp.ts
@@ -547,14 +547,14 @@ export class RubyLsp {
           command: string;
           args: any[];
         } & vscode.QuickPickItem)[] = [
-          {
-            label: "Minitest test",
-            description: "Create a new Minitest test",
-            iconPath: new vscode.ThemeIcon("new-file"),
-            command: Command.NewMinitestFile,
-            args: [],
-          },
-        ];
+            {
+              label: "Minitest test",
+              description: "Create a new Minitest test",
+              iconPath: new vscode.ThemeIcon("new-file"),
+              command: Command.NewMinitestFile,
+              args: [],
+            },
+          ];
 
         if (
           workspace.lspClient?.addons?.some(
@@ -601,6 +601,20 @@ export class RubyLsp {
           await workspace?.start(true);
         },
       ),
+      vscode.commands.registerCommand(Command.GotoRelevantFile, async () => {
+        const uri = vscode.window.activeTextEditor?.document.uri;
+        if (!uri) {
+          return;
+        }
+        const response: { locations: string[] } | null | undefined =
+          await this.currentActiveWorkspace()?.lspClient?.sendGotoRelevantFileRequest(
+            uri,
+          );
+
+        if (response) {
+          return openUris(response.locations);
+        }
+      }),
     );
     vscode.commands.registerCommand(Command.ShowOutput, async () => {
       LOG_CHANNEL.show();