opencode-gbk-tools 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,78 @@
+# opencode-gbk-tools
+
+为 OpenCode 提供一套面向 `GBK` / `GB18030` 文本工程的自定义工具与专用 agent。
+
+## 功能
+
+- `gbk_read`
+- `gbk_write`
+- `gbk_edit`
+- `gbk-engine` agent
+
+## 安装
+
+一次性使用：
+
+```bash
+npx opencode-gbk-tools install
+```
+
+全局安装后使用：
+
+```bash
+npm install -g opencode-gbk-tools
+opencode-gbk install
+```
+
+安装到当前项目：
+
+```bash
+opencode-gbk install --project
+```
+
+## 目录
+
+- 全局安装目标：`~/.config/opencode`
+- 项目安装目标：当前命令执行目录下的 `.opencode`
+
+## CLI
+
+```bash
+opencode-gbk install
+opencode-gbk install --project
+opencode-gbk install --force
+
+opencode-gbk uninstall
+opencode-gbk uninstall --project
+
+opencode-gbk doctor
+opencode-gbk doctor --project
+```
+
+## Agent
+
+安装后会生成 `gbk-engine`。
+
+它的目标是：
+
+- 文件内容读取必须走 `gbk_read`
+- 文件内容写入必须走 `gbk_write`
+- 文件内容修改必须走 `gbk_edit`
+- 内置 `read`、`edit`、`grep` 被限制
+
+## 已知限制
+
+- 只支持文本文件，不支持二进制文件
+- 首版不做自动编码识别
+- 只支持 `gbk` 和 `gb18030`
+- `edit: deny` 在 OpenCode 中会一起限制内置 `write`、`patch`、`multiedit`
+- 对无法映射的字符沿用 `iconv-lite` 默认替代行为
+
+## 发布
+
+```bash
+npm run check
+npm test
+npm run build
+npm pack --dry-run
+```

package/bin/opencode-gbk.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+
+import { main } from "../dist/cli/index.js"
+
+main(process.argv.slice(2)).catch((error) => {
+  const message = error instanceof Error ? error.message : String(error)
+  console.error(message)
+  process.exitCode = 1
+})

package/dist/agents/gbk-engine.md

@@ -0,0 +1,25 @@
+---
+description: 处理 GBK/GB18030 编码文件的专用代理，只使用 gbk_read、gbk_write、gbk_edit
+mode: primary
+permission:
+  read: deny
+  edit: deny
+  grep: deny
+  webfetch: ask
+  bash:
+    "*": deny
+    "git status*": allow
+    "npm view *": allow
+---
+
+你是一个专门处理 GBK/GB18030 文本文件的代理。
+
+规则：
+- 读取文件时优先使用 `gbk_read`
+- 创建或覆盖文件时优先使用 `gbk_write`
+- 修改已有文件时优先使用 `gbk_edit`
+- 文件发现可使用 `glob`，但文件内容读取必须使用 `gbk_read`
+- 禁止依赖内置 `read`、`grep`、`write`、`edit`、`patch`
+- `edit: deny` 同时覆盖内置 `write`、`patch`、`multiedit`
+- 如果用户请求涉及 UTF-8 文件或二进制文件，先明确说明不适用
+- 若目标文件编码不确定，先提醒用户确认是 `gbk` 还是 `gb18030`

package/dist/cli/index.js

@@ -0,0 +1,162 @@
+// src/cli/index.ts
+import path6 from "path";
+import { fileURLToPath } from "url";
+
+// src/cli/install.ts
+import fs3 from "fs/promises";
+import path3 from "path";
+
+// src/cli/fs.ts
+import crypto from "crypto";
+import fs from "fs/promises";
+async function ensureDir(directory) {
+  await fs.mkdir(directory, { recursive: true });
+}
+async function computeFileHash(filePath) {
+  const buffer = await fs.readFile(filePath);
+  return crypto.createHash("sha256").update(buffer).digest("hex");
+}
+async function pathExists(filePath) {
+  try {
+    await fs.access(filePath);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+// src/cli/manifest.ts
+import fs2 from "fs/promises";
+import path from "path";
+function getInstalledManifestPath(targetBase) {
+  return path.join(targetBase, "opencode-gbk-tools.manifest.json");
+}
+async function loadInstalledManifest(targetBase) {
+  try {
+    const content = await fs2.readFile(getInstalledManifestPath(targetBase), "utf8");
+    return JSON.parse(content);
+  } catch {
+    return null;
+  }
+}
+async function writeInstalledManifest(targetBase, manifest) {
+  await fs2.mkdir(targetBase, { recursive: true });
+  await fs2.writeFile(getInstalledManifestPath(targetBase), JSON.stringify(manifest, null, 2), "utf8");
+}
+
+// src/cli/paths.ts
+import os from "os";
+import path2 from "path";
+function getGlobalTargetBase() {
+  return path2.join(os.homedir(), ".config", "opencode");
+}
+function getProjectTargetBase(cwd) {
+  return path2.join(cwd, ".opencode");
+}
+function resolveTargetBase(target, cwd) {
+  return target === "global" ? getGlobalTargetBase() : getProjectTargetBase(cwd);
+}
+
+// src/cli/install.ts
+async function installCommand(args) {
+  const targetBase = resolveTargetBase(args.target, args.cwd);
+  const releaseManifest = JSON.parse(await fs3.readFile(path3.join(args.packageRoot, "dist", "release-manifest.json"), "utf8"));
+  const existingManifest = await loadInstalledManifest(targetBase);
+  for (const artifact of releaseManifest.artifacts) {
+    const targetPath = path3.join(targetBase, artifact.relativePath);
+    if (await pathExists(targetPath) && !existingManifest && !args.force) {
+      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");
+    await fs3.copyFile(path3.join(sourceRoot, path3.basename(artifact.relativePath)), targetPath);
+  }
+  const installedManifest = {
+    manifestVersion: 1,
+    packageName: releaseManifest.packageName,
+    packageVersion: releaseManifest.packageVersion,
+    targetType: args.target,
+    targetBase,
+    installedAt: (/* @__PURE__ */ new Date()).toISOString(),
+    files: releaseManifest.artifacts.map((artifact) => ({
+      ...artifact,
+      installedByVersion: releaseManifest.packageVersion
+    }))
+  };
+  await writeInstalledManifest(targetBase, installedManifest);
+  return { targetBase };
+}
+
+// src/cli/uninstall.ts
+import fs4 from "fs/promises";
+import path4 from "path";
+async function uninstallCommand(args) {
+  const targetBase = resolveTargetBase(args.target, args.cwd);
+  const manifest = await loadInstalledManifest(targetBase);
+  if (!manifest) {
+    return { targetBase, removed: 0 };
+  }
+  let removed = 0;
+  for (const file of manifest.files) {
+    const targetPath = path4.join(targetBase, file.relativePath);
+    await fs4.rm(targetPath, { force: true });
+    removed += 1;
+  }
+  await fs4.rm(path4.join(targetBase, "opencode-gbk-tools.manifest.json"), { force: true });
+  return { targetBase, removed };
+}
+
+// src/cli/doctor.ts
+import fs5 from "fs/promises";
+import path5 from "path";
+async function doctorCommand(args) {
+  const targetBase = resolveTargetBase(args.target, args.cwd);
+  const manifest = await loadInstalledManifest(targetBase);
+  if (!manifest) {
+    return { ok: false, issues: ["\u672A\u627E\u5230 installed manifest"] };
+  }
+  const issues = [];
+  for (const file of manifest.files) {
+    const targetPath = path5.join(targetBase, file.relativePath);
+    try {
+      const actual = await computeFileHash(targetPath);
+      if (actual !== file.expectedHash) {
+        issues.push(`\u6587\u4EF6\u5185\u5BB9\u4E0E manifest \u4E0D\u4E00\u81F4: ${file.relativePath}`);
+      }
+    } catch {
+      issues.push(`\u6587\u4EF6\u7F3A\u5931: ${file.relativePath}`);
+    }
+  }
+  await fs5.access(path5.join(args.packageRoot, "dist", "release-manifest.json"));
+  return { ok: issues.length === 0, issues };
+}
+
+// src/cli/index.ts
+function resolvePackageRoot(env = process.env, moduleUrl = import.meta.url) {
+  if (env.OPENCODE_GBK_PACKAGE_ROOT) {
+    return env.OPENCODE_GBK_PACKAGE_ROOT;
+  }
+  const modulePath = fileURLToPath(moduleUrl);
+  return path6.resolve(path6.dirname(modulePath), "..", "..");
+}
+async function main(argv, env = process.env) {
+  const [command, ...rest] = argv;
+  const target = rest.includes("--project") ? "project" : "global";
+  const force = rest.includes("--force");
+  const packageRoot = resolvePackageRoot(env);
+  const cwd = process.cwd();
+  if (command === "install") {
+    return await installCommand({ packageRoot, target, cwd, force });
+  }
+  if (command === "uninstall") {
+    return await uninstallCommand({ target, cwd });
+  }
+  if (command === "doctor") {
+    return await doctorCommand({ packageRoot, target, cwd });
+  }
+  throw new Error(`\u672A\u77E5\u547D\u4EE4: ${command ?? ""}`);
+}
+export {
+  main,
+  resolvePackageRoot
+};