opencode-gbk-tools 0.1.9 → 0.1.10

package/README.md

@@ -1,8 +1,8 @@
 # opencode-gbk-tools
 
-为 OpenCode 提供一套面向 `GBK` / `GB18030` 编码文本文件的自定义工具与专用 agent。
+为 OpenCode 提供一套自动识别编码的文本工具，以及面向 `GBK` / `GB18030` 的专用工具。
 
-解决 OpenCode 内置工具无法正确读写 GBK 编码文件的问题。
+解决 OpenCode 内置工具难以稳定处理非 UTF-8 文本文件的问题，并让所有 agents 默认优先使用可保留原编码的 `text_*` 工具。
 
 ---
 
@@ -10,11 +10,14 @@
 
 | 工具 | 用途 |
 |------|------|
+| `text_read` | 自动识别文件编码并按行读取，优先用于通用文本文件 |
+| `text_write` | 自动保持已有文件编码、BOM 和换行风格后写入 |
+| `text_edit` | 自动保持已有文件编码、BOM 和换行风格后编辑 |
 | `gbk_read` | 读取 GBK/GB18030 文件，支持分页、尾部预览 |
 | `gbk_write` | 写入或追加内容到 GBK 文件（`append=true` 支持追加） |
 | `gbk_edit` | 精确替换 GBK 文件中的指定文本块 |
 | `gbk_search` | 在 GBK 文件中搜索关键词，返回行号和上下文 |
-| `gbk-engine` | 专用 agent，引导 AI 正确使用上述工具 |
+| 本地/全局 plugin 规则 | 给所有 agents 注入“优先使用 `text_*`”的系统提示 |
 
 ---
 
@@ -42,6 +45,28 @@ npx opencode-gbk-tools uninstall
 
 ## 工具使用说明
 
+### text_read / text_write / text_edit
+
+- 默认 `encoding=auto`
+- 已有文件会尽量保持：
+  - 原编码
+  - BOM
+  - 换行风格
+- 当前支持：
+  - `utf8`
+  - `utf8-bom`
+  - `utf16le`
+  - `utf16be`
+  - `gbk`
+  - `gb18030`
+
+优先使用建议：
+
+```text
+通用文本文件：text_read / text_write / text_edit
+明确 GBK 文件：gbk_read / gbk_write / gbk_edit / gbk_search
+```
+
 ### gbk_read — 读取文件
 
 ```
@@ -108,7 +133,8 @@ gbk_write(filePath="文件路径", content="\r\n新增内容", append=true)  #
 ## 已知限制
 
 - 只支持文本文件，不支持二进制文件
-- 只支持 `gbk` 和 `gb18030` 编码
+- 自动识别目前只覆盖 `utf8`、`utf8-bom`、`utf16le`、`utf16be`、`gbk`、`gb18030`
+- 编码检测在歧义场景下可能返回 `TEXT_UNKNOWN_ENCODING`，此时应显式指定 `encoding`
 - 对无法映射的字符沿用 `iconv-lite` 默认替代行为
 
 ---
@@ -133,6 +159,7 @@ A：检查 `oldString` 是否包含了行号前缀（如 `"3787: "`），去掉
 
 | 版本 | 说明 |
 |------|------|
+| 0.1.10 | 新增 `text_read` / `text_write` / `text_edit`，自动识别并保持原编码、BOM 与换行风格；同时通过 plugin 规则让所有 agents 默认优先使用 `text_*` |
 | 0.1.9 | `gbk_edit` 修复精确匹配路径写入 CRLF 文件时换行风格变 mixed 的 bug |
 | 0.1.8 | `gbk_write` 新增 `append=true` 追加模式 |
 | 0.1.7 | `gbk_edit` 自动剥离行号前缀后重试匹配 |

package/dist/cli/index.js

@@ -60,7 +60,7 @@ function resolveTargetBase(target, cwd) {
 // src/cli/install.ts
 async function installCommand(args) {
   const targetBase = resolveTargetBase(args.target, args.cwd);
-  const allowedArtifacts = new Set(args.artifacts ?? ["tool", "agent"]);
+  const allowedArtifacts = new Set(args.artifacts ?? ["tool", "agent", "plugin"]);
   const releaseManifest = JSON.parse(await fs3.readFile(path3.join(args.packageRoot, "dist", "release-manifest.json"), "utf8"));
   const selectedArtifacts = releaseManifest.artifacts.filter((artifact) => allowedArtifacts.has(artifact.kind));
   const existingManifest = await loadInstalledManifest(targetBase);
@@ -70,7 +70,7 @@ async function installCommand(args) {
       throw new Error(`\u68C0\u6D4B\u5230\u672A\u53D7\u7BA1\u6587\u4EF6\u51B2\u7A81: ${targetPath}`);
     }
     await ensureDir(path3.dirname(targetPath));
-    const sourceRoot = artifact.kind === "tool" ? path3.join(args.packageRoot, "dist", "opencode-tools") : path3.join(args.packageRoot, "dist", "agents");
+    const sourceRoot = artifact.kind === "tool" ? path3.join(args.packageRoot, "dist", "opencode-tools") : artifact.kind === "agent" ? path3.join(args.packageRoot, "dist", "agents") : path3.join(args.packageRoot, "dist", "plugins");
     await fs3.copyFile(path3.join(sourceRoot, path3.basename(artifact.relativePath)), targetPath);
   }
   const installedManifest = {
@@ -181,7 +181,7 @@ async function setupCommand(args) {
   await fs6.mkdir(configBase, { recursive: true });
   const configPath = await resolveConfigFile(configBase);
   await ensurePluginConfigured(configPath, pluginName);
-  const installResult = await installCommand({ ...args, force: true, artifacts: ["agent"] });
+  const installResult = await installCommand({ ...args, force: true, artifacts: ["agent", "plugin"] });
   return {
     configPath,
     targetBase: installResult.targetBase

package/dist/opencode-tools/gbk_edit.js

@@ -16779,6 +16779,17 @@ and avoid false matches. Scoped edits also improve performance on very large fil
   },
   async execute(args, context) {
     const result = await replaceGbkFileText({ ...args, context });
+    context.metadata({
+      title: `GBK \u7F16\u8F91 ${result.encoding.toUpperCase()} x${result.replacements}`,
+      metadata: {
+        filePath: result.filePath,
+        encoding: result.encoding,
+        replacements: result.replacements,
+        occurrencesBefore: result.occurrencesBefore,
+        bytesRead: result.bytesRead,
+        bytesWritten: result.bytesWritten
+      }
+    });
     return JSON.stringify(result, null, 2);
   }
 });

package/dist/opencode-tools/gbk_read.js

@@ -16632,6 +16632,19 @@ Workflow when truncated=true:
   },
   async execute(args, context) {
     const result = await readGbkFile({ ...args, context });
+    const lineRange = `${result.startLine}-${result.endLine}`;
+    context.metadata({
+      title: `GBK \u8BFB\u53D6 ${result.encoding.toUpperCase()} ${lineRange}`,
+      metadata: {
+        filePath: result.filePath,
+        encoding: result.encoding,
+        lineRange,
+        totalLines: result.totalLines,
+        newlineStyle: result.newlineStyle,
+        truncated: result.truncated,
+        tail: result.tail
+      }
+    });
     return JSON.stringify(result, null, 2);
   }
 });

package/dist/opencode-tools/gbk_search.js

@@ -16454,6 +16454,15 @@ Workflow for large files:
   },
   async execute(args, context) {
     const result = await searchGbkFile({ ...args, context });
+    context.metadata({
+      title: `GBK \u641C\u7D22 ${result.encoding.toUpperCase()} ${result.matchCount} \u547D\u4E2D`,
+      metadata: {
+        filePath: result.filePath,
+        encoding: result.encoding,
+        totalLines: result.totalLines,
+        matchCount: result.matchCount
+      }
+    });
     return JSON.stringify(result, null, 2);
   }
 });

package/dist/opencode-tools/gbk_write.js

@@ -16432,6 +16432,18 @@ var gbk_write_default = tool({
   },
   async execute(args, context) {
     const result = await writeGbkFile({ ...args, context });
+    const action = result.appended ? "\u8FFD\u52A0" : result.overwritten ? "\u8986\u76D6" : "\u5199\u5165";
+    context.metadata({
+      title: `GBK ${action} ${result.encoding.toUpperCase()}`,
+      metadata: {
+        filePath: result.filePath,
+        encoding: result.encoding,
+        created: result.created,
+        overwritten: result.overwritten,
+        appended: result.appended ?? false,
+        bytesWritten: result.bytesWritten
+      }
+    });
     return JSON.stringify(result, null, 2);
   }
 });