@d3ara1n/pi-hashline-edit 0.1.0 → 0.1.1

package/src/pi/pi.test.ts

@@ -3,25 +3,25 @@ import assert from "node:assert/strict";
 import { canonicalPath } from "./read-tool.ts";
 import { missingInputError } from "./edit-tool.ts";
 
-test("canonicalPath resolve 相对/绝对", () => {
+test("canonicalPath resolves relative/absolute", () => {
 	assert.equal(canonicalPath("/cwd", "foo.ts"), "/cwd/foo.ts");
 	assert.equal(canonicalPath("/cwd", "./foo.ts"), "/cwd/foo.ts");
 	assert.equal(canonicalPath("/cwd", "/abs/x.ts"), "/abs/x.ts");
 });
 
-test("missingInputError: edits 数组 → 明确告知不降级", () => {
+test("missingInputError: edits array → explicit no-degradation message", () => {
 	const msg = missingInputError("f.ts", { edits: [{ oldText: "a", newText: "b" }] });
 	assert.ok(msg.includes("legacy"), msg);
 	assert.ok(msg.includes("ONLY"), msg);
 	assert.ok(msg.includes("f.ts"), msg);
 });
 
-test("missingInputError: 顶层 oldText/newText 也识别为旧格式", () => {
+test("missingInputError: top-level oldText/newText also recognized as legacy", () => {
 	const msg = missingInputError("f.ts", { oldText: "a", newText: "b" });
 	assert.ok(msg.includes("legacy"));
 });
 
-test("missingInputError: 仅缺 input（非旧格式）", () => {
+test("missingInputError: only input missing (not legacy)", () => {
 	const msg = missingInputError("f.ts", {});
 	assert.ok(msg.includes("missing"));
 	assert.ok(!msg.includes("legacy"));

package/src/pi/read-tool.ts

@@ -1,6 +1,7 @@
 /**
- * Override read：文本文件输出「行号#hash│内容」并记录快照；
- * 非文本（图片/二进制）与读取错误透传内置 read，renderer 自动继承。
+ * Override read: text files output "lineNo#hash│content" and record a snapshot;
+ * non-text (images/binary) and read errors delegate to the built-in read, whose
+ * renderer is inherited automatically.
  *
  * @module pi-hashline-edit/pi
  */
@@ -14,12 +15,12 @@ import { getState, getSnapshot, recordSnapshot } from "./state.ts";
 const MAX_LINES = 2000;
 const MAX_BYTES = 256 * 1024;
 
-/** canonical path：read/edit 共用，保证 snapshot key 一致。 */
+/** canonical path: shared by read/edit to keep the snapshot key consistent. */
 export function canonicalPath(cwd: string, p: string): string {
 	return resolve(cwd, p);
 }
 
-/** 构造 read override（registerTool 的 ToolDefinition 片段）。 */
+/** Build the read override (a ToolDefinition fragment for registerTool). */
 export function makeReadOverride(cwd: string) {
 	const builtin = createReadTool(cwd);
 
@@ -36,8 +37,7 @@ export function makeReadOverride(cwd: string) {
 		parameters: builtin.parameters,
 
 		async execute(toolCallId: string, params: any, signal: AbortSignal | undefined, onUpdate: any) {
-			// 未启用 → 完全透传内置
-			// 未启用 或 用户已取消 → 透传内置（builtin 自行处理 abort）
+			// Not enabled OR user cancelled → delegate to the built-in (builtin handles abort itself)
 			if (!getState().config.enabled || signal?.aborted) return builtin.execute(toolCallId, params, signal, onUpdate);
 
 			const absPath = canonicalPath(cwd, params.path as string);
@@ -45,18 +45,18 @@ export function makeReadOverride(cwd: string) {
 			try {
 				buf = await readFile(absPath);
 			} catch {
-				// 读取错误 → 透传内置（它有完善的错误信息）
+				// read error → delegate to the built-in (it has polished error messages)
 				return builtin.execute(toolCallId, params, signal, onUpdate);
 			}
 
-			// 二进制/图片检测（null 字节）→ 透传内置（内置用 file-type 处理图片）
+			// binary/image detection (null byte) → delegate to the built-in (it uses file-type for images)
 			if (buf.includes(0)) return builtin.execute(toolCallId, params, signal, onUpdate);
 
 			const text = buf.toString("utf-8");
 			const allLines = splitLines(text);
 			const totalLines = allLines.length;
 
-			// 记录全文快照（edit 锚基于全文行号）
+			// record a full-file snapshot (edit anchors are based on full-file line numbers)
 			const snap = recordSnapshot(absPath, text);
 
 			// offset/limit
@@ -92,7 +92,7 @@ export function makeReadOverride(cwd: string) {
 	};
 }
 
-/** 供 edit override 复用：取某 path 的已记录快照（按 canonical path）。 */
+/** Reused by the edit override: look up a recorded snapshot for a path (by canonical path). */
 export function lookupSnapshot(cwd: string, p: string) {
 	return getSnapshot(canonicalPath(cwd, p));
 }

package/src/pi/state.ts

@@ -1,10 +1,11 @@
 /**
- * Session 级状态：文件快照存储（LRU）+ 配置。
+ * Session-level state: file snapshot store (LRU) + config.
  *
- * globalThis 单例（规避 Bun module identity 问题，见仓库 AGENTS）。
- * 快照 LRU 驱逐（默认 64 个文件），防长会话内存无限增长——冷文件被新文件挤出。
- * read 记录、edit 校验；key 为 canonical 绝对路径。
- * config 放 state，session_start 重载。
+ * globalThis singleton (avoids Bun module-identity issues; see the repo AGENTS).
+ * Snapshot LRU eviction (default 64 files) prevents unbounded memory growth in
+ * long sessions — cold files are pushed out by new ones. read records; edit
+ * verifies; key is the canonical absolute path.
+ * config lives in state and is reloaded on session_start.
  *
  * @module pi-hashline-edit/pi
  */
@@ -15,11 +16,11 @@ import type { HashlineEditConfig } from "./config.ts";
 
 const GLOBAL_KEY = "__piHashlineEdit";
 const DEFAULT_CONFIG: HashlineEditConfig = { enabled: true, hashLen: 4 };
-/** 最多缓存的文件快照数；超出按 LRU 驱逐最久未访问的。 */
+/** Maximum number of cached file snapshots; beyond this the least-recently-accessed is evicted. */
 const MAX_SNAPSHOTS = 64;
 
 export interface HashlineEditState {
-	/** canonical path → 快照。LRU 顺序：Map 插入序，最近访问的在末尾。 */
+	/** canonical path → snapshot. LRU order: Map insertion order, most recently accessed at the end. */
 	readonly snapshots: Map<string, FileSnapshot>;
 	hashLen: number;
 	config: HashlineEditConfig;
@@ -38,7 +39,7 @@ export function getState(): HashlineEditState {
 	return state;
 }
 
-/** 写入快照并维持 LRU：移到末尾（最近使用），超限驱逐最旧（Map 首项）。 */
+/** Write a snapshot and maintain LRU: move to the end (most recently used); evict the oldest (Map's first entry) when over the limit. */
 function touchAndEvict(map: Map<string, FileSnapshot>, path: string, snap: FileSnapshot): void {
 	if (map.has(path)) map.delete(path);
 	map.set(path, snap);
@@ -49,7 +50,7 @@ function touchAndEvict(map: Map<string, FileSnapshot>, path: string, snap: FileS
 	}
 }
 
-/** 记录文件快照（read 时调用）：算行 hash + LRU。 */
+/** Record a file snapshot (called on read): compute line hashes + LRU bookkeeping. */
 export function recordSnapshot(canonicalPath: string, text: string): FileSnapshot {
 	const state = getState();
 	const snap = createSnapshot(canonicalPath, text, state.hashLen);
@@ -57,12 +58,12 @@ export function recordSnapshot(canonicalPath: string, text: string): FileSnapsho
 	return snap;
 }
 
-/** 存入已算好的快照（edit 成功后更新），走 LRU。 */
+/** Store an already-computed snapshot (updated after a successful edit), via LRU. */
 export function putSnapshot(canonicalPath: string, snap: FileSnapshot): void {
 	touchAndEvict(getState().snapshots, canonicalPath, snap);
 }
 
-/** 取文件快照（edit 校验用）；命中时移到末尾（LRU touch）。 */
+/** Get a file snapshot (for edit verification); on a hit move it to the end (LRU touch). */
 export function getSnapshot(canonicalPath: string): FileSnapshot | undefined {
 	const map = getState().snapshots;
 	const snap = map.get(canonicalPath);
@@ -73,7 +74,7 @@ export function getSnapshot(canonicalPath: string): FileSnapshot | undefined {
 	return snap;
 }
 
-/** 清空快照（session 重启时）。 */
+/** Clear all snapshots (on session restart). */
 export function clearSnapshots(): void {
 	getState().snapshots.clear();
 }