@movemama/opencode-legacy 1.0.1 → 1.0.3

package/README.md

@@ -1,6 +1,6 @@
 # @movemama/opencode-legacy
 
-OpenCode legacy 文本处理插件，面向 `GB2312` 文本、脚本型 `.txt` 编辑和 legacy 规则路由场景。
+OpenCode legacy 文本处理插件，默认更偏向 `GBK` 文本兼容，同时支持手动指定 `GB2312`、脚本型 `.txt` 编辑和 legacy 规则路由场景。
 
 当前主链路已经改为纯 JS 编码实现，不再依赖系统外部 `iconv.exe`。
 
@@ -72,6 +72,68 @@ OpenCode legacy 文本处理插件，面向 `GB2312` 文本、脚本型 `.txt`
 
 这让插件可以按场景决定更合适的编辑策略，而不只是按编码读写。
 
+## 自定义扩展规则
+
+如果用户希望让其他文件类型也走 `GBK` / `GB2312` 的 legacy 读写链路，当前可以通过项目级规则扩展实现。
+
+推荐在当前项目放置：
+
+- `<worktree>/.opencode/legacy-rules.json`
+
+例如：
+
+```json
+{
+  "rules": [
+    {
+      "glob": "**/*.{npc,msg,dialog}",
+      "encoding": "gbk",
+      "strict": true,
+      "tool": "txt-gb2312",
+      "priority": 50,
+      "profile": "txt-gb2312-safe",
+      "editStrategy": "exact-first",
+      "fallbackMode": "legacy-safe-replace",
+      "scriptMarkers": []
+    }
+  ]
+}
+```
+
+字段说明：
+
+- `glob`：匹配要走 legacy 读写链路的文件范围
+- `encoding`：指定文件使用的编码，例如 `gbk`、`gb2312`
+- `strict`：是否使用严格模式；通常脚本类文本建议保持 `true`
+- `tool`：建议使用的处理器名称，当前常见值为 `txt-gb2312` 或 `legacy-text`
+- `priority`：规则优先级，数值越大越优先匹配
+- `profile`：场景配置名，用于帮助策略层判断文件类型与处理方式
+- `editStrategy`：主编辑策略，例如 `exact-first`、`widget-field`
+- `fallbackMode`：主策略失败后的回退方式，例如 `legacy-safe-replace`、`widget-field-update`
+- `scriptMarkers`：用于辅助识别脚本型文件或 DSL 结构的关键标记数组
+
+如果客户只是想让某类新文件按中文常见编码读写，通常建议优先使用 `GBK`；如果确实需要严格限制在 `GB2312`，也可以手动指定。最小配置通常只需要先关心：
+
+- `glob`
+- `encoding`
+- `strict`
+- `tool`
+- `priority`
+
+其余字段可以先参考现有示例再逐步细化。
+
+当前规则加载优先级为：
+
+1. `<worktree>/.opencode/legacy-rules.json`
+2. `<worktree>/legacy-rules.json`
+3. `~/.config/opencode/legacy-rules.json`
+4. 包内 `legacy-rules.json`
+
+这意味着用户现在既可以：
+
+- 在 `~/.config/opencode/legacy-rules.json` 中定义全局通用扩展规则
+- 又可以在单个项目里通过 `<worktree>/.opencode/legacy-rules.json` 或 `<worktree>/legacy-rules.json` 做更高优先级覆盖
+
 ## 自动策略层
 
 当前 `edit` 已经接入自动策略层。
@@ -80,6 +142,8 @@ OpenCode legacy 文本处理插件，面向 `GB2312` 文本、脚本型 `.txt`
 - `classic-tag` 文本可根据 `profile` 和 `scriptMarkers` 判断为更偏 block / line-normalized 的策略
 - `rich-ui-dsl` 文本会优先识别 `<Text|...>` / `<Button|...>` 组件，并在 exact 失败后尝试 widget 字段级更新
 - 失败时会返回当前策略、格式族和 fallback 提示，便于继续排障
+- 编辑成功时也会返回：检测格式、修改策略、修改次数、命中位置，以及旧片段 / 新片段摘要，便于像内置 `edit` 一样快速确认改动位置
+- 插件还会通过 `tool.execute.after` 对 legacy edit 结果做统一包装，补充一致的标题与 metadata，方便后续继续往内置 `edit` 体验靠拢
 
 ## 支持的格式族
 

package/legacy-rules.json

@@ -1,9 +1,9 @@
 {
-  "_comment": "rules 为实际生效规则；examples 为示例模板，不会自动生效。新增文件类型时，优先复制 examples 中最接近的一条到 rules。tool 可选值当前建议使用 txt-gb2312 或 legacy-text。",
+  "_comment": "rules 为实际生效规则；examples 为示例模板，不会自动生效。新增文件类型时，优先复制 examples 中最接近的一条到 rules。tool 可选值当前建议使用 txt-gb2312 或 legacy-text。默认 .txt 规则现已优先使用 gbk，以获得更好的中文兼容性。",
   "rules": [
     {
       "glob": "**/*.txt",
-      "encoding": "gb2312",
+      "encoding": "gbk",
       "strict": true,
       "tool": "txt-gb2312",
       "priority": 10,
@@ -14,7 +14,7 @@
     },
     {
       "glob": "**/*.txt",
-      "encoding": "gb2312",
+      "encoding": "gbk",
       "strict": true,
       "tool": "txt-gb2312",
       "priority": 20,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@movemama/opencode-legacy",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "OpenCode legacy text processing plugin for GB2312 and script-safe editing workflows.",
   "type": "module",
   "main": "./index.js",

package/plugin-meta.js

@@ -10,6 +10,6 @@ export function getPluginMeta() {
       'legacy_write',
       'legacy_edit',
     ],
-    hookNames: ['experimental.chat.system.transform', 'tool.execute.before'],
+    hookNames: ['experimental.chat.system.transform', 'tool.execute.before', 'tool.execute.after'],
   }
 }

package/tools/agents-rules.js

@@ -2,6 +2,7 @@ import { existsSync, readFileSync } from 'node:fs'
 import path from 'node:path'
 
 const EDIT_GUARDED_TOOLS = new Set(['edit', 'write', 'script-edit', 'legacy_edit', 'legacy_write'])
+const LEGACY_EDIT_FEEDBACK_TOOLS = new Set(['edit', 'legacy_edit', 'script-edit'])
 
 function normalizeLineEndings(content) {
   return content.replace(/\r\n/g, '\n').trim()
@@ -72,5 +73,21 @@ export function createAgentsRuleHooks(input = {}) {
         throw new Error('当前会话尚未完成 AGENTS.md 规则注入，已禁止编辑类工具执行。请先让插件读取全局与项目 AGENTS.md。')
       }
     },
+    'tool.execute.after': async (hookInput, output) => {
+      if (!LEGACY_EDIT_FEEDBACK_TOOLS.has(hookInput.tool)) {
+        return
+      }
+
+      if (typeof output?.output !== 'string' || !output.output.includes('修改策略：')) {
+        return
+      }
+
+      output.title = 'legacy edit'
+      output.metadata = {
+        ...(output.metadata || {}),
+        kind: 'legacy-edit-feedback',
+        tool: hookInput.tool,
+      }
+    },
   }
 }

package/tools/edit.js

@@ -4,6 +4,7 @@ import path from 'node:path'
 import readTool from './read.js'
 import writeTool from './write.js'
 import { applyLegacyEdit } from './legacy-edit-core.mjs'
+import { buildEditFeedback } from './legacy-edit-feedback.js'
 import { matchLegacyRule } from './legacy-router.mjs'
 import { loadLegacyRules } from './legacy-rules-loader.js'
 import { chooseEditStrategy } from './legacy-strategy.js'
@@ -34,7 +35,14 @@ export default tool({
     const result = applyLegacyEdit(content, args.oldString, args.newString, Boolean(args.replaceAll))
 
     if (result.changed) {
-      return writeTool.execute({ filePath, content: result.content }, context)
+      const writeMessage = await writeTool.execute({ filePath, content: result.content }, context)
+      return buildEditFeedback({
+        writeMessage,
+        detectedFamily: strategy.detectedFamily,
+        strategy: 'exact-first',
+        originalContent: content,
+        updatedContent: result.content,
+      })
     }
 
     const fallbackResult = applyFallbackEditChain({
@@ -45,7 +53,14 @@ export default tool({
     })
 
     if (fallbackResult.changed) {
-      return writeTool.execute({ filePath, content: fallbackResult.content }, context)
+      const writeMessage = await writeTool.execute({ filePath, content: fallbackResult.content }, context)
+      return buildEditFeedback({
+        writeMessage,
+        detectedFamily: strategy.detectedFamily,
+        strategy: fallbackResult.strategy,
+        originalContent: content,
+        updatedContent: fallbackResult.content,
+      })
     }
 
     throw new Error(

package/tools/legacy-edit-feedback.js

@@ -0,0 +1,68 @@
+function normalizeNewlines(text) {
+  return text.replace(/\r\n/g, '\n')
+}
+
+function buildPositionLabel(startLine, endLine) {
+  if (startLine === endLine) {
+    return `${startLine}`
+  }
+
+  return `${startLine}-${endLine}`
+}
+
+function summarizeChangedBlock(original, updated) {
+  const originalLines = normalizeNewlines(original).split('\n')
+  const updatedLines = normalizeNewlines(updated).split('\n')
+
+  let prefix = 0
+  while (
+    prefix < originalLines.length
+    && prefix < updatedLines.length
+    && originalLines[prefix] === updatedLines[prefix]
+  ) {
+    prefix += 1
+  }
+
+  let suffix = 0
+  while (
+    suffix < originalLines.length - prefix
+    && suffix < updatedLines.length - prefix
+    && originalLines[originalLines.length - 1 - suffix] === updatedLines[updatedLines.length - 1 - suffix]
+  ) {
+    suffix += 1
+  }
+
+  const originalEnd = Math.max(prefix, originalLines.length - suffix)
+  const updatedEnd = Math.max(prefix, updatedLines.length - suffix)
+  const oldBlock = originalLines.slice(prefix, originalEnd)
+  const newBlock = updatedLines.slice(prefix, updatedEnd)
+  const startLine = prefix + 1
+  const endLine = Math.max(prefix + oldBlock.length, prefix + newBlock.length)
+
+  return {
+    changeCount: 1,
+    position: buildPositionLabel(startLine, endLine),
+    oldSnippet: oldBlock.join('\n'),
+    newSnippet: newBlock.join('\n'),
+  }
+}
+
+export function buildEditFeedback({
+  writeMessage,
+  detectedFamily,
+  strategy,
+  originalContent,
+  updatedContent,
+}) {
+  const summary = summarizeChangedBlock(originalContent, updatedContent)
+
+  return [
+    writeMessage,
+    `检测格式：${detectedFamily}`,
+    `修改策略：${strategy}`,
+    `修改次数：${summary.changeCount}`,
+    `命中位置：${summary.position}`,
+    `旧片段：${summary.oldSnippet}`,
+    `新片段：${summary.newSnippet}`,
+  ].join('\n')
+}

package/tools/legacy-router.mjs

@@ -55,7 +55,7 @@ function globToRegExp(glob) {
 
 export function createDefaultLegacyRules() {
   return [
-    { glob: '**/*.txt', encoding: 'gb2312', strict: true },
+    { glob: '**/*.txt', encoding: 'gbk', strict: true },
     { glob: '**/*.{ini,cfg,dat}', encoding: 'gbk', strict: false },
   ];
 }

package/tools/legacy-rules-loader.js

@@ -2,7 +2,7 @@ import { existsSync, readFileSync } from 'node:fs'
 import path from 'node:path'
 
 import { createDefaultLegacyRules } from './legacy-router.mjs'
-import { getBundledLegacyRulesPath } from './opencode-paths.mjs'
+import { getBundledLegacyRulesPath, getGlobalLegacyRulesPath } from './opencode-paths.mjs'
 
 export function loadLegacyRules(worktree) {
   return loadLegacyRulesWithMeta(worktree).rules
@@ -12,6 +12,7 @@ export function loadLegacyRulesWithMeta(worktree) {
   const candidates = [
     { filePath: path.join(worktree, '.opencode', 'legacy-rules.json'), source: 'project:.opencode' },
     { filePath: path.join(worktree, 'legacy-rules.json'), source: 'project:root' },
+    { filePath: getGlobalLegacyRulesPath(), source: 'global:config' },
     { filePath: getBundledLegacyRulesPath(), source: 'bundled:default' },
   ]