Add VS Code launch config for debugging sdk/runtime

Author: SteveSandersonMS

.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug Node.js SDK (chat sample)",
+      "type": "node",
+      "request": "launch",
+      "runtimeArgs": ["--enable-source-maps", "--import", "tsx"],
+      "program": "samples/chat.ts",
+      "cwd": "${workspaceFolder}/nodejs",
+      "env": {
+        "COPILOT_CLI_PATH": "${workspaceFolder}/../copilot-agent-runtime/dist-cli/index.js"
+      },
+      "console": "integratedTerminal",
+      "autoAttachChildProcesses": true,
+      "sourceMaps": true,
+      "resolveSourceMapLocations": [
+        "${workspaceFolder}/**",
+        "${workspaceFolder}/../copilot-agent-runtime/**"
+      ]
+    }
+  ]
+}

nodejs/samples/chat.ts

@@ -1,5 +1,8 @@
 import * as readline from "node:readline";
-import { CopilotClient, approveAll, type SessionEvent } from "@github/copilot-sdk";
+
+// Normally these should be imported from @github/copilot-sdk, but within this repo
+// we import from source to enable debugging into the SDK code.
+import { CopilotClient, approveAll, type SessionEvent } from "../src/index.js";
 
 async function main() {
     const client = new CopilotClient();

nodejs/src/client.ts

@@ -309,7 +309,9 @@ export class CopilotClient {
         this.onGetTraceContext = options.onGetTraceContext;
 
         this.options = {
-            cliPath: options.cliUrl ? undefined : options.cliPath || getBundledCliPath(),
+            cliPath: options.cliUrl
+                ? undefined
+                : options.cliPath || process.env.COPILOT_CLI_PATH || getBundledCliPath(),
             cliArgs: options.cliArgs ?? [],
             cwd: options.cwd ?? process.cwd(),
             port: options.port || 0,