dsh-better-edit 0.1.9 → 0.2.1

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 (58) hide show
  1. package/CHANGELOG.md +32 -0
  2. package/README.md +168 -52
  3. package/README.zh.md +122 -46
  4. package/assets/logo.svg +183 -18
  5. package/lib/contract.js +95 -0
  6. package/lib/drift.js +1 -1
  7. package/lib/edit-diff.js +2 -2
  8. package/lib/edit-engine.js +456 -0
  9. package/lib/edit-pipeline.js +41 -116
  10. package/lib/file-reader.js +1 -2
  11. package/lib/fs-bridge.js +2 -2
  12. package/lib/fs-write.js +3 -46
  13. package/lib/guidance.js +282 -0
  14. package/lib/hash-store.js +246 -13
  15. package/lib/hashline/apply.js +2 -2
  16. package/lib/hashline/hash.js +16 -206
  17. package/lib/hashline/index.js +4 -3
  18. package/lib/hashline/parse.js +1 -1
  19. package/lib/hashline/pure.js +213 -0
  20. package/lib/hashline/resolve.js +1 -5
  21. package/lib/hashline/served.js +2 -2
  22. package/lib/index.js +48 -32
  23. package/lib/paths.js +55 -1
  24. package/lib/prompts.js +53 -49
  25. package/lib/read-and-serve.js +46 -0
  26. package/lib/schema.js +1 -1
  27. package/lib/served-store.js +144 -183
  28. package/lib/tool-batch-edit.js +28 -280
  29. package/lib/tool-edit.js +37 -32
  30. package/lib/tool-read.js +8 -31
  31. package/lib/tool-undo.js +4 -13
  32. package/lib/types/contract.d.ts +39 -0
  33. package/lib/types/edit-engine.d.ts +179 -0
  34. package/lib/types/edit-pipeline.d.ts +10 -17
  35. package/lib/types/fs-write.d.ts +0 -1
  36. package/lib/types/guidance.d.ts +98 -0
  37. package/lib/types/hash-store.d.ts +73 -25
  38. package/lib/types/hashline/hash.d.ts +8 -13
  39. package/lib/types/hashline/index.d.ts +4 -3
  40. package/lib/types/hashline/pure.d.ts +26 -0
  41. package/lib/types/hashline/resolve.d.ts +0 -1
  42. package/lib/types/index.d.ts +4 -0
  43. package/lib/types/paths.d.ts +9 -0
  44. package/lib/types/prompts.d.ts +19 -9
  45. package/lib/types/read-and-serve.d.ts +39 -0
  46. package/lib/types/schema.d.ts +2 -16
  47. package/lib/types/served-store.d.ts +63 -32
  48. package/lib/types/tool-batch-edit.d.ts +4 -1
  49. package/lib/types/tool-undo.d.ts +1 -1
  50. package/lib/undo-edit.js +16 -1
  51. package/lib/write-hook.js +30 -50
  52. package/package.json +5 -3
  53. package/lib/served-state.js +0 -34
  54. package/lib/snapshot-store.js +0 -108
  55. package/lib/types/served-state.d.ts +0 -3
  56. package/lib/types/snapshot-store.d.ts +0 -14
  57. package/lib/types/undo-store.d.ts +0 -14
  58. package/lib/undo-store.js +0 -43
package/assets/logo.svg CHANGED
@@ -1,21 +1,186 @@
1
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 200 200" width="200" height="200" role="img" aria-label="dsh-better-edit">
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 256" width="256" height="256">
2
2
  <defs>
3
- <linearGradient id="bg" x1="0" y1="0" x2="1" y2="1">
4
- <stop offset="0" stop-color="#1c2330"/>
5
- <stop offset="1" stop-color="#0d1117"/>
3
+ <!-- DeepSeek brand gradient matching ref image tone -->
4
+ <linearGradient id="dolphinBody" x1="0%" y1="0%" x2="100%" y2="100%">
5
+ <stop offset="0%" stop-color="#4A5568"/>
6
+ <stop offset="100%" stop-color="#2D3748"/>
6
7
  </linearGradient>
8
+ <!-- Notebook paper -->
9
+ <linearGradient id="paper" x1="0%" y1="0%" x2="0%" y2="100%">
10
+ <stop offset="0%" stop-color="#FEFCFB"/>
11
+ <stop offset="100%" stop-color="#F7F5F3"/>
12
+ </linearGradient>
13
+ <!-- Glow for new hash -->
14
+ <filter id="addGlow" x="-30%" y="-30%" width="160%" height="160%">
15
+ <feGaussianBlur stdDeviation="2" result="blur"/>
16
+ <feMerge>
17
+ <feMergeNode in="blur"/>
18
+ <feMergeNode in="SourceGraphic"/>
19
+ </feMerge>
20
+ </filter>
7
21
  </defs>
8
- <rect x="8" y="8" width="184" height="184" rx="28" fill="url(#bg)" stroke="#30363d" stroke-width="2"/>
9
- <!-- row 1 -->
10
- <rect x="30" y="46" width="38" height="20" rx="6" fill="#1f6feb"/>
11
- <text x="49" y="60" font-family="ui-monospace,SFMono-Regular,Menlo,Consolas,monospace" font-size="13" font-weight="700" fill="#ffffff" text-anchor="middle">ve7</text>
12
- <text x="78" y="60" font-family="ui-monospace,SFMono-Regular,Menlo,Consolas,monospace" font-size="13" fill="#e6edf3">hello()</text>
13
- <!-- row 2 -->
14
- <rect x="30" y="90" width="38" height="20" rx="6" fill="#238636"/>
15
- <text x="49" y="104" font-family="ui-monospace,SFMono-Regular,Menlo,Consolas,monospace" font-size="13" font-weight="700" fill="#ffffff" text-anchor="middle">szJ</text>
16
- <text x="78" y="104" font-family="ui-monospace,SFMono-Regular,Menlo,Consolas,monospace" font-size="13" fill="#e6edf3">const x = 1</text>
17
- <!-- row 3 -->
18
- <rect x="30" y="134" width="38" height="20" rx="6" fill="#bf3989"/>
19
- <text x="49" y="148" font-family="ui-monospace,SFMono-Regular,Menlo,Consolas,monospace" font-size="13" font-weight="700" fill="#ffffff" text-anchor="middle">kQm</text>
20
- <text x="78" y="148" font-family="ui-monospace,SFMono-Regular,Menlo,Consolas,monospace" font-size="13" fill="#e6edf3">return x</text>
21
- </svg>
22
+
23
+ <!-- Clean light background like ref image -->
24
+ <rect width="256" height="256" rx="20" fill="#F7FAFC"/>
25
+
26
+ <!-- ===== NOTEBOOK ===== -->
27
+ <g transform="translate(52, 138)">
28
+ <!-- Notebook cover -->
29
+ <rect width="136" height="88" rx="6" fill="url(#paper)" stroke="#CBD5E0" stroke-width="1.5"/>
30
+ <!-- Spiral binding -->
31
+ <g fill="#718096">
32
+ <circle cx="-5" cy="16" r="3"/>
33
+ <circle cx="-5" cy="34" r="3"/>
34
+ <circle cx="-5" cy="52" r="3"/>
35
+ <circle cx="-5" cy="70" r="3"/>
36
+ </g>
37
+ <!-- Lines -->
38
+ <line x1="14" y1="22" x2="120" y2="22" stroke="#E2E8F0" stroke-width="1.2"/>
39
+ <line x1="14" y1="38" x2="112" y2="38" stroke="#E2E8F0" stroke-width="1.2"/>
40
+ <line x1="14" y1="54" x2="124" y2="54" stroke="#E2E8F0" stroke-width="1.2"/>
41
+ <line x1="14" y1="70" x2="100" y2="70" stroke="#E2E8F0" stroke-width="1.2"/>
42
+
43
+ <!-- Read context on notebook -->
44
+ <text x="18" y="21" font-family="monospace" font-size="7.5" fill="#4A5568">ve7</text>
45
+ <text x="44" y="21" font-family="monospace" font-size="7.5" fill="#4A5568">szJ</text>
46
+ <text x="70" y="21" font-family="monospace" font-size="7.5" fill="#4A5568">kQm</text>
47
+
48
+ <!-- Edit action area: show -szJ +a3m diff -->
49
+ <g transform="translate(18, 48)">
50
+ <!-- Removed hash: -szJ with strikethrough -->
51
+ <text x="0" y="0" font-family="monospace" font-size="9" fill="#E53E3E" text-decoration="line-through" opacity="0.75">szJ</text>
52
+ <!-- Arrow indicator -->
53
+ <text x="30" y="0" font-family="monospace" font-size="9" fill="#A0AEC0">→</text>
54
+ <!-- Added hash: +a3m highlighted -->
55
+ <rect x="42" y="-10" width="28" height="13" rx="2" fill="#C6F6D5" opacity="0.5"/>
56
+ <text x="45" y="0" font-family="monospace" font-size="9" fill="#22543D" font-weight="bold" filter="url(#addGlow)">a3m</text>
57
+ </g>
58
+
59
+ <!-- Remaining unchanged hashes below -->
60
+ <text x="18" y="67" font-family="monospace" font-size="7.5" fill="#718096" opacity="0.6">ve7</text>
61
+ <text x="44" y="67" font-family="monospace" font-size="7.5" fill="#718096" opacity="0.6">kQm</text>
62
+
63
+ <!-- Cursor after edit -->
64
+ <line x1="76" y1="52" x2="76" y2="62" stroke="#4299E1" stroke-width="1.5" stroke-linecap="round">
65
+ <animate attributeName="opacity" values="1;0;1" dur="1s" repeatCount="indefinite"/>
66
+ </line>
67
+ </g>
68
+
69
+ <!-- ===== DOLPHIN — minimalist style matching reference image ===== -->
70
+ <g transform="translate(64, 36)">
71
+ <!-- Body: smooth curved shape like the ref image -->
72
+ <path d="M24,12
73
+ C50,-2 90,6 104,28
74
+ C118,52 98,82 68,88
75
+ C40,92 16,78 8,56
76
+ C0,34 10,18 24,12Z"
77
+ fill="url(#dolphinBody)"/>
78
+
79
+ <!-- White belly patch (like ref image) -->
80
+ <path d="M20,52
81
+ C32,80 60,86 80,68
82
+ C72,78 48,84 28,72
83
+ C18,62 14,54 20,52Z"
84
+ fill="#F7FAFC"/>
85
+
86
+ <!-- Tail fin (small, curved up like ref) -->
87
+ <path d="M8,58
88
+ C-4,50 -6,60 2,66
89
+ C-2,74 4,80 12,72
90
+ Z"
91
+ fill="url(#dolphinBody)"/>
92
+
93
+ <!-- Dorsal fin (small, subtle) -->
94
+ <path d="M68,18
95
+ C78,4 88,6 90,12
96
+ C84,18 76,24 70,24Z"
97
+ fill="#2D3748"/>
98
+
99
+ <!-- Left pectoral fin -->
100
+ <path d="M26,62
101
+ C14,72 16,82 26,78
102
+ C30,70 28,64 26,62Z"
103
+ fill="#2D3748" opacity="0.7"/>
104
+
105
+ <!-- Right pectoral fin (holding pen) -->
106
+ <path d="M78,60
107
+ C92,68 86,80 76,76
108
+ C72,68 74,60 78,60Z"
109
+ fill="#2D3748" opacity="0.7"/>
110
+
111
+ <!-- Eye — looking down at notebook (read) -->
112
+ <ellipse cx="88" cy="40" rx="5" ry="6" fill="#FFFFFF"/>
113
+ <circle cx="89.5" cy="41" r="3" fill="#1A202C"/>
114
+ <circle cx="91" cy="39.5" r="1" fill="#FFFFFF"/>
115
+
116
+ <!-- Subtle smile -->
117
+ <path d="M94,48 Q100,52 106,48" stroke="#2D3748" stroke-width="1.5" fill="none" stroke-linecap="round" opacity="0.5"/>
118
+ </g>
119
+
120
+ <!-- ===== PEN held by right flipper ===== -->
121
+ <g transform="translate(148, 108) rotate(35)">
122
+ <rect x="0" y="0" width="4" height="30" rx="2" fill="#4299E1"/>
123
+ <polygon points="2,30 -1,36 5,36" fill="#1A202C"/>
124
+ <rect x="4" y="4" width="1.5" height="15" rx="0.75" fill="#2B6CB0"/>
125
+ <!-- Ink trail on notebook showing edit -->
126
+ <path d="M2,36 Q4,42 2,48 Q4,52 3,56" stroke="#4299E1" stroke-width="1.5" fill="none" stroke-linecap="round" opacity="0.5"/>
127
+ </g>
128
+
129
+ <!-- ===== FLOATING HASHES — read set + diff visualization ===== -->
130
+ <g font-family="monospace">
131
+
132
+ <!-- Read hashes floating (original state) -->
133
+ <g font-size="11" font-weight="600" opacity="0.85">
134
+ <text x="186" y="46" fill="#4A5568">ve7</text>
135
+ <text x="206" y="66" fill="#4A5568">szJ</text>
136
+ <text x="188" y="86" fill="#4A5568">kQm</text>
137
+ </g>
138
+
139
+ <!-- DIFF ANIMATION AREA: show -szJ → +a3m transition -->
140
+ <g transform="translate(176, 108)">
141
+ <!-- Minus: removed hash szJ fading out -->
142
+ <text x="0" y="0" font-family="monospace" font-size="12" font-weight="bold" fill="#E53E3E" opacity="0.6">
143
+ −szJ
144
+ <animate attributeName="opacity" values="0.6;0.2;0.6" dur="2s" repeatCount="indefinite"/>
145
+ <animateTransform attributeName="transform" type="translate" values="0,0; -8,0; 0,0" dur="2s" repeatCount="indefinite"/>
146
+ </text>
147
+
148
+ <!-- Plus: new hash a3m glowing in -->
149
+ <text x="38" y="0" font-family="monospace" font-size="12" font-weight="bold" fill="#38A169" filter="url(#addGlow)">
150
+ +a3m
151
+ <animate attributeName="opacity" values="0.9;1;0.9" dur="2s" repeatCount="indefinite"/>
152
+ </text>
153
+ </g>
154
+
155
+ <!-- Connecting dots between original hashes -->
156
+ <g fill="#CBD5E0" opacity="0.3">
157
+ <circle cx="198" cy="50" r="1.2"/>
158
+ <circle cx="216" cy="72" r="1.2"/>
159
+ <circle cx="200" cy="92" r="1.2"/>
160
+ </g>
161
+
162
+ <!-- Small arrow indicating transformation -->
163
+ <g transform="translate(196, 96)" fill="#A0AEC0" opacity="0.4">
164
+ <path d="M0,0 L6,4 L0,8 Z"/>
165
+ </g>
166
+ </g>
167
+
168
+ <!-- ===== LABELS ===== -->
169
+ <!-- "read" label near dolphin's gaze -->
170
+ <g transform="translate(160, 56)">
171
+ <rect x="0" y="0" width="28" height="14" rx="3" fill="#EDF2F7" opacity="0.8"/>
172
+ <text x="14" y="10" font-family="monospace" font-size="7" fill="#4A5568" text-anchor="middle" font-weight="600">read</text>
173
+ </g>
174
+
175
+ <!-- "edit" label near pen -->
176
+ <g transform="translate(178, 128)">
177
+ <rect x="0" y="0" width="28" height="14" rx="3" fill="#EBF8FF" opacity="0.8"/>
178
+ <text x="14" y="10" font-family="monospace" font-size="7" fill="#2B6CB0" text-anchor="middle" font-weight="600">edit</text>
179
+ </g>
180
+
181
+ <!-- Corner decoration dots (subtle) -->
182
+ <circle cx="228" cy="28" r="2" fill="#E2E8F0"/>
183
+ <circle cx="236" cy="36" r="1.5" fill="#E2E8F0"/>
184
+ <circle cx="20" cy="228" r="2" fill="#E2E8F0"/>
185
+ <circle cx="28" cy="236" r="1.5" fill="#E2E8F0"/>
186
+ </svg>
@@ -0,0 +1,95 @@
1
+ /**
2
+ * One module owns the request shapes for the hashline tools — edit,
3
+ * batch_edit, read, undo_last_edit — plus their validation. Field sets are
4
+ * declared once here; every tool validates through these asserts, and the
5
+ * [E_BAD_SHAPE] vocabulary is shared instead of re-implemented per tool.
6
+ *
7
+ * Note: `resolve.ts` keeps its own internal item check (content-only fields,
8
+ * no path) — that is the hashline-internal edit-item shape, deliberately
9
+ * decoupled from the tool-layer request contract so the hashline module does
10
+ * not depend on this one.
11
+ * @module dsh-better-edit/contract
12
+ */
13
+ import { BATCH_EDIT_MAX_ITEMS } from "./constants.js";
14
+ import { isRec, normalizeFilePath, rejectUnknownFields } from "./utils.js";
15
+ // ---- field sets (declared once) ---------------------------------------------
16
+ const EDIT_KS = new Set([
17
+ "path",
18
+ "remove_from",
19
+ "remove_to",
20
+ "replacement_text",
21
+ "sandbox_permissions",
22
+ "justification",
23
+ ]);
24
+ const BATCH_ROOT_KS = new Set([
25
+ "edits",
26
+ "sandbox_permissions",
27
+ "justification",
28
+ ]);
29
+ const BATCH_ITEM_KS = new Set([
30
+ "path",
31
+ "remove_from",
32
+ "remove_to",
33
+ "replacement_text",
34
+ ]);
35
+ const READ_KS = new Set(["path", "offset", "limit"]);
36
+ // ---- assertions ---------------------------------------------------------------
37
+ export function assertEditRequest(request) {
38
+ if (!isRec(request)) {
39
+ throw new Error("[E_BAD_SHAPE] Edit request must be an object.");
40
+ }
41
+ rejectUnknownFields(request, EDIT_KS, "Edit request");
42
+ if (typeof request.path !== "string" || request.path.length === 0) {
43
+ throw new Error('[E_BAD_SHAPE] Edit request requires a non-empty "path" string.');
44
+ }
45
+ if (typeof request.remove_from !== "string" ||
46
+ typeof request.remove_to !== "string" ||
47
+ typeof request.replacement_text !== "string") {
48
+ throw new Error('[E_BAD_SHAPE] Edit request requires "remove_from", "remove_to", and "replacement_text" at the top level.');
49
+ }
50
+ }
51
+ export function assertBatchEditRequest(request) {
52
+ if (!isRec(request)) {
53
+ throw new Error('[E_BAD_SHAPE] batch_edit request must be an object with an "edits" array.');
54
+ }
55
+ rejectUnknownFields(request, BATCH_ROOT_KS, "batch_edit request");
56
+ if (!Array.isArray(request.edits) || request.edits.length === 0) {
57
+ throw new Error('[E_BAD_SHAPE] batch_edit request requires a non-empty "edits" array.');
58
+ }
59
+ if (request.edits.length > BATCH_EDIT_MAX_ITEMS) {
60
+ throw new Error(`[E_BAD_SHAPE] batch_edit accepts at most ${BATCH_EDIT_MAX_ITEMS} edits; got ${request.edits.length}. Split the batch.`);
61
+ }
62
+ request.edits.forEach((item, index) => {
63
+ if (!isRec(item)) {
64
+ throw new Error(`[E_BAD_SHAPE] edits[${index}] must be an object with remove_from, remove_to, and replacement_text.`);
65
+ }
66
+ rejectUnknownFields(item, BATCH_ITEM_KS, `edits[${index}]`);
67
+ if (typeof item.remove_from !== "string" ||
68
+ typeof item.remove_to !== "string" ||
69
+ typeof item.replacement_text !== "string") {
70
+ throw new Error(`[E_BAD_SHAPE] edits[${index}] requires "remove_from", "remove_to", and "replacement_text" strings.`);
71
+ }
72
+ if (item.path !== undefined &&
73
+ (typeof item.path !== "string" || item.path.length === 0)) {
74
+ throw new Error(`[E_BAD_SHAPE] edits[${index}].path must be a non-empty string.`);
75
+ }
76
+ });
77
+ }
78
+ export function assertReadRequest(request) {
79
+ if (!isRec(request)) {
80
+ throw new Error("[E_BAD_SHAPE] Read request must be an object.");
81
+ }
82
+ rejectUnknownFields(request, READ_KS, "Read request");
83
+ if (typeof request.path !== "string" || request.path.length === 0) {
84
+ throw new Error('[E_BAD_SHAPE] Read request requires a non-empty "path" string.');
85
+ }
86
+ }
87
+ export function assertUndoRequest(request) {
88
+ if (!isRec(request)) {
89
+ throw new Error("[E_BAD_SHAPE] undo_last_edit request must be an object.");
90
+ }
91
+ normalizeFilePath(request);
92
+ if (typeof request.path !== "string" || request.path.length === 0) {
93
+ throw new Error('[E_BAD_SHAPE] undo_last_edit request requires a non-empty "path" string.');
94
+ }
95
+ }
package/lib/drift.js CHANGED
@@ -1,6 +1,6 @@
1
1
  import { SERVED_ECHO_CAP } from "./constants.js";
2
2
  import { fmtServedRows, } from "./hashline/served.js";
3
- import { currentPositionOfDrifted, driftReported, markDriftReported, recordServed, servedPositionsOf, } from "./served-state.js";
3
+ import { currentPositionOfDrifted, driftReported, markDriftReported, recordServed, servedPositionsOf, } from "./served-store.js";
4
4
  export const DRIFT_NOTICE_HEADING = "Drift notice:";
5
5
  export function computeDrift(input) {
6
6
  const { served, resultHashes, resultLines, range, reported, cap = SERVED_ECHO_CAP, } = input;
package/lib/edit-diff.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as Diff from "diff";
2
- import { _lineHashesPure, ANCHOR_LEN, HASH_SEP } from "./hashline/index.js";
2
+ import { lineHashesPure, ANCHOR_LEN, HASH_SEP } from "./hashline/index.js";
3
3
  export function detectEnding(content) {
4
4
  const lfIdx = content.indexOf("\n");
5
5
  if (lfIdx === -1) {
@@ -34,7 +34,7 @@ function fmtDiffLine(prefix, line, hash) {
34
34
  const ELLIPSIS_MARKER = Symbol("ellipsis");
35
35
  const isEllipsisMarker = (line) => line === ELLIPSIS_MARKER;
36
36
  export function genDiff(oldContent, newContent, contextLines = 2, newContentHashes, oldContentHashes) {
37
- const effectiveNewHashes = newContentHashes ?? _lineHashesPure(newContent);
37
+ const effectiveNewHashes = newContentHashes ?? lineHashesPure(newContent);
38
38
  const parts = Diff.diffLines(oldContent, newContent);
39
39
  const output = [];
40
40
  const servedRows = [];