opencode-windows-encoding 2.1.1 → 3.0.0

package/README.md

@@ -3,23 +3,35 @@
 [![npm version](https://img.shields.io/npm/v/opencode-windows-encoding)](https://www.npmjs.com/package/opencode-windows-encoding)
 [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
 
-OpenCode plugin that fixes UTF-8 encoding issues when executing PowerShell commands on Windows. Single-file, zero npm runtime dependencies.
+OpenCode plugin that fixes UTF-8 encoding issues when executing shell commands on Windows. Single-file, zero npm runtime dependencies.
 
 ## The Problem
 
-When OpenCode runs shell commands via PowerShell (`pwsh`) on Windows, the console output encoding defaults to the system locale (e.g., GBK for zh-CN). This causes garbled text when LLM-generated commands produce UTF-8 output — breaking file paths, error messages, and all non-ASCII content.
+When OpenCode runs shell commands on Windows, the console output encoding defaults to the system locale (e.g., GBK for zh-CN). This causes garbled text when LLM-generated commands produce UTF-8 output — breaking file paths, error messages, and all non-ASCII content.
 
 ## How It Works
 
-This plugin hooks into OpenCode's `tool.execute.before` event and injects UTF-8 encoding configuration before every PowerShell command:
+This plugin hooks into OpenCode's `tool.execute.before` event, detects the configured shell from OpenCode's config (`config.shell`), and injects the matching UTF-8 encoding configuration before every shell command:
 
+**PowerShell (`pwsh`):**
 ```powershell
-[Console]::OutputEncoding=[Console]::InputEncoding=[Text.Encoding]::UTF8;$OutputEncoding=[Text.Encoding]::UTF8;
+[Console]::OutputEncoding=[Console]::InputEncoding=[Text.Encoding]::UTF8;$OutputEncoding=[Text.Encoding]::UTF8;$env:PYTHONIOENCODING='utf-8';
+```
+
+**Bash / POSIX shells (`bash`, `zsh`, `sh`, ...):**
+```bash
+export LC_ALL=C.UTF-8; export LANG=C.UTF-8; export PYTHONIOENCODING=utf-8;
+```
+
+**Command Prompt (`cmd`):**
+```bat
+chcp 65001 >nul
 ```
 
 ### Key behaviors:
+- **Shell auto-detection** — reads `config.shell` from OpenCode at startup; falls back to platform detection (`pwsh` on Windows, `bash` elsewhere) when unset or unavailable
 - **Automatic injection** — applies to all `bash` and `shell` tool calls
-- **Idempotent** — skips commands that already contain `OutputEncoding` to avoid duplication
+- **Idempotent** — skips commands that already contain the shell's encoding marker (`OutputEncoding` / `LC_ALL` / `chcp`) to avoid duplication
 - **`set` prefix aware** — preserves PowerShell `set VAR="value"` prefixes before injecting
 - **Zero config** — works out of the box with no options
 - **Debug logging off by default** — set `OPENCODE_UTF8_DEBUG=1` to enable diagnostic logging to `$TMP/utf8-plugin.log`
@@ -74,8 +86,8 @@ Restart OpenCode to apply. No `npm install`, no build step.
 ## Requirements
 
 - **OpenCode** (any recent version with plugin support)
-- **PowerShell 7+** (`pwsh`)
 - **Windows** (this plugin is designed specifically for Windows encoding issues)
+- **Any of**: PowerShell 7+ (`pwsh`), Bash, or Command Prompt (`cmd`)
 
 ## Development
 

package/dist/utf8-encoding.d.ts

@@ -1,15 +1,16 @@
 import { PluginInput } from '@opencode-ai/plugin';
 
 /**
- * OpenCode Plugin — UTF-8 Encoding Fix for Windows + PowerShell
+ * OpenCode Plugin — UTF-8 Encoding Fix for Windows
  *
  * 单文件插件，可直接复制到 ~/.config/opencode/plugins/ 使用，无需 npm install。
  *
- * 工作原理：拦截所有 bash/shell 工具调用，在命令前注入 PowerShell
- * UTF-8 编码配置，解决 Windows 下中文/非 ASCII 字符乱码问题。
+ * 工作原理：拦截所有 bash/shell 工具调用，根据 opencode 当前配置的 shell
+ * （pwsh / bash / cmd）在命令前注入对应的 UTF-8 编码配置，解决中文/非 ASCII
+ * 字符乱码问题。
  */
 
-declare const Utf8EncodingPlugin: (_input: PluginInput) => Promise<{
+declare const Utf8EncodingPlugin: (input: PluginInput) => Promise<{
     "tool.execute.before": (input: {
         tool: string;
         sessionID: string;

package/dist/utf8-encoding.js

@@ -12,17 +12,54 @@ function flog(msg) {
   } catch {
   }
 }
-var UTF8_ENC = "[Console]::OutputEncoding=[Console]::InputEncoding=[Text.Encoding]::UTF8;$OutputEncoding=[Text.Encoding]::UTF8;$env:PYTHONIOENCODING='utf-8';";
+var ENC = {
+  pwsh: {
+    prefix: "[Console]::OutputEncoding=[Console]::InputEncoding=[Text.Encoding]::UTF8;$OutputEncoding=[Text.Encoding]::UTF8;$env:PYTHONIOENCODING='utf-8';",
+    sep: "\n",
+    marker: "OutputEncoding"
+  },
+  bash: {
+    prefix: "export LC_ALL=C.UTF-8; export LANG=C.UTF-8; export PYTHONIOENCODING=utf-8;",
+    sep: "\n",
+    marker: "LC_ALL"
+  },
+  cmd: {
+    prefix: "chcp 65001 >nul",
+    sep: " & ",
+    marker: "chcp"
+  }
+};
+function detectShellKind(shell) {
+  if (shell) {
+    const base = shell.replace(/\\/g, "/").split("/").pop().toLowerCase().replace(/\.exe$/, "");
+    if (base === "pwsh" || base === "powershell") return "pwsh";
+    if (base === "cmd") return "cmd";
+    return "bash";
+  }
+  return process.platform === "win32" ? "pwsh" : "bash";
+}
+async function resolveShellKind(client) {
+  try {
+    const res = await client.config.get();
+    const shell = res.data?.shell;
+    return detectShellKind(shell);
+  } catch {
+    return detectShellKind(void 0);
+  }
+}
 function stripSetPrefixes(cmd) {
   const m = cmd.match(/^((?:set\s+\w+="[^"]*"\s*&&\s*)+)/);
   if (m) return { prefixes: m[1], cleanCmd: cmd.slice(m[1].length) };
   return { prefixes: "", cleanCmd: cmd };
 }
-var Utf8EncodingPlugin = async (_input) => {
+var Utf8EncodingPlugin = async (input) => {
   flog("=== LOADED ===");
+  const kind = await resolveShellKind(input.client);
+  const { prefix, sep, marker } = ENC[kind];
+  flog(`shell kind: ${kind}`);
   return {
-    "tool.execute.before": async (input, output) => {
-      const tool = String(input?.tool ?? "");
+    "tool.execute.before": async (input2, output) => {
+      const tool = String(input2?.tool ?? "");
       flog(`[tool.before] tool="${tool}"`);
       if (tool !== "bash" && tool !== "shell") return;
       const args = output.args;
@@ -37,11 +74,11 @@ var Utf8EncodingPlugin = async (_input) => {
       }
       const { prefixes, cleanCmd } = stripSetPrefixes(cmd);
       flog(`  orig: ${cleanCmd.slice(0, 120)}`);
-      if (cleanCmd.includes("OutputEncoding")) {
+      if (cleanCmd.includes(marker)) {
         flog("  skip (idempotent)");
         return;
       }
-      args.command = prefixes + UTF8_ENC + "\n" + cleanCmd;
+      args.command = prefixes + prefix + sep + cleanCmd;
       flog("  INJECTED");
     }
   };

package/dist/utf8-encoding.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/utf8-encoding.ts"],"sourcesContent":["/**\n * OpenCode Plugin — UTF-8 Encoding Fix for Windows + PowerShell\n *\n * 单文件插件，可直接复制到 ~/.config/opencode/plugins/ 使用，无需 npm install。\n *\n * 工作原理：拦截所有 bash/shell 工具调用，在命令前注入 PowerShell\n * UTF-8 编码配置，解决 Windows 下中文/非 ASCII 字符乱码问题。\n */\n\nimport { appendFileSync } from \"node:fs\"\nimport { tmpdir } from \"node:os\"\nimport { join } from \"node:path\"\nimport type { PluginInput } from \"@opencode-ai/plugin\"\n\n// 调试日志（写入临时目录，默认关闭，设 OPENCODE_UTF8_DEBUG=1 开启）\nconst DEBUG = process.env.OPENCODE_UTF8_DEBUG === \"1\"\nconst LOG = join(tmpdir(), \"utf8-plugin.log\")\nfunction flog(msg: string) {\n  if (!DEBUG) return\n  try { appendFileSync(LOG, `[${new Date().toISOString()}] ${msg}\\n`, \"utf8\") } catch {}\n}\n\n// ── PowerShell UTF-8 编码前缀 ──\n// Console 编码覆盖所有进程；PYTHONIOENCODING 解决 Python 子进程 I/O 乱码\nconst UTF8_ENC =\n  \"[Console]::OutputEncoding=[Console]::InputEncoding=[Text.Encoding]::UTF8;\" +\n  \"$OutputEncoding=[Text.Encoding]::UTF8;\" +\n  \"$env:PYTHONIOENCODING='utf-8';\"\n\n/** 提取 opencode 在命令前追加的 set VAR=\"value\" && 前缀 */\nfunction stripSetPrefixes(cmd: string): { prefixes: string; cleanCmd: string } {\n  const m = cmd.match(/^((?:set\\s+\\w+=\"[^\"]*\"\\s*&&\\s*)+)/)\n  if (m) return { prefixes: m[1], cleanCmd: cmd.slice(m[1].length) }\n  return { prefixes: \"\", cleanCmd: cmd }\n}\n\nexport const Utf8EncodingPlugin = async (_input: PluginInput) => {\n  flog(\"=== LOADED ===\")\n\n  return {\n    \"tool.execute.before\": async (input: { tool: string; sessionID: string; callID: string }, output: { args: any }) => {\n      const tool = String(input?.tool ?? \"\")\n      flog(`[tool.before] tool=\"${tool}\"`)\n\n      if (tool !== \"bash\" && tool !== \"shell\") return\n\n      const args = output.args\n      if (!args) { flog(\"  no args\"); return }\n\n      const cmd = args.command\n      if (typeof cmd !== \"string\" || !cmd) {\n        flog(`  args keys: ${JSON.stringify(Object.keys(args))}`)\n        return\n      }\n\n      const { prefixes, cleanCmd } = stripSetPrefixes(cmd)\n      flog(`  orig: ${cleanCmd.slice(0, 120)}`)\n\n      // 防止重复注入\n      if (cleanCmd.includes(\"OutputEncoding\")) { flog(\"  skip (idempotent)\"); return }\n\n      args.command = prefixes + UTF8_ENC + \"\\n\" + cleanCmd\n      flog(\"  INJECTED\")\n    },\n  }\n}\n\nexport default Utf8EncodingPlugin\n"],"mappings":";AASA,SAAS,sBAAsB;AAC/B,SAAS,cAAc;AACvB,SAAS,YAAY;AAIrB,IAAM,QAAQ,QAAQ,IAAI,wBAAwB;AAClD,IAAM,MAAM,KAAK,OAAO,GAAG,iBAAiB;AAC5C,SAAS,KAAK,KAAa;AACzB,MAAI,CAAC,MAAO;AACZ,MAAI;AAAE,mBAAe,KAAK,KAAI,oBAAI,KAAK,GAAE,YAAY,CAAC,KAAK,GAAG;AAAA,GAAM,MAAM;AAAA,EAAE,QAAQ;AAAA,EAAC;AACvF;AAIA,IAAM,WACJ;AAKF,SAAS,iBAAiB,KAAqD;AAC7E,QAAM,IAAI,IAAI,MAAM,mCAAmC;AACvD,MAAI,EAAG,QAAO,EAAE,UAAU,EAAE,CAAC,GAAG,UAAU,IAAI,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE;AACjE,SAAO,EAAE,UAAU,IAAI,UAAU,IAAI;AACvC;AAEO,IAAM,qBAAqB,OAAO,WAAwB;AAC/D,OAAK,gBAAgB;AAErB,SAAO;AAAA,IACL,uBAAuB,OAAO,OAA4D,WAA0B;AAClH,YAAM,OAAO,OAAO,OAAO,QAAQ,EAAE;AACrC,WAAK,uBAAuB,IAAI,GAAG;AAEnC,UAAI,SAAS,UAAU,SAAS,QAAS;AAEzC,YAAM,OAAO,OAAO;AACpB,UAAI,CAAC,MAAM;AAAE,aAAK,WAAW;AAAG;AAAA,MAAO;AAEvC,YAAM,MAAM,KAAK;AACjB,UAAI,OAAO,QAAQ,YAAY,CAAC,KAAK;AACnC,aAAK,gBAAgB,KAAK,UAAU,OAAO,KAAK,IAAI,CAAC,CAAC,EAAE;AACxD;AAAA,MACF;AAEA,YAAM,EAAE,UAAU,SAAS,IAAI,iBAAiB,GAAG;AACnD,WAAK,WAAW,SAAS,MAAM,GAAG,GAAG,CAAC,EAAE;AAGxC,UAAI,SAAS,SAAS,gBAAgB,GAAG;AAAE,aAAK,qBAAqB;AAAG;AAAA,MAAO;AAE/E,WAAK,UAAU,WAAW,WAAW,OAAO;AAC5C,WAAK,YAAY;AAAA,IACnB;AAAA,EACF;AACF;AAEA,IAAO,wBAAQ;","names":[]}
+{"version":3,"sources":["../src/utf8-encoding.ts"],"sourcesContent":["/**\n * OpenCode Plugin — UTF-8 Encoding Fix for Windows\n *\n * 单文件插件，可直接复制到 ~/.config/opencode/plugins/ 使用，无需 npm install。\n *\n * 工作原理：拦截所有 bash/shell 工具调用，根据 opencode 当前配置的 shell\n * （pwsh / bash / cmd）在命令前注入对应的 UTF-8 编码配置，解决中文/非 ASCII\n * 字符乱码问题。\n */\n\nimport { appendFileSync } from \"node:fs\"\nimport { tmpdir } from \"node:os\"\nimport { join } from \"node:path\"\nimport type { PluginInput } from \"@opencode-ai/plugin\"\n\n// 调试日志（写入临时目录，默认关闭，设 OPENCODE_UTF8_DEBUG=1 开启）\nconst DEBUG = process.env.OPENCODE_UTF8_DEBUG === \"1\"\nconst LOG = join(tmpdir(), \"utf8-plugin.log\")\nfunction flog(msg: string) {\n  if (!DEBUG) return\n  try { appendFileSync(LOG, `[${new Date().toISOString()}] ${msg}\\n`, \"utf8\") } catch {}\n}\n\ntype ShellKind = \"pwsh\" | \"bash\" | \"cmd\"\n\n// ── 各 shell 的 UTF-8 编码前缀与命令分隔符 ──\nconst ENC: Record<ShellKind, { prefix: string; sep: string; marker: string }> = {\n  pwsh: {\n    prefix:\n      \"[Console]::OutputEncoding=[Console]::InputEncoding=[Text.Encoding]::UTF8;\" +\n      \"$OutputEncoding=[Text.Encoding]::UTF8;\" +\n      \"$env:PYTHONIOENCODING='utf-8';\",\n    sep: \"\\n\",\n    marker: \"OutputEncoding\",\n  },\n  bash: {\n    prefix: \"export LC_ALL=C.UTF-8; export LANG=C.UTF-8; export PYTHONIOENCODING=utf-8;\",\n    sep: \"\\n\",\n    marker: \"LC_ALL\",\n  },\n  cmd: {\n    prefix: \"chcp 65001 >nul\",\n    sep: \" & \",\n    marker: \"chcp\",\n  },\n}\n\n/** 由 config.shell 的值归一化为 shell 类型 */\nfunction detectShellKind(shell: string | undefined): ShellKind {\n  if (shell) {\n    const base = shell\n      .replace(/\\\\/g, \"/\")\n      .split(\"/\")\n      .pop()!\n      .toLowerCase()\n      .replace(/\\.exe$/, \"\")\n    if (base === \"pwsh\" || base === \"powershell\") return \"pwsh\"\n    if (base === \"cmd\") return \"cmd\"\n    return \"bash\" // bash / zsh / sh / dash / ksh 等 POSIX shell\n  }\n  // 未配置：按平台回退（opencode Windows 默认优先 pwsh）\n  return process.platform === \"win32\" ? \"pwsh\" : \"bash\"\n}\n\n/** 读取 opencode 配置中的 shell，失败时按平台回退 */\nasync function resolveShellKind(client: PluginInput[\"client\"]): Promise<ShellKind> {\n  try {\n    const res = await client.config.get()\n    const shell = (res.data as unknown as { shell?: string } | undefined)?.shell\n    return detectShellKind(shell)\n  } catch {\n    return detectShellKind(undefined)\n  }\n}\n\n/** 提取 opencode 在命令前追加的 set VAR=\"value\" && 前缀 */\nfunction stripSetPrefixes(cmd: string): { prefixes: string; cleanCmd: string } {\n  const m = cmd.match(/^((?:set\\s+\\w+=\"[^\"]*\"\\s*&&\\s*)+)/)\n  if (m) return { prefixes: m[1], cleanCmd: cmd.slice(m[1].length) }\n  return { prefixes: \"\", cleanCmd: cmd }\n}\n\nexport const Utf8EncodingPlugin = async (input: PluginInput) => {\n  flog(\"=== LOADED ===\")\n\n  const kind = await resolveShellKind(input.client)\n  const { prefix, sep, marker } = ENC[kind]\n  flog(`shell kind: ${kind}`)\n\n  return {\n    \"tool.execute.before\": async (input: { tool: string; sessionID: string; callID: string }, output: { args: any }) => {\n      const tool = String(input?.tool ?? \"\")\n      flog(`[tool.before] tool=\"${tool}\"`)\n\n      if (tool !== \"bash\" && tool !== \"shell\") return\n\n      const args = output.args\n      if (!args) { flog(\"  no args\"); return }\n\n      const cmd = args.command\n      if (typeof cmd !== \"string\" || !cmd) {\n        flog(`  args keys: ${JSON.stringify(Object.keys(args))}`)\n        return\n      }\n\n      const { prefixes, cleanCmd } = stripSetPrefixes(cmd)\n      flog(`  orig: ${cleanCmd.slice(0, 120)}`)\n\n      // 防止重复注入\n      if (cleanCmd.includes(marker)) { flog(\"  skip (idempotent)\"); return }\n\n      args.command = prefixes + prefix + sep + cleanCmd\n      flog(\"  INJECTED\")\n    },\n  }\n}\n\nexport default Utf8EncodingPlugin\n"],"mappings":";AAUA,SAAS,sBAAsB;AAC/B,SAAS,cAAc;AACvB,SAAS,YAAY;AAIrB,IAAM,QAAQ,QAAQ,IAAI,wBAAwB;AAClD,IAAM,MAAM,KAAK,OAAO,GAAG,iBAAiB;AAC5C,SAAS,KAAK,KAAa;AACzB,MAAI,CAAC,MAAO;AACZ,MAAI;AAAE,mBAAe,KAAK,KAAI,oBAAI,KAAK,GAAE,YAAY,CAAC,KAAK,GAAG;AAAA,GAAM,MAAM;AAAA,EAAE,QAAQ;AAAA,EAAC;AACvF;AAKA,IAAM,MAA0E;AAAA,EAC9E,MAAM;AAAA,IACJ,QACE;AAAA,IAGF,KAAK;AAAA,IACL,QAAQ;AAAA,EACV;AAAA,EACA,MAAM;AAAA,IACJ,QAAQ;AAAA,IACR,KAAK;AAAA,IACL,QAAQ;AAAA,EACV;AAAA,EACA,KAAK;AAAA,IACH,QAAQ;AAAA,IACR,KAAK;AAAA,IACL,QAAQ;AAAA,EACV;AACF;AAGA,SAAS,gBAAgB,OAAsC;AAC7D,MAAI,OAAO;AACT,UAAM,OAAO,MACV,QAAQ,OAAO,GAAG,EAClB,MAAM,GAAG,EACT,IAAI,EACJ,YAAY,EACZ,QAAQ,UAAU,EAAE;AACvB,QAAI,SAAS,UAAU,SAAS,aAAc,QAAO;AACrD,QAAI,SAAS,MAAO,QAAO;AAC3B,WAAO;AAAA,EACT;AAEA,SAAO,QAAQ,aAAa,UAAU,SAAS;AACjD;AAGA,eAAe,iBAAiB,QAAmD;AACjF,MAAI;AACF,UAAM,MAAM,MAAM,OAAO,OAAO,IAAI;AACpC,UAAM,QAAS,IAAI,MAAoD;AACvE,WAAO,gBAAgB,KAAK;AAAA,EAC9B,QAAQ;AACN,WAAO,gBAAgB,MAAS;AAAA,EAClC;AACF;AAGA,SAAS,iBAAiB,KAAqD;AAC7E,QAAM,IAAI,IAAI,MAAM,mCAAmC;AACvD,MAAI,EAAG,QAAO,EAAE,UAAU,EAAE,CAAC,GAAG,UAAU,IAAI,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE;AACjE,SAAO,EAAE,UAAU,IAAI,UAAU,IAAI;AACvC;AAEO,IAAM,qBAAqB,OAAO,UAAuB;AAC9D,OAAK,gBAAgB;AAErB,QAAM,OAAO,MAAM,iBAAiB,MAAM,MAAM;AAChD,QAAM,EAAE,QAAQ,KAAK,OAAO,IAAI,IAAI,IAAI;AACxC,OAAK,eAAe,IAAI,EAAE;AAE1B,SAAO;AAAA,IACL,uBAAuB,OAAOA,QAA4D,WAA0B;AAClH,YAAM,OAAO,OAAOA,QAAO,QAAQ,EAAE;AACrC,WAAK,uBAAuB,IAAI,GAAG;AAEnC,UAAI,SAAS,UAAU,SAAS,QAAS;AAEzC,YAAM,OAAO,OAAO;AACpB,UAAI,CAAC,MAAM;AAAE,aAAK,WAAW;AAAG;AAAA,MAAO;AAEvC,YAAM,MAAM,KAAK;AACjB,UAAI,OAAO,QAAQ,YAAY,CAAC,KAAK;AACnC,aAAK,gBAAgB,KAAK,UAAU,OAAO,KAAK,IAAI,CAAC,CAAC,EAAE;AACxD;AAAA,MACF;AAEA,YAAM,EAAE,UAAU,SAAS,IAAI,iBAAiB,GAAG;AACnD,WAAK,WAAW,SAAS,MAAM,GAAG,GAAG,CAAC,EAAE;AAGxC,UAAI,SAAS,SAAS,MAAM,GAAG;AAAE,aAAK,qBAAqB;AAAG;AAAA,MAAO;AAErE,WAAK,UAAU,WAAW,SAAS,MAAM;AACzC,WAAK,YAAY;AAAA,IACnB;AAAA,EACF;AACF;AAEA,IAAO,wBAAQ;","names":["input"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-windows-encoding",
-  "version": "2.1.1",
+  "version": "3.0.0",
   "description": "OpenCode plugin to fix UTF-8 encoding issues in PowerShell on Windows",
   "type": "module",
   "main": "./dist/utf8-encoding.js",