Running truffle debug with appropriate flag (--vscode)

packages/core/lib/commands/debug/meta.js

@@ -31,6 +31,12 @@ module.exports = {
       describe: "Force debugger to skip compilation (dangerous!)",
       type: "boolean",
       default: false
+    },
+    "vscode": {
+      describe:
+        "Starts the debug session in VS Code using the Truffle for VS Code extension",
+      type: "boolean",
+      default: false
     }
   },
   help: {
@@ -75,6 +81,11 @@ module.exports = {
         option: "--compile-none",
         description:
           "Forces the debugger to use artifacts even if it detects a problem.  Dangerous; may cause errors."
+      },
+      {
+        option: "--vscode",
+        description:
+          "Starts the debug session in VS Code using the Truffle for VS Code extension."
       }
     ],
     allowedGlobalOptions: ["config"]

packages/core/lib/commands/debug/run.js

@@ -60,9 +60,20 @@ module.exports = async function (options) {
   if (config.compileAll && config.compileNone) {
     throw new Error("Incompatible options passed regarding what to compile");
   }
-  const interpreter = await new CLIDebugger(config, {
+
+  // Create a new CLIDebugger instance
+  const cliDebugger = new CLIDebugger(config, {
     txHash,
     compilations
-  }).run();
+  });
+
+  // Checks if the user wants to open the debugger in vscode
+  if (config.vscode) {
+    await cliDebugger.openVSCodeDebug();
+    return;
+  }
+
+  // Starts the cli debugger
+  const interpreter = await cliDebugger.run();
   return await promisify(interpreter.start.bind(interpreter))();
 };

packages/core/lib/debug/cli.js

@@ -3,6 +3,7 @@ const debug = debugModule("lib:debug:cli");
 
 const fs = require("fs-extra");
 const path = require("path");
+const childProcess = require("child_process");
 
 const Debugger = require("@truffle/debugger");
 const DebugUtils = require("@truffle/debug-utils");
@@ -204,6 +205,42 @@ class CLIDebugger {
 
     return contracts;
   }
+
+  /**
+   * This function is responsible for opening the debugger in vscode.
+   */
+  async openVSCodeDebug() {
+    // Sets the URL
+    const url = new URL("/debug", "vscode://trufflesuite-csi.truffle-vscode");
+
+    // Sets the query parameters
+    url.searchParams.set("txHash", this.txHash);
+    url.searchParams.set("workingDirectory", this.config.working_directory);
+    url.searchParams.set("providerUrl", this.config.provider.host);
+    url.searchParams.set("fetchExternal", this.config.fetchExternal);
+
+    // Opens VSCode based on OS
+    const openCommand = process.platform === "win32" ? `start ""` : `open`;
+    const commandLine = `${openCommand} "${url}"`;
+
+    // Defines the options for the child process. An abort signal is used to cancel the process, if necessary.
+    const controller = new AbortController();
+    const { signal } = controller;
+
+    // Executes the command
+    childProcess.exec(commandLine, { signal }, (stderr, error) => {
+      if (stderr) {
+        throw new Error(`Error opening the debug session in VSCode: ${stderr}`);
+      }
+      if (error) {
+        controller.abort();
+        throw new Error(`Error opening the debug session in VSCode: ${error}`);
+      }
+    });
+
+    // Sends a message to the user
+    this.config.logger.log("Opening truffle debugger in VSCode...");
+  }
 }
 
 module.exports = {