@github/copilot-sdk 1.0.29 → 1.0.30-preview.1

package/docs/examples.md

@@ -25,7 +25,8 @@ const session = await joinSession({
 >
 > - Use `process.platform === "win32"` to detect Windows at runtime.
 > - Clipboard: `pbcopy` on macOS, `clip` on Windows.
-> - Use `exec()` instead of `execFile()` for `.cmd` scripts like `code`, `npx`, `npm` on Windows.
+> - Never interpolate tool arguments into `exec()` or shell command strings. Use `execFile()` or `spawn()` with argument arrays.
+> - On Windows, `.cmd` and `.bat` wrappers require a shell. Invoke the actual executable or use the library's Node.js API instead.
 > - PowerShell stderr redirection uses `*>&1` instead of `2>&1`.
 
 ---
@@ -257,16 +258,41 @@ hooks: {
 
 Use `onPostToolUse` to run side effects after a tool completes.
 
+On macOS and Linux, install the `code` command in your `PATH`. On Windows,
+set `VSCODE_EXECUTABLE` to the absolute path of your installed `Code.exe`
+(for example, `C:\Users\you\AppData\Local\Programs\Microsoft VS Code\Code.exe`),
+not the `code.cmd` wrapper. This is trusted extension configuration, not a
+tool argument.
+
 ```js
-import { exec } from "node:child_process";
+import { spawn } from "node:child_process";
+import { isAbsolute, resolve } from "node:path";
+
+const isWindows = process.platform === "win32";
+const vscodeExecutable = isWindows ? process.env.VSCODE_EXECUTABLE : "code";
+if (!vscodeExecutable || (isWindows && !isAbsolute(vscodeExecutable))) {
+    throw new Error("Set VSCODE_EXECUTABLE to the absolute path of Code.exe.");
+}
+const editorEnv = { ...process.env };
+// The native editor must open the file, not run it as a Node.js script.
+delete editorEnv.ELECTRON_RUN_AS_NODE;
 
 hooks: {
     onPostToolUse: async (input) => {
         if (input.toolName === "create" || input.toolName === "edit") {
             const filePath = input.toolArgs?.path;
-            if (filePath) {
-                // Open the file in VS Code
-                exec(`code "${filePath}"`, () => {});
+            if (typeof filePath === "string" && filePath) {
+                try {
+                    const child = spawn(vscodeExecutable, [resolve(filePath)], {
+                        detached: true,
+                        stdio: "ignore",
+                        env: editorEnv,
+                    });
+                    child.on("error", (err) => console.error("Could not open file in VS Code:", err.message));
+                    child.unref();
+                } catch (err) {
+                    console.error("Could not open file in VS Code:", err.message);
+                }
             }
         }
     },
@@ -295,20 +321,34 @@ hooks: {
 
 ### Running a linter after every file edit
 
+Install ESLint in the session's working directory (`npm install --save-dev eslint`)
+and configure it for TypeScript. Only run this hook in workspaces whose ESLint
+configuration and plugins you trust. Use its Node.js API rather than `npx`:
+an extension's `process.execPath` can be the Copilot single-executable binary,
+not a general-purpose Node.js interpreter.
+
 ```js
-import { exec } from "node:child_process";
+import { createRequire } from "node:module";
+import { resolve } from "node:path";
+import { pathToFileURL } from "node:url";
+
+const require = createRequire(import.meta.url);
 
 hooks: {
     onPostToolUse: async (input) => {
         if (input.toolName === "edit") {
             const filePath = input.toolArgs?.path;
-            if (filePath?.endsWith(".ts")) {
-                const result = await new Promise((resolve) => {
-                    exec(`npx eslint "${filePath}"`, (err, stdout) => {
-                        resolve(err ? stdout : "No lint errors.");
-                    });
-                });
-                return { additionalContext: `Lint result: ${result}` };
+            if (typeof filePath === "string" && filePath.endsWith(".ts")) {
+                try {
+                    const eslintModule = require.resolve("eslint", { paths: [process.cwd()] });
+                    const { ESLint } = await import(pathToFileURL(eslintModule).href);
+                    const eslint = new ESLint({ cwd: process.cwd(), globInputPaths: false });
+                    const results = await eslint.lintFiles([resolve(filePath)]);
+                    const formatter = await eslint.loadFormatter("stylish");
+                    return { additionalContext: `Lint result: ${formatter.format(results) || "No lint errors."}` };
+                } catch (err) {
+                    return { additionalContext: `Lint failed: ${err.message}` };
+                }
             }
         }
     },
@@ -603,11 +643,22 @@ const session = await joinSession({
 
 An extension that combines tools, hooks, and events.
 
+Use the same VS Code setup as in
+[Reacting when the agent creates or edits a file](#reacting-when-the-agent-creates-or-edits-a-file).
+
 ```js
-import { execFile, exec } from "node:child_process";
+import { execFile, spawn } from "node:child_process";
+import { isAbsolute, resolve } from "node:path";
 import { joinSession } from "@github/copilot-sdk/extension";
 
 const isWindows = process.platform === "win32";
+const vscodeExecutable = isWindows ? process.env.VSCODE_EXECUTABLE : "code";
+if (!vscodeExecutable || (isWindows && !isAbsolute(vscodeExecutable))) {
+    throw new Error("Set VSCODE_EXECUTABLE to the absolute path of Code.exe.");
+}
+const editorEnv = { ...process.env };
+// The native editor must open the file, not run it as a Node.js script.
+delete editorEnv.ELECTRON_RUN_AS_NODE;
 let copyNextResponse = false;
 
 function copyToClipboard(text) {
@@ -617,8 +668,17 @@ function copyToClipboard(text) {
 }
 
 function openInEditor(filePath) {
-    if (isWindows) exec(`code "${filePath}"`, () => {});
-    else execFile("code", [filePath], () => {});
+    try {
+        const child = spawn(vscodeExecutable, [resolve(filePath)], {
+            detached: true,
+            stdio: "ignore",
+            env: editorEnv,
+        });
+        child.on("error", (err) => console.error("Could not open file in VS Code:", err.message));
+        child.unref();
+    } catch (err) {
+        console.error("Could not open file in VS Code:", err.message);
+    }
 }
 
 const session = await joinSession({
@@ -645,7 +705,7 @@ const session = await joinSession({
         onPostToolUse: async (input) => {
             if (input.toolName === "create" || input.toolName === "edit") {
                 const filePath = input.toolArgs?.path;
-                if (filePath) openInEditor(filePath);
+                if (typeof filePath === "string" && filePath) openInEditor(filePath);
             }
         },
     },

package/package.json

@@ -5,8 +5,8 @@
         "url": "https://github.com/github/copilot-agent-runtime.git",
         "directory": "src/sdk/nodejs"
     },
-    "version": "1.0.29",
-    "copilotCliVersion": "1.0.107",
+    "version": "1.0.30-preview.1",
+    "copilotCliVersion": "1.0.108-1",
     "description": "TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC",
     "main": "./dist/cjs/index.js",
     "types": "./dist/index.d.ts",
@@ -52,6 +52,7 @@
         "lint:fix": "eslint --fix \"src/**/*.ts\" \"test/**/*.ts\"",
         "typecheck": "tsc --noEmit && tsc --noEmit -p tsconfig.test.json",
         "generate": "cd ../scripts/codegen && npm run generate",
+        "generate:java-compat-fixtures": "tsx test/generate-java-compat-fixtures.ts",
         "set:cli-version": "node scripts/set-cli-version.js",
         "update:protocol-version": "tsx scripts/update-protocol-version.ts",
         "vendor:tools": "tsx scripts/vendor-build-tools.ts",
@@ -103,7 +104,7 @@
     "overrides": {
         "file-entry-cache": "$file-entry-cache",
         "glob": "$glob",
-        "minimatch": "^11.0.4",
+        "minimatch": "11.0.2",
         "prettier": "$prettier",
         "vite": "$vite"
     },
@@ -117,18 +118,18 @@
         "README.md"
     ],
     "copilotRuntime": {
-        "sourceSha": "2bfb456b9e0878c4cb3dd05cb9877ac9c97cbd68",
-        "version": "1.0.107",
+        "sourceSha": "b4db2d4d6e538963777bfe225a166511699de1e7",
+        "version": "1.0.108-1",
         "visibility": "public"
     },
     "optionalDependencies": {
-        "@github/copilot-sdk-darwin-arm64": "1.0.29",
-        "@github/copilot-sdk-darwin-x64": "1.0.29",
-        "@github/copilot-sdk-linux-arm64": "1.0.29",
-        "@github/copilot-sdk-linux-x64": "1.0.29",
-        "@github/copilot-sdk-linuxmusl-arm64": "1.0.29",
-        "@github/copilot-sdk-linuxmusl-x64": "1.0.29",
-        "@github/copilot-sdk-win32-arm64": "1.0.29",
-        "@github/copilot-sdk-win32-x64": "1.0.29"
+        "@github/copilot-sdk-darwin-arm64": "1.0.30-preview.1",
+        "@github/copilot-sdk-darwin-x64": "1.0.30-preview.1",
+        "@github/copilot-sdk-linux-arm64": "1.0.30-preview.1",
+        "@github/copilot-sdk-linux-x64": "1.0.30-preview.1",
+        "@github/copilot-sdk-linuxmusl-arm64": "1.0.30-preview.1",
+        "@github/copilot-sdk-linuxmusl-x64": "1.0.30-preview.1",
+        "@github/copilot-sdk-win32-arm64": "1.0.30-preview.1",
+        "@github/copilot-sdk-win32-x64": "1.0.30-preview.1"
     }
 }