dsh-better-edit 0.1.5 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +2 -0
  2. package/README.zh.md +208 -0
  3. package/package.json +3 -2
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # dsh-better-edit
2
2
 
3
+ [English](README.md) · [中文](README.zh.md)
4
+
3
5
  Hash-anchored `read` / `edit` / `batch_edit` / `undo_last_edit` tools for
4
6
  [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) (`dsh`).
5
7
  Every line of a file gets a unique 3-character hash — a **content address** —
package/README.zh.md ADDED
@@ -0,0 +1,208 @@
1
+ # dsh-better-edit
2
+
3
+ [English](README.md) · 中文
4
+
5
+ 为 [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness)(`dsh`)提供的基于哈希锚定的 `read` / `edit` / `batch_edit` / `undo_last_edit` 工具。文件的每一行都分配一个唯一的 3 字符哈希——即**内容地址**——编辑时按哈希定位。没有行号、没有模糊匹配、不会改错行。
6
+
7
+ 这个插件围绕三件事构建:
8
+
9
+ - **省 token。** 一次编辑调用只携带 `remove_from` / `remove_to`(两个 3 字符哈希)加替换文本——从不回显被替换的文本。`str_replace` 调用则必须逐字复现被替换的文本。在一个真实文件上的 12 次编辑会话中,这可以**减少 28% 的输出 token**(多行范围达 40%)——见[基准测试](#基准测试--可复现)。
10
+ - **正确性。** 每个解析出的编辑范围都会与模型实际看到的行逐行核对。过期、从未提供或歧义的范围会在**写入任何内容之前**被硬性拒绝,并把当前范围以全新锚点的形式回显(reject-and-serve)。错行编辑不会悄悄落盘。
11
+ - **面向 Agent 的现代编辑范式。** 内容地址锚点与行号无关:编辑文件的一部分,其余行的哈希保持不变,因此连续编辑无需重新读取。模型按行**是什么**来定位,而不是按它之前在第几行。
12
+
13
+ ## 核心概念
14
+
15
+ ```mermaid
16
+ flowchart LR
17
+ F["file.ts"] --> R["read"]
18
+ R --> A["ve7 │ function hello()<br/>szJ │ const x = 1<br/>kQm │ return x<br/>9xR │ }"]
19
+ A --> E["edit by hash<br/>remove_from : szJ<br/>remove_to : kQm<br/>replacement_text : …"]
20
+ E --> D["diff, fresh anchors<br/>− szJ │ const x = 1<br/>+ a3m │ const x = 2<br/> kQm │ return x"]
21
+ ```
22
+
23
+ - **每行都按内容、而非位置寻址。** `read` 返回 `HASH│内容`;哈希是该行的稳定地址。行被修改则获得新哈希;行未被改动则保持原哈希,即使周围的行发生移动。
24
+
25
+ ```mermaid
26
+ flowchart TB
27
+ B["before<br/>ve7 │ const a = 1<br/>szJ │ const b = 2<br/>kQm │ const c = 3"] --> X["insert 3 lines above const c"]
28
+ X --> C["after<br/>ve7 │ const a = 1<br/>szJ │ const b = 2<br/>x4n │ const d = 4<br/>r7p │ const e = 5<br/>kQm │ const c = 3"]
29
+ C --> N["kQm still names const c = 3<br/>line numbers would have shifted"]
30
+ ```
31
+
32
+ - **锚点在编辑后依然有效。** 在目标上方插入或删除行,其哈希不变——之后按该哈希 `edit` 依然能精确定位。而使用行号时,每一次上方编辑都会让下方所有内容错位,并被迫重新读取。
33
+ - **Reject-and-serve。** 过期或从未提供过的范围会被硬性拒绝,并把当前 `HASH│内容` 行回显出来,重试无需 `read`。
34
+
35
+ ## 为什么不用 `str_replace`?
36
+
37
+ 传统编辑工具要求模型在给出替换内容(`old_string` + `new_string`)之前,先逐 token 复述旧代码。每次编辑都要付出 `O(被替换文本)` 的 token 成本,**而且**这正是模型最容易出错的地方:最初的
38
+ [harness-problem](https://stencil.so/blog/the-harness-problem) 文章报告称,多个模型在 replace 式编辑下的补丁格式失败率高达 46–51%,改用锚定编辑后**输出 token 减少 61%**。hashline 只发送两个 3 字符锚点:
39
+
40
+ | | `str_replace` | hashline `edit` |
41
+ | --- | --- | --- |
42
+ | 请求 | `{ path, old_string, new_string }` | `{ path, remove_from, remove_to, replacement_text }` |
43
+ | 被替换文本 | 逐字复现 | 从不发送 |
44
+ | 范围校验 | 无(取第一个匹配) | 每一行都与已提供状态核对 |
45
+ | 文件已过期 | old_string 可能仍然匹配——并命中错误的出现位置 | 被拒绝并回传新锚点(`E_RANGE_STALE`) |
46
+ | 文本有歧义 | 静默取第一个匹配 | 边界锚点需校验——调用 `read` 获取新锚点 |
47
+
48
+ ## 基准测试 —— 可复现
49
+
50
+ `benchmark/run.mjs` 在同一份 103 行文件上、用相同的 12 组替换(8 个单行、4 个 3/6/10/15 行多行),以固定的 `js-tiktoken` `cl100k_base` 词表测量两种模式的模型侧 token 成本:
51
+
52
+ | 场景 | 行数 | hashline | str_replace | 节省 | % |
53
+ | --- | --- | --- | --- | --- | --- |
54
+ | 单行 ×8 | 1 | 311 | 314 | 3 | 1% |
55
+ | 多行 ×4 | 3–15 | 390 | 655 | 265 | **40%** |
56
+ | **合计 ×12** | | **701** | **969** | **268** | **28%** |
57
+
58
+ 读文件流量对两种工具完全相同,可抵消。以上是模型的**输出** token,按输入的约 5-6 倍计费——按 5 倍计,hashline 的实际成本**低约 1.4 倍**。节省随被替换文本的规模增长:短单行接近持平(锚点开销大致抵消一行 `old_string`),多行范围为 25–46%。
59
+
60
+ 自行复现——确定性、自带自检、无需构建步骤:
61
+
62
+ ```sh
63
+ npm install # 安装 js-tiktoken(固定版本)
64
+ npm run benchmark # node benchmark/run.mjs
65
+ ```
66
+
67
+ 完整的测量方法、结果与诚实的局限说明(基线没有建模的部分)见 [`benchmark/README.md`](benchmark/README.md)。
68
+
69
+ ## 用法
70
+
71
+ 1. 读取文件:
72
+
73
+ ```text
74
+ ve7│function hello() {
75
+ szJ│ console.log("world");
76
+ kQm│}
77
+ ```
78
+
79
+ 1. 按哈希编辑某行:
80
+
81
+ ```json
82
+ {
83
+ "path": "src/main.ts",
84
+ "remove_from": "szJ",
85
+ "remove_to": "szJ",
86
+ "replacement_text": " console.log('hi');"
87
+ }
88
+ ```
89
+
90
+ 1. 继续编辑。未触碰行的锚点依然有效;编辑后的 diff 与 `write` 之后的自动读取会交给你新锚点。`read` 是按需恢复,而不是每次编辑前的例行公事。
91
+
92
+ ### read 工具
93
+
94
+ `read` 返回一个文本文件,每一行都以 `HASH│内容` 为前缀(哈希 = `A-Za-z0-9` 中的 3 个字符)。参数:`offset`(1 起始的行号)、`limit`(最大行数)。分页输出以 `[Showing lines N-M of T. Use offset=… to continue.]` 结尾。超过 200KB 的行会显示为一个标记并附带 `sed` 检查提示——哈希锚点需要完整行。
95
+
96
+ ### edit 工具
97
+
98
+ | 字段 | 含义 |
99
+ | --- | --- |
100
+ | `path` | 要编辑的路径(相对会话 cwd;绝对路径亦可)。 |
101
+ | `remove_from` | 要删除的第一行的裸 3 字符哈希。 |
102
+ | `remove_to` | 要删除的最后一行的裸 3 字符哈希。 |
103
+ | `replacement_text` | 替换文本;`""` 表示删除该范围。 |
104
+
105
+ 该工具会对解析出的范围内**每一行**与模型实际看到的内容逐一核对。范围内某行自被提供以来在磁盘上发生了变化,就会被 `[E_RANGE_STALE]` / `[E_RANGE_UNSERVED]` / `[E_RANGE_UNVERIFIED]` 硬性拒绝,并把当前范围以全新锚点的形式回显(reject-and-serve)。diff 窗口之外行的锚点通过 `read` 恢复——这是文档化的按需恢复方式。
106
+
107
+ ### batch_edit
108
+
109
+ 在单个原子调用中完成多次编辑:`{ edits: [{ path?, remove_from, remove_to, replacement_text }, …] }`。全有或全无——任何一项失败都会使整个批次被拒绝且不写入任何内容,失败项的当前范围会以新锚点的形式回显。最多 32 项。
110
+
111
+ ### undo_last_edit
112
+
113
+ `{ path }` 撤销该文件上一次 hashline 编辑,仅当文件仍与存储的编辑后内容一致时才生效。之后发生的外部写入会清除历史记录,而不是被覆盖。撤销在重启后依然有效(存储于哈希库中)。
114
+
115
+ ## 如何替换内置工具
116
+
117
+ dsh 的工具注册表按作用域解析:agent 看到的是 `agent → preset → global`,且**自身**层总是优先。内置的 `read`/`edit` 位于 agent-preset 层,因此普通的全局注册无法替换它们。本插件:
118
+
119
+ 1. 通过其 `cordis.patch.yml` bundle 补丁作为宿主层 Cordis 插件挂载。
120
+ 2. 在 `agent/session-start` 时,将 hashline 工具**以及** `tool:read` / `tool:edit` 提示词片段注册到 agent 自身的作用域层——从而为该 agent 遮蔽 preset 的内置工具,并在 agent 销毁时自动解除。
121
+ 3. 保留内置的 `write`,但通过一个作用域内的 `tools/post-execute` 监听器把 hashline 自动读取附加到 write 结果之后。
122
+
123
+ ## 安装
124
+
125
+ 从 npm:
126
+
127
+ ```sh
128
+ dsh plugin --profile <name> add dsh-better-edit
129
+ ```
130
+
131
+ 从本地源码:
132
+
133
+ ```sh
134
+ dsh plugin --profile <name> add /path/to/dsh-better-edit
135
+ ```
136
+
137
+ 该 profile 的下一个会话将带着 hashline 工具运行。验证该层是否生效:
138
+
139
+ ```sh
140
+ dsh --profile <name> --dump-config # 会显示 "# == dsh-better-edit" 层
141
+ ```
142
+
143
+ ### 环境要求
144
+
145
+ - Node `^22.19.0 || >=24.0.0`(dsh 的要求;存储使用 `node:sqlite`)
146
+ - 一个 dsh profile(首次使用 `dsh plugin` 时初始化)
147
+
148
+ ## 存储
149
+
150
+ 哈希快照、已提供状态行与撤销历史存放在一个 SQLite 库中,**与被编辑的工作区放在一起**——每个会话 cwd 一个库:
151
+
152
+ - `<workspace>/.dsh_better_edit/hash-store.sqlite`
153
+
154
+ 不同工作区中的并行会话各自持有独立的库(会话 cwd 会随每次工具调用传递),因此一个项目的锚点与撤销历史不会泄漏到另一个项目。在工具调用之外(测试、预览)会回退到共享的 DeepSeek Harness 主目录(`$DSH_HOME/plugins/dsh-better-edit/hash-store.sqlite`)。
155
+
156
+ 7 天 TTL 会清理已提供的行;启动时清理缺失文件的快照。损坏的库会被隔离并自动重建。迁移到按工作区布局**不会**迁移共享主目录中的早期撤销历史——把 0.1.2 之前的撤销记录视为已丢失。
157
+
158
+ ## 错误码
159
+
160
+ | 代码 | 含义 |
161
+ | --- | --- |
162
+ | `[E_ACCESS]` | 文件存在但工具不可读/不可写。 |
163
+ | `[E_AMBIGUOUS_ANCHOR]` | 一个哈希匹配当前多行;调用 `read` 获取新锚点。 |
164
+ | `[E_BAD_OP]` | 范围结束先于范围开始(首尾颠倒时会自动纠正)。 |
165
+ | `[E_BAD_REF]` | `remove_from`/`remove_to` 不是裸 3 字符哈希。 |
166
+ | `[E_BAD_SHAPE]` | 请求/字段形态错误(未知字段、缺少 path、非字符串文本等)。 |
167
+ | `[E_BARE_HASH_PREFIX]` | `HASH│` 前缀被粘贴进 `replacement_text`(自动纠正)。 |
168
+ | `[E_BATCH_ABORT]` | 批次内某项失败;整个批次被拒绝,未写入任何内容。 |
169
+ | `[E_FILE_TOO_LARGE]` | 文件超过 hashline 行数上限;请改用 `write` 或其他方式。 |
170
+ | `[E_INVALID_PATCH]` | diff 预览标记被粘贴进 `replacement_text`(自动纠正)。 |
171
+ | `[E_NOOP_LOOP]` | 完全相同的编辑反复不产生任何变化;再次提交会被拒绝。 |
172
+ | `[E_NOT_FOUND]` | 文件不存在。 |
173
+ | `[E_NOT_OBSERVED]` | 该文件在本会话中尚未被观察(先读后写策略);请先调用 `read`。 |
174
+ | `[E_NOT_TEXT]` | 路径是目录、二进制或非 UTF-8 文件;hashline 只能编辑文本。 |
175
+ | `[E_RANGE_STALE]` | 某行自被读取以来在磁盘上发生变化;范围以全新锚点回显。 |
176
+ | `[E_RANGE_UNSERVED]` | 范围内包含从未提供给模型的行。 |
177
+ | `[E_RANGE_UNVERIFIED]` | 边界锚点无法对照已提供状态验证。 |
178
+ | `[E_STALE_ANCHOR]` | 锚点不再能解析;调用 `read` 获取新锚点。 |
179
+ | `[E_UNDO_STALE]` | 无法撤销:编辑之后文件被修改(或删除)。 |
180
+ | `[E_UNDO_UNAVAILABLE]` | 撤销历史无法持久化;编辑未被应用。 |
181
+ | `[E_WOULD_EMPTY]` | 编辑会把非空文件清空;请用 `write` 清空。 |
182
+
183
+ ## 灵感与血统
184
+
185
+ 哈希锚定编辑源于 Can Bölük 的
186
+ [*The Harness Problem*](https://stencil.so/blog/the-harness-problem)(Can Bölük),它证明了瓶颈在于 harness 而非模型,并且锚定编辑优于搜索替换。本项目是以下作品的 dsh 移植:
187
+
188
+ - [**pi-hashline-edit**](https://github.com/RimuruW/pi-hashline-edit)(RimuruW)——引入 3 字符哈希与冲突消解的原创 pi-coding-agent 扩展。
189
+ - [**pi-hashline-edit-pro**](https://github.com/YuGiMob/pi-hashline-edit-pro)(YuGiMob)——本仓库 hashline 核心所移植自的加固版 fork。
190
+ - [**pi-hashline-edit-lsz**](https://github.com/Rianico/pi-hashline-edit-lsz)——本项目所跟随的自维护 fork。hashline 核心逐字节移植;工具层基于 dsh 的插件 API 重写。
191
+
192
+ 延伸阅读:[Hash anchors + Myers diff + single-token anchors(dirac.run)](https://dirac.run/posts/hash-anchors-myers-diff-single-token)(关于编辑调用 O(S+R) → O(R) 节省的设计评论)以及一个独立的 [hashline 与 replace 对比基准测试](https://nwyin.com/blogs/hashline-vs-replace-edit-bench.html)。
193
+
194
+ ## 开发
195
+
196
+ ```sh
197
+ npm install
198
+ npm run typecheck # tsc --noEmit
199
+ npm test # vitest run
200
+ npm run build # tsc → lib/
201
+ npm run benchmark # 可复现的 token 成本基准测试(benchmark/)
202
+ ```
203
+
204
+ 测试套件移植自 pi-hashline-edit-lsz(615 个测试),通过本地文件系统桥接直接驱动 dsh 工具构建器。
205
+
206
+ ## 许可证
207
+
208
+ MIT——见 [LICENSE](LICENSE)。移植自 pi-hashline-edit-lsz(MIT),其本身带有 RimuruW 与 YuGiMob 的上游版权声明。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dsh-better-edit",
3
- "version": "0.1.5",
3
+ "version": "0.1.6",
4
4
  "type": "module",
5
5
  "description": "Hash-anchored read/edit/batch_edit/undo_last_edit tools for DeepSeek Harness (dsh). Every line gets a unique 3-char hash (A-Za-z0-9) that stays stable across edits; stale or ambiguous anchors are rejected, never fuzzy-matched. Undo persists across restarts.",
6
6
  "main": "lib/index.js",
@@ -16,7 +16,8 @@
16
16
  "lib",
17
17
  "cordis.patch.yml",
18
18
  "README.md",
19
- "LICENSE"
19
+ "LICENSE",
20
+ "README.zh.md"
20
21
  ],
21
22
  "repository": {
22
23
  "type": "git",