Add a new command to help users migrate launch.json configurations

Ruby LSP now provides better logging and error messages when the debugger
failed to start. And we plan to keep improving the debugging experience
in the future.

If users are currently using vscode-rdbg and want to try Ruby LSP, we can
help them migrate their launch.json configurations to the format used by
Ruby LSP.

Author: st0012

vscode/package.json

@@ -153,6 +153,11 @@
         "command": "rubyLsp.collectRubyLspInfo",
         "title": "Collect Ruby LSP Information for Issue Reporting",
         "category": "Ruby LSP"
+      },
+      {
+        "command": "rubyLsp.migrateLaunchConfiguration",
+        "title": "Migrate launch.json configurations from rdbg to ruby_lsp",
+        "category": "Ruby LSP"
       }
     ],
     "configuration": {

vscode/src/common.ts

@@ -29,6 +29,7 @@ export enum Command {
   NewMinitestFile = "rubyLsp.newMinitestFile",
   CollectRubyLspInfo = "rubyLsp.collectRubyLspInfo",
   StartServerInDebugMode = "rubyLsp.startServerInDebugMode",
+  MigrateLaunchConfiguration = "rubyLsp.migrateLaunchConfiguration",
 }
 
 export interface RubyInterface {

vscode/src/rubyLsp.ts

@@ -597,6 +597,68 @@ export class RubyLsp {
         },
       ),
     );
+    vscode.commands.registerCommand(
+      Command.MigrateLaunchConfiguration,
+      async () => {
+        const workspace = await this.showWorkspacePick();
+
+        if (!workspace) {
+          return;
+        }
+
+        const launchConfig =
+          (vscode.workspace
+            .getConfiguration("launch")
+            ?.get("configurations") as any[]) || [];
+
+        const updatedLaunchConfig = launchConfig.map((config: any) => {
+          if (config.type === "rdbg") {
+            if (config.request === "launch") {
+              const newConfig = { ...config };
+              newConfig.type = "ruby_lsp";
+
+              if (newConfig.askParameters !== true) {
+                delete newConfig.rdbgPath;
+                delete newConfig.cwd;
+                delete newConfig.useBundler;
+
+                const command = (newConfig.command || "").replace(
+                  "${workspaceRoot}/",
+                  "",
+                );
+                const script = newConfig.script || "";
+                const args = (newConfig.args || []).join(" ");
+                newConfig.program = `${command} ${script} ${args}`.trim();
+
+                delete newConfig.command;
+                delete newConfig.script;
+                delete newConfig.args;
+                delete newConfig.askParameters;
+              }
+
+              return newConfig;
+            } else if (config.request === "attach") {
+              const newConfig = { ...config };
+              newConfig.type = "ruby_lsp";
+              // rdbg's `debugPort` could be socket path, or port number, or host:port
+              // we don't do complex parsing here, just assume it's socket path
+              newConfig.debugSocketPath = config.debugPort;
+
+              return newConfig;
+            }
+          }
+          return config;
+        });
+
+        await vscode.workspace
+          .getConfiguration("launch")
+          .update(
+            "configurations",
+            updatedLaunchConfig,
+            vscode.ConfigurationTarget.Workspace,
+          );
+      },
+    );
   }
 
   // Get the current active workspace based on which file is opened in the editor