devlog-tracker 0.27.0 → 0.30.0
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.
- package/README.md +109 -100
- package/README.zh-TW.md +235 -0
- package/claude/hooks.json +21 -0
- package/cli/agents-md.js +1 -0
- package/commands/keep.md +18 -2
- package/commands/lessons-drift.md +2 -2
- package/commands/search.md +22 -0
- package/commands/status.md +2 -1
- package/core/scripts/clean-devlog.sh +1 -0
- package/core/scripts/devlog-lock.sh +17 -1
- package/core/scripts/devlog-path.sh +15 -8
- package/core/scripts/enforce-devlog.sh +25 -0
- package/core/scripts/handoff-file.sh +106 -0
- package/core/scripts/lessons-advisory-state.sh +51 -0
- package/core/scripts/lessons-append.sh +16 -0
- package/core/scripts/lessons-drift-set.sh +14 -10
- package/core/scripts/lessons-on.sh +8 -3
- package/core/scripts/lessons-subagent-done.sh +36 -0
- package/core/scripts/lessons-subagent-start.sh +36 -0
- package/core/scripts/round-start.sh +65 -16
- package/core/scripts/search-devlog.sh +63 -0
- package/core/scripts/session-start-devlog.sh +7 -0
- package/core/scripts/status-devlog.sh +4 -4
- package/core/scripts/tests/test-clean-devlog.sh +12 -0
- package/core/scripts/tests/test-devlog-lock.sh +39 -0
- package/core/scripts/tests/test-devlog-path.sh +44 -0
- package/core/scripts/tests/test-enforce-devlog-files.sh +11 -0
- package/core/scripts/tests/test-enforce-devlog-session-handoff.sh +178 -0
- package/core/scripts/tests/test-enforce-devlog-workspace.sh +35 -0
- package/core/scripts/tests/test-enforce-devlog.sh +174 -0
- package/core/scripts/tests/test-handoff-file.sh +98 -0
- package/core/scripts/tests/test-lessons-advisory-state.sh +55 -0
- package/core/scripts/tests/test-lessons-append.sh +18 -0
- package/core/scripts/tests/test-lessons-drift-set.sh +14 -5
- package/core/scripts/tests/test-lessons-on-off.sh +16 -6
- package/core/scripts/tests/test-lessons-subagent-hooks.sh +95 -0
- package/core/scripts/tests/test-round-start.sh +296 -13
- package/core/scripts/tests/test-search-devlog.sh +126 -0
- package/core/scripts/tests/test-session-start-devlog.sh +59 -0
- package/core/scripts/tests/test-status-span.sh +3 -3
- package/package.json +2 -2
- package/skills/devlog-tracker/SKILL.md +83 -13
- package/skills/devlog-tracker/references/checkpoint-mode.md +21 -6
- package/skills/devlog-tracker/references/contract.md +83 -0
- package/skills/devlog-tracker/references/lessons-mode.md +38 -8
package/README.zh-TW.md
ADDED
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
# devlog-tracker
|
|
2
|
+
|
|
3
|
+
*[English](README.md) | 繁體中文*
|
|
4
|
+
|
|
5
|
+
**版本** 0.30.0
|
|
6
|
+
|
|
7
|
+
在專案中維護一份 `.devlog/devlog.md`,把每一輪對話的請求、決策與結果寫成永久紀錄。對話一 `/clear` 或換 session 就沒了;這份檔案取代那個缺口,讓工作可以中斷再接。沒下過 `/devlog-tracker:start` 時,裝著也不會動任何檔案。
|
|
8
|
+
|
|
9
|
+
## 這是什麼
|
|
10
|
+
|
|
11
|
+
把「這輪做了什麼、決定了什麼、下一步是什麼」寫進專案內的 `devlog.md`。Stop hook 保證每輪都寫完才放行;沒明確 `/devlog-tracker:start` 前不會建立或改動 `.devlog/`。
|
|
12
|
+
|
|
13
|
+
`devlog.md` 只管**跨 session 的交接連續性**(決策軌跡、目前卡點、完成條件、下一步),並作為 **L1**(人觸發 continue/開 session 注入後,agent 只靠 SSOT 接手,且必須把本輪狀態**寫回**本檔)的主入口。不是整個專案的單一真相來源:
|
|
14
|
+
|
|
15
|
+
- 程式碼/檔案狀態的真相仍是 git
|
|
16
|
+
- 完整逐字過程的真相是對話 transcript(`/clear` 後不存在)
|
|
17
|
+
- 設計決策的真相是 `docs/design/*.md`
|
|
18
|
+
|
|
19
|
+
這份檔案只是取代「終端機一 clear 就沒了」的缺口,讓工作可以隨時中斷、隨時接續。L2(無人喚醒)與 L3(跨機共享 `.devlog/`)不在範圍;細節見 [`docs/design/devlog-as-ssot-assessment.md`](docs/design/devlog-as-ssot-assessment.md)。
|
|
20
|
+
|
|
21
|
+
每輪收尾固定寫 `Summary`/`Reply`(對使用者說過的話)/`Handoff`(含未完成時的 `完成條件`)/`Status`。接手=核對工作區 → 做下一步 → **寫回**;讀而不寫算交接失敗。
|
|
22
|
+
|
|
23
|
+
## 安裝
|
|
24
|
+
|
|
25
|
+
三個平台對等,各自獨立安裝;同一個專案要用哪個或哪幾個都可以,但同一個平台**不要同時**用 plugin marketplace 跟 `npx init` 兩條路線,會讓 hook 觸發兩次。
|
|
26
|
+
|
|
27
|
+
### Claude Code
|
|
28
|
+
|
|
29
|
+
**方式一:plugin marketplace(會自動更新)**
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
/plugin marketplace add gogogohuang/devlog-tracker
|
|
33
|
+
/plugin install devlog-tracker@devlog-tracker
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
指令用 `/devlog-tracker:*`(例如 `/devlog-tracker:start`)。
|
|
37
|
+
|
|
38
|
+
**方式二:npx(vendor 進專案,版本可鎖定)**
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
npx devlog-tracker init --claude
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
會把 hooks 合併進 `.claude/settings.local.json`(不是 `settings.json`——合併後的指令路徑含這台機器的絕對路徑,不該 commit;`settings.local.json` 是 Claude Code 預設 gitignore 的檔案),並把 `commands/*.md` 轉成 `.claude/skills/devlog-<名稱>/SKILL.md`,用 `/devlog-<名稱>` 執行;同時在 `CLAUDE.md` 加上一段 `<!-- devlog-tracker:begin/end -->` fallback 說明。
|
|
45
|
+
|
|
46
|
+
### Codex
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
npx devlog-tracker init --codex
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
會把 `codex/hooks.json` 的 `hooks` 合併進專案 `.codex/hooks.json`,並從 `commands/*.md` 產生 `.agents/skills/devlog-<名稱>/SKILL.md`,用 `$devlog-<名稱>`(或 `/skills` 選)執行;同時在 `AGENTS.md` 加上同一種 fallback 說明區塊。舊版(0.25.0)寫到 `.codex/prompts/` 的檔案會在重跑 `init` 時清掉——Codex 不讀專案層級的 custom prompts。
|
|
53
|
+
|
|
54
|
+
**hook 需要審核才會執行。** Codex 對新增或有變動的 hook 要求先審核;沒核准的 hook 會被直接略過,而且**沒有任何警告**,看起來就像 devlog 沒在記錄。這跟專案有沒有設成 `trust_level = "trusted"` 是兩回事,專案信任不會讓 hook 生效。
|
|
55
|
+
|
|
56
|
+
- 互動模式:第一次開啟時 Codex 會提示有 hook 需要審核,核准後才會執行。之後 hook 的設定有變動(例如重跑 `init` 讓路徑或指令改變)也可能要再核准一次。
|
|
57
|
+
- 非互動的 `codex exec`(CI、腳本):未審核的 hook 會被靜默略過。`--dangerously-bypass-hook-trust` 可以讓它們跑起來,但那個旗標會略過所有 hook 的信任檢查,只適合已經自己確認過 hook 來源的自動化環境。
|
|
58
|
+
- 想確認有沒有生效:`start` 之後送一則訊息,看 `.devlog/.round-current.md` 有沒有出現這一輪的 User Input skeleton;沒有就代表 hook 沒被執行。
|
|
59
|
+
|
|
60
|
+
Codex 目前沒有對應「使用者中斷」(Claude Code 的 `PostToolUseFailure`/`is_interrupt`)與「這輪異常結束」(`StopFailure`)的事件,這兩種細節狀態在 Codex 上不會被標記成 `INTERRUPTED`;核心強制記錄機制(`Stop` 事件擋住未寫完的輪次)不受影響。
|
|
61
|
+
|
|
62
|
+
### Cursor
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
npx devlog-tracker init --cursor
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
會把 `cursor/hooks.json` 的 `hooks` 合併進專案 `.cursor/hooks.json`。Cursor 沒有 slash 指令面,hooks 裝好後照 commands/*.md 的步驟手動執行對應腳本。Cursor cloud agent 不執行 `sessionStart`,因此不會自動注入接手摘要;其他已設定的 hook 仍依 Cursor 支援的事件執行。
|
|
69
|
+
|
|
70
|
+
### 三平台共通
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
npx devlog-tracker init
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
沒帶 `--claude`/`--codex`/`--cursor` 時會互動式問要裝哪個平台;在沒有 TTY 的環境(例如 CI)且沒帶旗標時,`init` 不會詢問,直接安裝全部三個平台。也可以組合指定,例如 `npx devlog-tracker init --claude --codex`。
|
|
77
|
+
|
|
78
|
+
會把 `core/scripts/`、`claude/hooks.json`、`codex/hooks/`、`cursor/hooks/`、`skills/`、`commands/` 複製進專案的 `.devlog-tracker/`。重新執行 `npx devlog-tracker init` 可以升級到套件目前的版本;`npx devlog-tracker status` 可以查目前裝的版本是否落後。
|
|
79
|
+
|
|
80
|
+
`init` 會把這台機器專屬的絕對路徑寫進各平台的 hooks 設定檔與 `.devlog-tracker/env.sh`。如果你把這些檔案 commit 進 git,每位隊友都要在自己的機器上跑一次 `npx devlog-tracker init`(路徑每台機器不同);或者改成把 `.devlog-tracker/` 與產生出來的 hooks 設定檔加進 `.gitignore`。
|
|
81
|
+
|
|
82
|
+
若要手動裝(不透過 npx),設定 `DEVLOG_TRACKER_ROOT` 為本 plugin 的絕對路徑,把對應平台的 `hooks.json` 的 `hooks` 合併進專案設定;`commands/*.md` 會優先讀 `DEVLOG_TRACKER_ROOT`,否則讀 `CLAUDE_PLUGIN_ROOT`:
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
export DEVLOG_TRACKER_ROOT=/absolute/path/to/devlog-tracker
|
|
86
|
+
export DEVLOG_PROJECT_DIR="$(pwd)"
|
|
87
|
+
bash "$DEVLOG_TRACKER_ROOT/core/scripts/start-devlog.sh"
|
|
88
|
+
bash "$DEVLOG_TRACKER_ROOT/core/scripts/status-devlog.sh"
|
|
89
|
+
bash "$DEVLOG_TRACKER_ROOT/core/scripts/segment-watch-set.sh" 600
|
|
90
|
+
bash "$DEVLOG_TRACKER_ROOT/core/scripts/checkpoint-set.sh" 20
|
|
91
|
+
# pause / span-open / span-close / compact / keep-move / clean / resume:見 commands/*.md
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## 快速開始
|
|
95
|
+
|
|
96
|
+
在專案裡下一次(依安裝方式擇一):
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
/devlog-tracker:start # Claude Code plugin
|
|
100
|
+
/devlog-start # npx init --claude
|
|
101
|
+
$devlog-start # npx init --codex
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
之後正常對話即可,每一輪結束前都會被強制檢查、補上 `.devlog/devlog.md` 的紀錄。`/clear` 之後 context 是空的;要接著做上一題,下對應的 `continue` 指令。暫停、歸檔、具名搬走、狀態與 span 見下方指令表。
|
|
105
|
+
|
|
106
|
+
## 指令
|
|
107
|
+
|
|
108
|
+
下表以 plugin 的 `/devlog-tracker:*` namespace 表示;`npx init --claude` 裝的是 `/devlog-<名稱>`,`npx init --codex` 裝的是 `$devlog-<名稱>`,指令內容相同。
|
|
109
|
+
|
|
110
|
+
| 指令 | 做什麼 |
|
|
111
|
+
|---|---|
|
|
112
|
+
| `/devlog-tracker:start` | 跑腳本建立 `.devlog/.enabled`(缺的 state 檔會補上,已有門檻不重置)。讀檔對進度,不自動開工。`.devlog/` 含 prompt,會建議加進 `.gitignore`,要你同意才改。 |
|
|
113
|
+
| `/devlog-tracker:continue` | 讀 `.devlog/devlog.md`,核對最後一輪 Handoff「工作區」後再依下一步接著做。`/clear` 之後要接續用這個。細節見 [`docs/design/continue.md`](docs/design/continue.md)。 |
|
|
114
|
+
| `/devlog-tracker:pause` | 暫停強制記錄,歷史檔不動,之後可再 `start`。 |
|
|
115
|
+
| `/devlog-tracker:compact` | 腳本把較舊的 `DONE` 輪次搬到 `devlog.archive.md`(Checkpoint 與未完成輪留在主檔)。 |
|
|
116
|
+
| `/devlog-tracker:keep` | 掃全檔分主題,一次列出建議,確認後把各段各自搬走成 `devlog.<name>.md`(並在主檔留一個 `## Kept 索引` 指標行,含一句主題描述);也可抽出一段或合併成全部歷史一檔。不是 compact。細節見 [`docs/design/keep.md`](docs/design/keep.md)。 |
|
|
117
|
+
| `/devlog-tracker:overview` | 讀完所有已 keep 的 `devlog.<name>.md`,整合成跨主題總覽,並列出看起來該進 `CLAUDE.md` 的規範候選。純讀取,不核對工作區、不等確認、不寫檔。細節見 [`docs/design/keep.md`](docs/design/keep.md) Kept index。 |
|
|
118
|
+
| `/devlog-tracker:search <關鍵字>` | 在 `devlog.md`/`devlog.archive.md`/已 keep 的 `devlog.<name>.md`/`devlog.lessons.<topic>.md` 裡做不分大小寫的字串搜尋;Claude 讀完命中後用自己的話回答(必要時附檔名/標題/行號)。純讀取,不核對工作區、不等確認、不寫檔。 |
|
|
119
|
+
| `/devlog-tracker:resume <name>` | 讀具名保存檔的最後一輪與 Handoff,核對「工作區」後提出接續;新工作仍寫回主 `devlog.md`。 |
|
|
120
|
+
| `/devlog-tracker:clean` | 無條件清空 `devlog.md`(含專案摘要與所有 Round 歷史),不搬移、不備份、不可復原;執行前一定會先問,要明確回覆「清空」才動手。只留目前開著的那一輪,重編成 `## Round 1`。 |
|
|
121
|
+
| `/devlog-tracker:status` | 查看強制記錄開關、Span、Checkpoint、Segment Watch、Lessons Mode 工作區漂移計數與最後一輪 Status。 |
|
|
122
|
+
| `/devlog-tracker:span` | 開啟或關閉自動續接長任務使用的 Span Mode(不要手寫 `.span-open` JSON)。 |
|
|
123
|
+
| `/devlog-tracker:segment-watch <時間長度>` | 調整 Segment Watch 的沉默門檻(預設 10 分鐘)。專案還沒 `/devlog-tracker:start` 時回報 `NOT_STARTED`,不會建立任何檔案。 |
|
|
124
|
+
| `/devlog-tracker:checkpoint <輪數>` | 調整 Checkpoint Mode 的沉默門檻(預設 20 輪)。專案還沒 start 時回報 `NOT_STARTED`。 |
|
|
125
|
+
| `/devlog-tracker:lessons-on` | 開啟預設關閉的 Lessons Mode(隸屬主開關,沒 `start` 過會拒絕)。細節見 [`docs/design/lessons-mode.md`](docs/design/lessons-mode.md)。 |
|
|
126
|
+
| `/devlog-tracker:lessons-off` | 關閉 Lessons Mode,不動任何已寫的 `devlog.lessons.*.md` 或索引。 |
|
|
127
|
+
| `/devlog-tracker:lessons [<topic>]` | 沒給 topic:印 `## Lessons 索引`。給 topic:印該主題檔全文。純讀取,不核對工作區、不等確認。 |
|
|
128
|
+
| `/devlog-tracker:lessons-drift <次數>` | 調整 Lessons Mode「工作區漂移重複發生」機制性提醒的門檻(預設 3 次)。隸屬 Lessons Mode,沒開會回報 `LESSONS_NOT_ENABLED`。 |
|
|
129
|
+
|
|
130
|
+
## 強制記錄開著之後
|
|
131
|
+
|
|
132
|
+
```mermaid
|
|
133
|
+
sequenceDiagram
|
|
134
|
+
participant U as 使用者
|
|
135
|
+
participant H as Hooks
|
|
136
|
+
participant C as Claude
|
|
137
|
+
participant D as .devlog/devlog.md
|
|
138
|
+
|
|
139
|
+
U->>H: 送出訊息
|
|
140
|
+
H->>D: 先寫 Round skeleton(User Input + IN_PROGRESS)
|
|
141
|
+
C->>D: 補 Summary / Reply / Handoff,改 Status
|
|
142
|
+
C->>H: 這一輪要結束
|
|
143
|
+
alt 沒寫完、標題是空的,或 Status 不合法
|
|
144
|
+
H-->>C: 擋住,要求補寫
|
|
145
|
+
else 寫完了
|
|
146
|
+
H-->>C: 放行
|
|
147
|
+
end
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
每一輪固定:
|
|
151
|
+
|
|
152
|
+
- **`User Input`** — 送出原文優先(hook 寫入;Claude 不要改寫),常見 token 會遮罩
|
|
153
|
+
- **`Summary`** — 給人掃的結論
|
|
154
|
+
- **`Reply`** — 這輪對使用者說過/答應過的話
|
|
155
|
+
- **`Handoff`** — 給下一輪接手(決策/檔案/工作區/現況/完成條件/下一步)
|
|
156
|
+
- **`Status`** — `DONE` / `IN_PROGRESS` / `BLOCKED` / `INTERRUPTED` 四選一
|
|
157
|
+
|
|
158
|
+
其中「工作區」是收尾時的 git 快照,進行中/卡住必寫;`DONE` 若「檔案」有內容(宣稱動過/commit 過檔案)也必寫。「完成條件」在進行中/卡住必寫。
|
|
159
|
+
|
|
160
|
+
Stop hook 會做這些事:
|
|
161
|
+
|
|
162
|
+
1. 確認 `Summary`/`Reply`/`Handoff` 標題底下有內容、Status 是上述四值之一;Handoff 小節順序為 決策 → 檔案 → 工作區 → 現況 → 完成條件 → 下一步
|
|
163
|
+
2. 進行中/卡住時有「完成條件」與「下一步」;「下一步」不是純黑名單空話(例如整節只寫「繼續完成」;字串比對,非語意評分,細節見 [`docs/design/next-step-blacklist.md`](docs/design/next-step-blacklist.md));進行中另做輕量可執行檢查;卡住時「現況」或「下一步」須含缺件句式
|
|
164
|
+
3. 機器核對「工作區」是否跟收尾當下的 git 狀態逐字相符(進行中/卡住一律核對,`DONE` 只在「檔案」非空時核對),避免「已 commit 完成」卻其實沒 commit 這類宣稱跟實際不符
|
|
165
|
+
|
|
166
|
+
`#### 檔案` 非空時同樣機器核對:commit 區塊要跟該次 commit 的實際內容逐字相符,未 commit 的區塊只要求宣稱的路徑真的存在變更(不要求涵蓋全部,避免把跨輪殘留算成這輪漏列)。
|
|
167
|
+
|
|
168
|
+
細節見 [`docs/design/summary-handoff.md`](docs/design/summary-handoff.md)、[`docs/design/devlog-as-ssot-assessment.md`](docs/design/devlog-as-ssot-assessment.md)、[`docs/design/files-verify.md`](docs/design/files-verify.md) 和 SKILL.md。
|
|
169
|
+
|
|
170
|
+
## Hook 會自動做的事
|
|
171
|
+
|
|
172
|
+
正常規則是「一則使用者訊息 = 一輪,結束前一定要寫完 Summary/Reply/Handoff/Status」。下面四個機制各自放寬這條規則的不同一塊,彼此正交、可以同時存在:
|
|
173
|
+
|
|
174
|
+
| 機制 | 放寬的是 | 解決的問題 |
|
|
175
|
+
|---|---|---|
|
|
176
|
+
| **Span Mode** | 「每次自動喚醒算不算一輪」 | `/loop`、Workflow 這類被自己排程反覆喚醒、不是使用者手動打字觸發的長任務,每個自動 tick 都強制寫完整 Round,會逼出大量沒意義的紀錄,甚至卡住整條自動化流程 |
|
|
177
|
+
| **Checkpoint Mode** | 「有沒有跨輪的摘要路標」 | 一般互動對話每輪都正常寫,但輪數一多,翻閱的人要逐輪爬完才知道整體進度;每段 checkpoint 固定 **決策/待解問題/失敗嘗試** 三段,SessionStart 注入時較容易抓到卡點 |
|
|
178
|
+
| **Reply Fold** | 「一問一答算不算兩輪」 | Claude 用純文字提問、下一則訊息其實是在回答時,預設邏輯(每個 `UserPromptSubmit` 開新 Round)會把這組問答硬拆成兩個不相關的 Round |
|
|
179
|
+
| **Segment Watch** | 「一輪內部要不要留階段性痕跡」 | 一輪做很久(先探索、再決策、再實作、再驗證),憋到最後才寫一次,中途 crash 會把整個過程全部遺失 |
|
|
180
|
+
|
|
181
|
+
以下是各機制實際觸發時的行為:
|
|
182
|
+
|
|
183
|
+
#### 自動接續
|
|
184
|
+
|
|
185
|
+
`SessionStart` hook 在開新 session、resume、`/compact`、`/fork` 時,若目前分支的 `.devlog/handoff.md`(或 `handoff.<branch>.md`)非空會先注入這份 Session Handoff 快照,再注入最後一個 Checkpoint(若有,含其中的 `### 待解問題` 供接手抓卡點)、`## Kept 索引`(若有,不是具名檔內容)加上最近兩輪的 Summary / Handoff / Status,不是整份檔。`IN_PROGRESS`/`BLOCKED` 收尾時 Stop 會覆寫 handoff 檔,`DONE` 會刪掉它。`/clear` 是真的清空,不注入;要接續請 `/devlog-tracker:continue`(先核對「工作區」再做下一步)。細節見 [`docs/design/continue.md`](docs/design/continue.md)、[`docs/design/session-handoff-file.md`](docs/design/session-handoff-file.md)。
|
|
186
|
+
|
|
187
|
+
#### 同輪工作區漂移偵測
|
|
188
|
+
|
|
189
|
+
同一條對話送出下一則訊息時,`UserPromptSubmit` 會拿上一輪 Handoff 的「工作區」跟目前 git 狀態比對;不符就注入提示,並讓 `PreToolUse` 擋住非 devlog 工具,直到這一輪補上含實際快照的 `### 段落`(唯讀的 `git status`/`diff`/`log`/`show`/`rev-parse` 不受影響,方便自行核對)。Span 安靜 tick、task-notification 與 `DONE` 不擋。細節見 [`docs/design/continue.md`](docs/design/continue.md) 與 [`docs/design/segment-watch.md`](docs/design/segment-watch.md)。
|
|
190
|
+
|
|
191
|
+
#### 意外中斷
|
|
192
|
+
|
|
193
|
+
非 usage 的 API 錯誤、SessionEnd、殘留的 `.round-open` 會把開著的 Round 標成 `INTERRUPTED`。usage 用光不算中斷。中途取消(例如 Esc)通常是在**下一則訊息**或**下次 SessionStart(startup / resume / clear / fork)**才補上;`PostToolUseFailure` 的 `is_interrupt` 若有觸發,只是 best-effort,不能當成一定會立刻蓋章。`Status` 下面會多一行 `[reason: ...]` 內部代號方便之後 debug(例如 `dangling:next_prompt`);中斷當下如果是卡在等 `AskUserQuestion` 的回答,Summary/Handoff 會直接說明,不會寫成「意外」。細節見 [`docs/design/recording-moments.md`](docs/design/recording-moments.md)。
|
|
194
|
+
|
|
195
|
+
#### 段落記錄
|
|
196
|
+
|
|
197
|
+
長輪不要憋到最後,邊做邊寫 `### 段落`。同一輪連續約 10 分鐘沒改 `.round-current.md`,`PreToolUse` hook 會擋住下一個工具;先 Read 再 Edit/StrReplace 追加一段(不要 Write 覆寫整檔)。門檻可用 `/devlog-tracker:segment-watch <時間長度>` 調整。Claude Code subagent/dynamic workflow(PreToolUse 帶 `agent_id`)不套用父輪這道閥。細節見 [`docs/design/segment-watch.md`](docs/design/segment-watch.md)。
|
|
198
|
+
|
|
199
|
+
#### Checkpoint Mode
|
|
200
|
+
|
|
201
|
+
累積約 20 輪沒寫跨輪摘要,`Stop` hook 會要求補一段 `## Checkpoint(Round X-Y)`(門檻可調)。內容不用自由段落,標題下固定三小節:
|
|
202
|
+
|
|
203
|
+
- **`### 決策`** — 這段期間的定案
|
|
204
|
+
- **`### 待解問題`** — 仍懸而未決的卡點(下一 session 接手的首要線索)
|
|
205
|
+
- **`### 失敗嘗試`** — 試過但放棄的做法,避免下一任重踩
|
|
206
|
+
|
|
207
|
+
hook 偵測邏輯不變(仍只驗 `## Checkpoint` 標題有沒有新增,不驗三段內容)。撰寫規則見 [`skills/devlog-tracker/references/checkpoint-mode.md`](skills/devlog-tracker/references/checkpoint-mode.md);設計見 [`docs/design/checkpoint-mode.md`](docs/design/checkpoint-mode.md)。
|
|
208
|
+
|
|
209
|
+
#### Span Mode
|
|
210
|
+
|
|
211
|
+
`/loop`、Workflow 這類自動續接的長任務,不必每個 tick 都寫完整 Round,用 tick 計數當安全閥;崩潰最多漏記固定數量的 tick,不是整段。細節見 [`docs/design/span-mode.md`](docs/design/span-mode.md)。
|
|
212
|
+
|
|
213
|
+
#### Reply Fold
|
|
214
|
+
|
|
215
|
+
Claude 用純文字結尾提出問題、下一則訊息才拿到答案時,不用開新 Round——提問前先手動記一段問題原文再跑 `await-open.sh` 標記,下一則訊息(答案)就會自動折進同一個 Round 當一段 `### 段落`,不是拆成兩個不相關的 Round。連續多輪一問一答(例如 grilling)時,中途每題只記問題段落,不必每題重寫 Summary/Reply/Handoff/Status,等整場問答真正結束才收尾一次。`AskUserQuestion` 在同一 turn 內問答,不用 fold,但仍要用 `### 段落(AskUserQuestion)` 記下問題與答案。背景 task-notification(子 agent 完成通知)也會自動走同一套折疊機制,不留原始 XML,只記精簡摘要。細節見 [`docs/design/reply-fold.md`](docs/design/reply-fold.md)。
|
|
216
|
+
|
|
217
|
+
#### 分支各自的 devlog 檔
|
|
218
|
+
|
|
219
|
+
同一個工作目錄裡切換分支時,主檔會依目前 checkout 的分支自動分開:`main`/`master` 繼續用 `.devlog/devlog.md`,其他分支各自用 `.devlog/devlog.<branch>.md`(斜線轉成 `-`)。另開一個 `git worktree`(不同目錄)本來就有自己獨立的 `.devlog/`,不受這個機制影響。第一次在某分支偵測到還沒有專屬檔案、且 `devlog.md` 已有內容時,會把它改名(非複製)成該分支的檔案。細節見 [`docs/design/branch-scoped-devlog.md`](docs/design/branch-scoped-devlog.md)。
|
|
220
|
+
|
|
221
|
+
#### Lessons Mode(預設關閉,不自動)
|
|
222
|
+
|
|
223
|
+
開著時,Status 從 `BLOCKED` 解開、明顯繞路,或工作區漂移累積達門檻(預設 3 次,`/devlog-tracker:lessons-drift <次數>` 可調)才考慮記一筆開發歷程教訓,per-topic 存成 `devlog.lessons.<topic>.md`,`devlog.md` 只留標題索引。Claude Code 上,sub agent/Workflow agent 開始時(`SubagentStart`)會被注入 `lessons-append.sh` 的用法(絕對路徑,worktree isolation 也不會寫錯地方),可以自己記一筆;sub agent 回來或背景任務通知到達時,主 session 會看到一句 `[Lessons Mode 提示]`(`failed`/`killed` 另算進共用計數器)。這些訊號都完全不 hook 強制寫入本身、不是知識庫(架構決策仍在 `docs/design/*.md`)。細節見 [`docs/design/lessons-mode.md`](docs/design/lessons-mode.md)。
|
|
224
|
+
|
|
225
|
+
## 測試
|
|
226
|
+
|
|
227
|
+
```
|
|
228
|
+
bash core/scripts/run-tests.sh
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
含 Cursor adapter。
|
|
232
|
+
|
|
233
|
+
## License
|
|
234
|
+
|
|
235
|
+
Apache-2.0
|
package/claude/hooks.json
CHANGED
|
@@ -31,6 +31,27 @@
|
|
|
31
31
|
]
|
|
32
32
|
}
|
|
33
33
|
],
|
|
34
|
+
"SubagentStart": [
|
|
35
|
+
{
|
|
36
|
+
"hooks": [
|
|
37
|
+
{
|
|
38
|
+
"type": "command",
|
|
39
|
+
"command": "bash \"${CLAUDE_PLUGIN_ROOT}/core/scripts/lessons-subagent-start.sh\""
|
|
40
|
+
}
|
|
41
|
+
]
|
|
42
|
+
}
|
|
43
|
+
],
|
|
44
|
+
"PostToolUse": [
|
|
45
|
+
{
|
|
46
|
+
"matcher": "Agent|Task",
|
|
47
|
+
"hooks": [
|
|
48
|
+
{
|
|
49
|
+
"type": "command",
|
|
50
|
+
"command": "bash \"${CLAUDE_PLUGIN_ROOT}/core/scripts/lessons-subagent-done.sh\""
|
|
51
|
+
}
|
|
52
|
+
]
|
|
53
|
+
}
|
|
54
|
+
],
|
|
34
55
|
"PostToolUseFailure": [
|
|
35
56
|
{
|
|
36
57
|
"hooks": [
|
package/cli/agents-md.js
CHANGED
|
@@ -23,6 +23,7 @@ function codexBlock() {
|
|
|
23
23
|
| 歸檔 / compact | \`commands/compact.md\` |
|
|
24
24
|
| 清空重編 / clean(不可復原,先問使用者確認) | \`commands/clean.md\` |
|
|
25
25
|
| 保存主題 / keep、接續具名檔 / resume、跨主題總覽 / overview | \`commands/keep.md\`、\`commands/resume.md\`、\`commands/overview.md\` |
|
|
26
|
+
| 搜尋 / search | \`commands/search.md\` |
|
|
26
27
|
| 長任務定期記錄 / span | \`commands/span.md\` |
|
|
27
28
|
| 調整沉默門檻 / checkpoint、segment-watch | \`commands/checkpoint.md\`、\`commands/segment-watch.md\` |
|
|
28
29
|
| 開發歷程教訓 / lessons、lessons-on、lessons-off、lessons-drift | \`commands/lessons.md\`、\`commands/lessons-on.md\`、\`commands/lessons-off.md\`、\`commands/lessons-drift.md\` |
|
package/commands/keep.md
CHANGED
|
@@ -34,16 +34,19 @@ description: 掃描整份 devlog.md,把值得留名的主題段落一次分別
|
|
|
34
34
|
回覆:
|
|
35
35
|
採用 → 全部照上面寫入
|
|
36
36
|
改第 N 段範圍 <from>-<to> / 改第 N 段檔名 <name> / 移除第 N 段
|
|
37
|
+
摘要第 N 段 → 這一段搬完後,把敘事部分改寫得更精簡(見下方說明)
|
|
37
38
|
全部歷史合併成一個檔 <name> → 放棄分段,整份歷史存成一檔
|
|
38
39
|
取消
|
|
39
40
|
```
|
|
40
41
|
|
|
41
|
-
同一則回覆可以合併多條修改,例如「改第 2 段檔名 foo,移除第 3 段」。`N` 一律對應上面列出的原始編號,修改不會讓其他段落重新編號。
|
|
42
|
+
同一則回覆可以合併多條修改,例如「改第 2 段檔名 foo,移除第 3 段,摘要第 1 段」。`N` 一律對應上面列出的原始編號,修改不會讓其他段落重新編號。
|
|
43
|
+
|
|
44
|
+
「摘要第 N 段」是選配、預設關閉:不特別指定就跟現在一樣,逐字搬移。指定的段落記下來,留到步驟 5.5 使用;跟「改範圍」「改檔名」同一則回覆可以合併,不影響步驟 4 的驗證。
|
|
42
45
|
|
|
43
46
|
然後停止。使用者還沒回覆前不要寫任何檔。
|
|
44
47
|
|
|
45
48
|
- 取消,或套用修改後一段都不剩 → 不改檔,結束。
|
|
46
|
-
- 「全部歷史合併成一個檔 `<name>`」→ 放棄前面列出的分段,改成單一段:`from` = 最早的歷史 Round、`to` = 最晚的歷史 Round(仍不含開著的 Round),`<name>` 用使用者這裡給的名稱。之後只處理這一段,跳過步驟 4
|
|
49
|
+
- 「全部歷史合併成一個檔 `<name>`」→ 放棄前面列出的分段,改成單一段:`from` = 最早的歷史 Round、`to` = 最晚的歷史 Round(仍不含開著的 Round),`<name>` 用使用者這裡給的名稱。之後只處理這一段,跳過步驟 4 的「重疊」與「批次撞名」檢查(只有一段);「摘要」仍可套用在這唯一一段上。
|
|
47
50
|
- 其他回覆(採用 / 各種修改組合)→ 帶著套用修改後的段落清單,進入步驟 4。
|
|
48
51
|
|
|
49
52
|
## 4. 驗證每一段的範圍與檔名(不通過就再問一次,仍不寫檔)
|
|
@@ -89,6 +92,19 @@ DEVLOG_PROJECT_DIR="$(pwd)" bash "${PLUGIN_ROOT}/core/scripts/keep-move.sh" \
|
|
|
89
92
|
|
|
90
93
|
如果這批段落最終涵蓋了 `devlog.md` 目前剩下的所有歷史 Round(沒有瑣碎段落留下),跑到最後一段(Round 號碼最新的那一段)時,腳本會自動判定為 full keep:專案摘要併入那一檔、開著的 Round 重編號成 1、`.span-open` 刪除、checkpoint counter 歸零。這是預期行為,不用特別處理,也不用另外判斷「這是不是 full keep」。
|
|
91
94
|
|
|
95
|
+
## 5.5 選配:摘要標記為「摘要第 N 段」的段落
|
|
96
|
+
|
|
97
|
+
只處理步驟 3 使用者明確標記要摘要、且步驟 5 已成功搬移的段落。沒有任何段落被標記時,整節跳過。
|
|
98
|
+
|
|
99
|
+
這一步是 Claude 自己改寫,不是另外呼叫 LLM API、不是腳本邏輯——`keep-move.sh` 在步驟 5 已經把該段逐字搬進 `devlog.<name>.md`,機器可核對的欄位跟這一步無關。對每個被標記的段落:
|
|
100
|
+
|
|
101
|
+
1. 用 Read 讀出該段剛寫入的 `devlog.<name>.md` 全文。
|
|
102
|
+
2. 只能改寫每個 `## Round` 裡的敘事文字:`### Summary`、`### Reply`、`#### 決策`、`#### 現況`。把同一輪裡這幾節的內容改寫得更精簡,可以合併重複的敘述,但不要跨 Round 合併——Round 的數量與編號必須維持原樣。
|
|
103
|
+
3. 絕對不要動:`## Round <n> — <時間戳>` 標題本身、`### User Input`、`#### 工作區`、`#### 檔案`、`#### 完成條件`、`#### 下一步`、`### Status`,以及 `## Kept 索引`。這些是機器核對過的事實或 `resume`/`continue` 接手時要逐字比對的欄位,摘要只能動無法被 git 或 Stop 驗證的敘事散文。
|
|
104
|
+
4. 用 Edit 把改寫後的內容寫回同一個檔案(不要用 Write 整檔覆寫,避免不小心動到上面列的欄位)。
|
|
105
|
+
|
|
106
|
+
改寫完成後才進入步驟 6/7 回報;回報時註明哪幾段套用了摘要。
|
|
107
|
+
|
|
92
108
|
## 6. 處理腳本結果
|
|
93
109
|
|
|
94
110
|
每段成功時記下 stdout 給的具名檔路徑、`ROUNDS=<from>-<to>` 與 `REMAINING=<int>`,等這批全部段落都跑完(或某段失敗中止)後,一次在步驟 7 回報。
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: 調整 Lessons Mode
|
|
2
|
+
description: 調整 Lessons Mode 機制性提醒的共用門檻——工作區漂移或 BLOCKED 輪次累積達幾次才印一次建議。
|
|
3
3
|
---
|
|
4
4
|
|
|
5
5
|
取得使用者要設定的次數(正整數);沒帶就先問,不要用預設值硬猜。跑:
|
|
@@ -9,7 +9,7 @@ PLUGIN_ROOT="${DEVLOG_TRACKER_ROOT:-${CLAUDE_PLUGIN_ROOT:-}}"
|
|
|
9
9
|
DEVLOG_PROJECT_DIR="$(pwd)" bash "${PLUGIN_ROOT}/core/scripts/lessons-drift-set.sh" <次數>
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
不要自己手改 `.devlog/.lessons-
|
|
12
|
+
不要自己手改 `.devlog/.lessons-advisory-state`。
|
|
13
13
|
|
|
14
14
|
- stdout 是 `NOT_STARTED`:告知這個專案還沒 `/devlog-tracker:start`,問要不要現在
|
|
15
15
|
`/devlog-tracker:start`,不要自己跑 start。
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 在 devlog.md/archive/keep 檔/lessons 檔裡搜尋關鍵字,讀完命中後用自己的話回答(純讀取,不核對工作區、不等確認)。
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
取得使用者提供的 `<關鍵字>`(或自然語言查詢裡的關鍵片語);沒有給的話先問。這是純讀取,不做 `commands/continue.md`/`commands/resume.md` 那套「核對工作區、等確認才動手」流程——搜尋結果是導航用的參考,不是暫停中的工作主題。讀完之後不要自動據此修改任何檔案,除非使用者接著明確要求。
|
|
6
|
+
|
|
7
|
+
記下你目前已經確認的專案根目錄絕對路徑(後面步驟都要用這個值,不要用 `$(pwd)` 重新推——理由同 `commands/continue.md` 步驟 1)。先決定 plugin 根目錄(有 `DEVLOG_TRACKER_ROOT` 用它;否則用 `CLAUDE_PLUGIN_ROOT`;兩者都空就用含 `.claude-plugin/plugin.json` 的本 plugin 根目錄),再跑:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
PLUGIN_ROOT="${DEVLOG_TRACKER_ROOT:-${CLAUDE_PLUGIN_ROOT:-}}"
|
|
11
|
+
DEVLOG_PROJECT_DIR="<剛才記下的專案根目錄絕對路徑>" bash "${PLUGIN_ROOT}/core/scripts/search-devlog.sh" "<關鍵字>"
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
這支腳本會掃過 `.devlog/devlog*.md`(含 `devlog.md`、`devlog.archive.md`、已 keep 的 `devlog.<name>.md`、`devlog.lessons.<topic>.md`,以及分支各自的 `devlog.<branch>.md`——一個 glob 涵蓋所有種類,不分別處理),做不分大小寫的字串比對,不是正則、不含 vector/LLM。自然語言查詢由你先抽出要搜的關鍵片語再丟給腳本;腳本本身不做 NLP。
|
|
15
|
+
|
|
16
|
+
- `NO_INDEX`:告知目前還沒有任何 devlog 檔案,結束。
|
|
17
|
+
- `NO_MATCH`:告知這個關鍵字沒有命中,結束。
|
|
18
|
+
- 其他輸出:每個有命中的檔案先印一行 `FILE=.devlog/<檔名>`,接著是該檔案裡每一行命中,格式 `HEADING="<離命中最近的上方 ## 或 ### 標題>" LINE=<行號>: <命中行原文>`。
|
|
19
|
+
|
|
20
|
+
**回答姿勢(跟 `/devlog-tracker:overview` 不同,也跟「原樣貼出列表」不同):** 讀完腳本輸出後,用自己的話回答使用者在問什麼(決策、現況、誰提過什麼),把命中當依據串成敘事;必要時附上檔名、最近標題、行號當出處。不要把 `FILE=`/`HEADING=` 原始輸出整段貼給使用者當主回答。命中很多時先摘要再說細節,不要機械 dump。若命中落在具名檔或 lessons 檔,可提醒再用 `/devlog-tracker:resume <name>` 或 `/devlog-tracker:lessons <topic>` 看全文。
|
|
21
|
+
|
|
22
|
+
標題比對不是圍欄感知的(不特別處理 ``` 區塊),命中或標題落在程式碼區塊裡時仍會照樣列出;這是刻意的簡化,換取不用重新實作 `devlog-md.sh` 的圍欄邏輯。
|
package/commands/status.md
CHANGED
|
@@ -11,4 +11,5 @@ PLUGIN_ROOT="${DEVLOG_TRACKER_ROOT:-${CLAUDE_PLUGIN_ROOT:-}}"
|
|
|
11
11
|
DEVLOG_PROJECT_DIR="$(pwd)" bash "${PLUGIN_ROOT}/core/scripts/status-devlog.sh"
|
|
12
12
|
```
|
|
13
13
|
```
|
|
14
|
-
把 stdout 翻譯成給人看的幾行(含 `LESSONS=yes/no`:Lessons Mode 開關狀態;`
|
|
14
|
+
把 stdout 翻譯成給人看的幾行(含 `LESSONS=yes/no`:Lessons Mode 開關狀態;`LESSONS_ADVISORY=<count>/<threshold>`:Lessons Mode 開著時,機制性訊號(工作區漂移不符、或
|
|
15
|
+
BLOCKED 輪次累積)的共用累積次數/門檻)。不要改任何檔。`NOT_STARTED` 就說還沒 `/devlog-tracker:start`。
|
|
@@ -60,6 +60,7 @@ else
|
|
|
60
60
|
fi
|
|
61
61
|
|
|
62
62
|
rm -f "$DEVLOG_DIR/.span-open" "$DEVLOG_DIR/.interrupted" "$DEVLOG_DIR/.awaiting-reply"
|
|
63
|
+
rm -f "$HANDOFF_FILE"
|
|
63
64
|
if [ -f "$DEVLOG_DIR/.checkpoint-state" ]; then
|
|
64
65
|
json_int_set "$DEVLOG_DIR/.checkpoint-state" rounds_since_checkpoint 0
|
|
65
66
|
json_int_set "$DEVLOG_DIR/.checkpoint-state" checkpoint_marker_count 0
|
|
@@ -2,8 +2,9 @@
|
|
|
2
2
|
# Sourced helper for serializing writes under .devlog.
|
|
3
3
|
devlog_lock_acquire() {
|
|
4
4
|
local dir="${DEVLOG_DIR:-.}/.lock"
|
|
5
|
-
local start now
|
|
5
|
+
local start now pid
|
|
6
6
|
LOCK_HELD=0
|
|
7
|
+
LOCK_CONTENDED_BY=""
|
|
7
8
|
command -v mkdir >/dev/null 2>&1 || return 0
|
|
8
9
|
command -v rmdir >/dev/null 2>&1 || return 0
|
|
9
10
|
command -v date >/dev/null 2>&1 || return 0
|
|
@@ -12,10 +13,24 @@ devlog_lock_acquire() {
|
|
|
12
13
|
while true; do
|
|
13
14
|
if mkdir "$dir" 2>/dev/null; then
|
|
14
15
|
LOCK_HELD=1
|
|
16
|
+
printf '%s\n' "$$" > "$dir/pid" 2>/dev/null || true
|
|
15
17
|
return 0
|
|
16
18
|
fi
|
|
19
|
+
pid="$(cat "$dir/pid" 2>/dev/null || true)"
|
|
20
|
+
case "$pid" in
|
|
21
|
+
''|*[!0-9]*) pid='' ;;
|
|
22
|
+
esac
|
|
23
|
+
# Stale lock: the pid that created it is no longer running (a crashed
|
|
24
|
+
# session), so reclaim it immediately instead of waiting out the full
|
|
25
|
+
# contention timeout below.
|
|
26
|
+
if [ -n "$pid" ] && ! kill -0 "$pid" 2>/dev/null; then
|
|
27
|
+
rm -rf "$dir" 2>/dev/null || true
|
|
28
|
+
continue
|
|
29
|
+
fi
|
|
17
30
|
now="$(date +%s 2>/dev/null || echo 0)"
|
|
18
31
|
if [ $((now - start)) -ge 2 ]; then
|
|
32
|
+
# shellcheck disable=SC2034 # consumed by callers (e.g. enforce-devlog.sh), not used in this file
|
|
33
|
+
LOCK_CONTENDED_BY="$pid"
|
|
19
34
|
return 0
|
|
20
35
|
fi
|
|
21
36
|
sleep 0.1 2>/dev/null || true
|
|
@@ -24,6 +39,7 @@ devlog_lock_acquire() {
|
|
|
24
39
|
|
|
25
40
|
devlog_lock_release() {
|
|
26
41
|
if [ "${LOCK_HELD:-0}" -eq 1 ]; then
|
|
42
|
+
rm -f "${DEVLOG_DIR:-.}/.lock/pid" 2>/dev/null || true
|
|
27
43
|
rmdir "${DEVLOG_DIR:-.}/.lock" 2>/dev/null || true
|
|
28
44
|
LOCK_HELD=0
|
|
29
45
|
fi
|
|
@@ -14,18 +14,23 @@ _devlog_sanitize_name() {
|
|
|
14
14
|
printf '%s' "$1" | sed -E 's/[^A-Za-z0-9._-]/-/g; s/-+/-/g; s/^-+//; s/-+$//'
|
|
15
15
|
}
|
|
16
16
|
|
|
17
|
-
# Sets DEVLOG_DIR and
|
|
18
|
-
# $1 (defaults to "."). main/master (any case) and anything
|
|
19
|
-
# git repo or has no resolvable branch keep the shared
|
|
20
|
-
#
|
|
21
|
-
#
|
|
22
|
-
#
|
|
23
|
-
#
|
|
24
|
-
#
|
|
17
|
+
# Sets DEVLOG_DIR, DEVLOG_FILE, and HANDOFF_FILE for the branch currently
|
|
18
|
+
# checked out in $1 (defaults to "."). main/master (any case) and anything
|
|
19
|
+
# that isn't a git repo or has no resolvable branch keep the shared
|
|
20
|
+
# devlog.md / handoff.md. Any other branch gets
|
|
21
|
+
# devlog.<sanitized-branch>.md and handoff.<sanitized-branch>.md; a
|
|
22
|
+
# detached HEAD (or an unborn branch, which git also reports as "HEAD"
|
|
23
|
+
# here) falls back to the working directory's own basename. The first
|
|
24
|
+
# time a branch resolves to a file that doesn't exist yet while
|
|
25
|
+
# devlog.md already has content, the existing devlog.md is renamed (not
|
|
26
|
+
# copied) into that branch's file. handoff.md is never renamed on first
|
|
27
|
+
# resolve (current-state snapshot, not history).
|
|
25
28
|
devlog_resolve_paths() {
|
|
26
29
|
local dir="${1:-.}"
|
|
27
30
|
DEVLOG_DIR="$dir/.devlog"
|
|
28
31
|
DEVLOG_FILE="$DEVLOG_DIR/devlog.md"
|
|
32
|
+
# shellcheck disable=SC2034 # consumed by callers (e.g. enforce-devlog.sh), not used in this file
|
|
33
|
+
HANDOFF_FILE="$DEVLOG_DIR/handoff.md"
|
|
29
34
|
|
|
30
35
|
local branch raw name
|
|
31
36
|
branch="$(git -C "$dir" rev-parse --abbrev-ref HEAD 2>/dev/null || echo '')"
|
|
@@ -67,4 +72,6 @@ devlog_resolve_paths() {
|
|
|
67
72
|
devlog_lock_release
|
|
68
73
|
fi
|
|
69
74
|
DEVLOG_FILE="$resolved"
|
|
75
|
+
# shellcheck disable=SC2034 # consumed by callers (e.g. enforce-devlog.sh), not used in this file
|
|
76
|
+
HANDOFF_FILE="$DEVLOG_DIR/handoff.$name.md"
|
|
70
77
|
}
|
|
@@ -31,6 +31,8 @@ SCRIPT_DIR="$(cd "${_src%/*}" && pwd)"
|
|
|
31
31
|
. "$SCRIPT_DIR/files-snapshot.sh"
|
|
32
32
|
# shellcheck source=devlog-md.sh
|
|
33
33
|
. "$SCRIPT_DIR/devlog-md.sh"
|
|
34
|
+
# shellcheck source=handoff-file.sh
|
|
35
|
+
. "$SCRIPT_DIR/handoff-file.sh"
|
|
34
36
|
|
|
35
37
|
# --- loop guard -------------------------------------------------------
|
|
36
38
|
# 有 jq 就用 jq 精準解析;沒有 jq 就退化成字串比對(沒有更嚴謹的 parse,但
|
|
@@ -89,6 +91,10 @@ TURN_MARKER="$DEVLOG_DIR/.turn-start"
|
|
|
89
91
|
|
|
90
92
|
devlog_lock_acquire
|
|
91
93
|
trap 'devlog_lock_release' EXIT
|
|
94
|
+
if [ -n "${LOCK_CONTENDED_BY:-}" ]; then
|
|
95
|
+
echo "另一個 session(pid ${LOCK_CONTENDED_BY})目前正在寫 ${DEVLOG_FILE},稍後再結束這一輪重試一次。" >&2
|
|
96
|
+
exit 2
|
|
97
|
+
fi
|
|
92
98
|
|
|
93
99
|
# --- span 檢查(Span Mode:橫跨多次自動續接的長任務)---------------------
|
|
94
100
|
# Claude 主動宣告的 .devlog/.span-open 存在時(見 SKILL.md),這個 tick 不
|
|
@@ -550,6 +556,15 @@ ${ACTUAL_DIRTY:-(沒有,工作樹乾淨)}"
|
|
|
550
556
|
exit 2
|
|
551
557
|
fi
|
|
552
558
|
fi
|
|
559
|
+
|
|
560
|
+
# Session Handoff → .devlog/handoff.md(docs/design/session-handoff-file.md)
|
|
561
|
+
# 放在其他 IN_PROGRESS/BLOCKED 檢查之後,避免搶先蓋掉既有失敗訊息。
|
|
562
|
+
if [ "$STATUS_VAL" = "IN_PROGRESS" ] || [ "$STATUS_VAL" = "BLOCKED" ]; then
|
|
563
|
+
if ! handoff_session_section_ok "$LAST_ROUND"; then
|
|
564
|
+
echo "Status 是 IN_PROGRESS 或 BLOCKED 時,必須有 \`### Session Handoff\`,且依序包含 \`#### 決策\`/\`#### 待解問題\`/\`#### 失敗嘗試\`(可寫 \`- (無)\`)。寫完後 hook 會覆寫 .devlog/handoff.md 給下一 session。" >&2
|
|
565
|
+
exit 2
|
|
566
|
+
fi
|
|
567
|
+
fi
|
|
553
568
|
fi
|
|
554
569
|
|
|
555
570
|
rm -f "$DEVLOG_DIR/.workspace-mismatch" 2>/dev/null || true
|
|
@@ -573,6 +588,16 @@ rm -f "$DEVLOG_DIR/.workspace-mismatch" 2>/dev/null || true
|
|
|
573
588
|
if [ -n "$LAST_ROUND" ]; then
|
|
574
589
|
if devlog_merge_round_current "$DEVLOG_FILE" "$ROUND_CURRENT"; then
|
|
575
590
|
rm -f "$DEVLOG_DIR/.round-open" 2>/dev/null || true
|
|
591
|
+
case "${STATUS_VAL:-}" in
|
|
592
|
+
IN_PROGRESS|BLOCKED)
|
|
593
|
+
handoff_write "$HANDOFF_FILE" "$LAST_ROUND" 2>/dev/null || \
|
|
594
|
+
echo "警告:無法寫入 Session Handoff 檔($HANDOFF_FILE),本輪仍已收尾。" >&2
|
|
595
|
+
;;
|
|
596
|
+
DONE)
|
|
597
|
+
handoff_clear "$HANDOFF_FILE" 2>/dev/null || \
|
|
598
|
+
echo "警告:無法清除 Session Handoff 檔($HANDOFF_FILE),本輪仍已收尾。" >&2
|
|
599
|
+
;;
|
|
600
|
+
esac
|
|
576
601
|
fi
|
|
577
602
|
else
|
|
578
603
|
rm -f "$DEVLOG_DIR/.round-open" 2>/dev/null || true
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
# Sourced helper: validate / extract / write / clear Session Handoff file.
|
|
3
|
+
# See docs/design/session-handoff-file.md.
|
|
4
|
+
|
|
5
|
+
# Odd ``` count → treat as no fence (same fail-open as enforce-devlog.sh).
|
|
6
|
+
_handoff_nofence_flag() {
|
|
7
|
+
local blob="$1" n
|
|
8
|
+
n="$(printf '%s\n' "$blob" | grep -c '^[ \t]*```' 2>/dev/null || echo 0)"
|
|
9
|
+
case "$n" in ''|*[!0-9]*) n=0 ;; esac
|
|
10
|
+
if [ $((n % 2)) -eq 1 ]; then
|
|
11
|
+
echo 1
|
|
12
|
+
else
|
|
13
|
+
echo 0
|
|
14
|
+
fi
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
# Returns 0 if $1 (a Round blob) has ### Session Handoff with #### 決策 /
|
|
18
|
+
# #### 待解問題 / #### 失敗嘗試 in that order, each with a non-empty body.
|
|
19
|
+
handoff_session_section_ok() {
|
|
20
|
+
local blob="$1" nofence
|
|
21
|
+
nofence="$(_handoff_nofence_flag "$blob")"
|
|
22
|
+
printf '%s\n' "$blob" | awk -v nofence="$nofence" '
|
|
23
|
+
BEGIN { ok = 0 }
|
|
24
|
+
/^[ \t]*```/ { if (!nofence) fence = !fence; next }
|
|
25
|
+
fence { next }
|
|
26
|
+
/^### Session Handoff[ \t]*$/ { in_sh = 1; next }
|
|
27
|
+
in_sh && /^### / { exit }
|
|
28
|
+
in_sh && /^## / { exit }
|
|
29
|
+
in_sh && /^#### / {
|
|
30
|
+
name = $0
|
|
31
|
+
sub(/^#### [ \t]*/, "", name)
|
|
32
|
+
sub(/[ \t]+$/, "", name)
|
|
33
|
+
if (name == "決策" || name == "待解問題" || name == "失敗嘗試") {
|
|
34
|
+
if (expecting_body) { exit }
|
|
35
|
+
if (name == "決策") {
|
|
36
|
+
if (seen_decision || seen_open || seen_failed) exit
|
|
37
|
+
seen_decision = 1
|
|
38
|
+
expecting_body = 1
|
|
39
|
+
} else if (name == "待解問題") {
|
|
40
|
+
if (!seen_decision || seen_open || seen_failed) exit
|
|
41
|
+
seen_open = 1
|
|
42
|
+
expecting_body = 1
|
|
43
|
+
} else {
|
|
44
|
+
if (!seen_decision || !seen_open || seen_failed) exit
|
|
45
|
+
seen_failed = 1
|
|
46
|
+
expecting_body = 1
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
next
|
|
50
|
+
}
|
|
51
|
+
in_sh && expecting_body {
|
|
52
|
+
if ($0 ~ /[^[:space:]]/) {
|
|
53
|
+
expecting_body = 0
|
|
54
|
+
if (seen_decision && seen_open && seen_failed) ok = 1
|
|
55
|
+
}
|
|
56
|
+
next
|
|
57
|
+
}
|
|
58
|
+
END { exit(ok && seen_decision && seen_open && seen_failed && !expecting_body ? 0 : 1) }
|
|
59
|
+
'
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
# Print independent-file markdown from Round blob $1. Exit 1 if invalid.
|
|
63
|
+
handoff_extract_file_body() {
|
|
64
|
+
local blob="$1" nofence
|
|
65
|
+
handoff_session_section_ok "$blob" || return 1
|
|
66
|
+
nofence="$(_handoff_nofence_flag "$blob")"
|
|
67
|
+
printf '%s\n' "$blob" | awk -v nofence="$nofence" '
|
|
68
|
+
BEGIN { print "## Session Handoff"; print "" }
|
|
69
|
+
/^[ \t]*```/ { if (!nofence) fence = !fence; next }
|
|
70
|
+
fence { next }
|
|
71
|
+
/^### Session Handoff[ \t]*$/ { in_sh = 1; next }
|
|
72
|
+
in_sh && /^### / { exit }
|
|
73
|
+
in_sh && /^## / { exit }
|
|
74
|
+
in_sh && /^#### / {
|
|
75
|
+
name = $0
|
|
76
|
+
sub(/^#### [ \t]*/, "", name)
|
|
77
|
+
sub(/[ \t]+$/, "", name)
|
|
78
|
+
if (name == "決策" || name == "待解問題" || name == "失敗嘗試") {
|
|
79
|
+
if (printing) print ""
|
|
80
|
+
print "### " name
|
|
81
|
+
printing = 1
|
|
82
|
+
grab = 1
|
|
83
|
+
next
|
|
84
|
+
}
|
|
85
|
+
grab = 0
|
|
86
|
+
next
|
|
87
|
+
}
|
|
88
|
+
in_sh && grab { print }
|
|
89
|
+
'
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
# Atomic write of extracted body to $1 from Round blob $2.
|
|
93
|
+
handoff_write() {
|
|
94
|
+
local path="$1" blob="$2" dir tmp body
|
|
95
|
+
body="$(handoff_extract_file_body "$blob")" || return 1
|
|
96
|
+
dir="$(dirname "$path")"
|
|
97
|
+
mkdir -p "$dir" 2>/dev/null || true
|
|
98
|
+
tmp="$(mktemp "$dir/.handoff.XXXXXX")" || return 1
|
|
99
|
+
printf '%s\n' "$body" > "$tmp" || { rm -f "$tmp"; return 1; }
|
|
100
|
+
mv "$tmp" "$path" || { rm -f "$tmp"; return 1; }
|
|
101
|
+
return 0
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
handoff_clear() {
|
|
105
|
+
rm -f "$1"
|
|
106
|
+
}
|