devlog-tracker 0.25.1 → 0.29.2
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 +131 -151
- package/README.zh-TW.md +235 -0
- package/claude/hooks.json +75 -0
- package/cli/agents-md.js +15 -8
- package/cli/agents-md.test.js +21 -1
- package/cli/init.js +6 -4
- package/cli/init.test.js +5 -4
- package/cli/merge-hooks.js +5 -2
- package/cli/merge-hooks.test.js +52 -0
- package/cli/platforms/claude.js +55 -0
- package/cli/platforms/claude.test.js +178 -0
- package/cli/platforms/codex.js +6 -18
- package/cli/skills-from-commands.js +32 -0
- package/cli/skills-from-commands.test.js +51 -0
- package/cli/vendor.js +8 -1
- package/cli/vendor.test.js +24 -5
- package/codex/hooks/on-pre-tool.sh +3 -3
- package/codex/hooks/on-session-end.sh +2 -2
- package/codex/hooks/on-session-start.sh +2 -2
- package/codex/hooks/on-stop.sh +3 -3
- package/codex/hooks/on-user-prompt-submit.sh +2 -2
- package/codex/hooks/test-adapters.sh +2 -2
- package/commands/checkpoint.md +2 -2
- package/commands/clean.md +3 -3
- package/commands/compact.md +3 -3
- package/commands/continue.md +4 -4
- package/commands/keep.md +21 -5
- package/commands/lessons-drift.md +4 -4
- package/commands/lessons-off.md +3 -3
- package/commands/lessons-on.md +3 -3
- package/commands/lessons.md +3 -3
- package/commands/overview.md +3 -3
- package/commands/pause.md +3 -3
- package/commands/resume.md +3 -3
- package/commands/search.md +22 -0
- package/commands/segment-watch.md +3 -3
- package/commands/span.md +2 -2
- package/commands/start.md +3 -3
- package/commands/status.md +5 -4
- package/{hooks → core}/scripts/await-open.sh +1 -1
- package/{hooks → core}/scripts/checkpoint-set.sh +1 -1
- package/{hooks → core}/scripts/clean-devlog.sh +2 -1
- package/{hooks → core}/scripts/close-open-round.sh +1 -1
- package/{hooks → core}/scripts/compact-devlog.sh +1 -1
- package/{hooks → core}/scripts/devlog-lock.sh +17 -1
- package/{hooks → core}/scripts/devlog-path.sh +15 -8
- package/{hooks → core}/scripts/enforce-devlog.sh +26 -1
- package/core/scripts/handoff-file.sh +106 -0
- package/{hooks → core}/scripts/keep-move.sh +1 -1
- package/{hooks → core}/scripts/kept-list.sh +1 -1
- package/core/scripts/lessons-advisory-state.sh +51 -0
- package/{hooks → core}/scripts/lessons-append.sh +18 -2
- package/core/scripts/lessons-drift-set.sh +46 -0
- package/{hooks → core}/scripts/lessons-off.sh +1 -1
- package/{hooks → core}/scripts/lessons-on.sh +9 -4
- package/{hooks → core}/scripts/lessons-read.sh +1 -1
- package/{hooks → core}/scripts/on-tool-failure.sh +1 -1
- package/{hooks → core}/scripts/pause-devlog.sh +1 -1
- package/core/scripts/project-dir.sh +19 -0
- package/{hooks → core}/scripts/resume-devlog.sh +1 -1
- package/{hooks → core}/scripts/round-start.sh +52 -17
- package/{hooks → core}/scripts/run-tests.sh +1 -1
- package/core/scripts/search-devlog.sh +63 -0
- package/{hooks → core}/scripts/segment-watch-set.sh +1 -1
- package/{hooks → core}/scripts/segment-watch.sh +1 -1
- package/{hooks → core}/scripts/session-start-devlog.sh +8 -1
- package/{hooks → core}/scripts/span-close.sh +1 -1
- package/{hooks → core}/scripts/span-open.sh +1 -1
- package/{hooks → core}/scripts/start-devlog.sh +1 -1
- package/{hooks → core}/scripts/status-devlog.sh +5 -5
- package/{hooks → core}/scripts/tests/test-clean-devlog.sh +12 -0
- package/core/scripts/tests/test-cli-init-e2e.sh +68 -0
- package/core/scripts/tests/test-devlog-lock.sh +76 -0
- package/{hooks → core}/scripts/tests/test-devlog-path.sh +44 -0
- package/{hooks → core}/scripts/tests/test-enforce-devlog-files.sh +11 -0
- package/core/scripts/tests/test-enforce-devlog-session-handoff.sh +178 -0
- package/{hooks → core}/scripts/tests/test-enforce-devlog-workspace.sh +35 -0
- package/{hooks → 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/{hooks → core}/scripts/tests/test-lessons-append.sh +18 -0
- package/{hooks → core}/scripts/tests/test-lessons-drift-set.sh +14 -5
- package/{hooks → core}/scripts/tests/test-lessons-on-off.sh +16 -6
- package/core/scripts/tests/test-project-dir.sh +30 -0
- package/{hooks → core}/scripts/tests/test-round-start.sh +247 -13
- package/core/scripts/tests/test-search-devlog.sh +126 -0
- package/{hooks → core}/scripts/tests/test-session-start-devlog.sh +61 -2
- package/{hooks → core}/scripts/tests/test-status-span.sh +3 -3
- package/{hooks → core}/scripts/workspace-snapshot.sh +2 -2
- package/cursor/hooks/on-pre-tool.sh +2 -2
- package/cursor/hooks/on-session-end.sh +2 -2
- package/cursor/hooks/on-session-start.sh +2 -2
- package/cursor/hooks/on-stop.sh +2 -2
- package/cursor/hooks/on-submit-prompt.sh +2 -2
- package/cursor/hooks/on-tool-failure.sh +2 -2
- package/package.json +5 -4
- package/skills/devlog-tracker/SKILL.md +90 -22
- 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 +33 -9
- package/skills/devlog-tracker/references/reply-fold.md +1 -1
- package/hooks/scripts/lessons-drift-set.sh +0 -42
- package/hooks/scripts/tests/test-cli-init-e2e.sh +0 -38
- package/hooks/scripts/tests/test-devlog-lock.sh +0 -37
- /package/{hooks → core}/scripts/detect-pending-question.sh +0 -0
- /package/{hooks → core}/scripts/devlog-md.sh +0 -0
- /package/{hooks → core}/scripts/files-snapshot.sh +0 -0
- /package/{hooks → core}/scripts/json-field.sh +0 -0
- /package/{hooks → core}/scripts/on-session-end.sh +0 -0
- /package/{hooks → core}/scripts/on-stop-failure.sh +0 -0
- /package/{hooks → core}/scripts/redact-prompt.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-await-open.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-branch-scoped-integration.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-checkpoint-set.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-close-open-round.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-compact-devlog.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-devlog-md.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-enforce-devlog-handoff-order.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-files-snapshot.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-json-field.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-keep-move.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-kept-list.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-lessons-read.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-on-interrupt.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-redact-prompt.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-resume-devlog.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-segment-watch-set.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-segment-watch.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-start-pause-devlog.sh +0 -0
- /package/{hooks → core}/scripts/tests/test-workspace-snapshot.sh +0 -0
package/README.zh-TW.md
ADDED
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
# devlog-tracker
|
|
2
|
+
|
|
3
|
+
*[English](README.md) | 繁體中文*
|
|
4
|
+
|
|
5
|
+
**版本** 0.29.2
|
|
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` 只留標題索引。三種訊號都完全不 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
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
{
|
|
2
|
+
"hooks": {
|
|
3
|
+
"SessionStart": [
|
|
4
|
+
{
|
|
5
|
+
"matcher": "startup|resume|clear|compact|fork",
|
|
6
|
+
"hooks": [
|
|
7
|
+
{
|
|
8
|
+
"type": "command",
|
|
9
|
+
"command": "bash \"${CLAUDE_PLUGIN_ROOT}/core/scripts/session-start-devlog.sh\""
|
|
10
|
+
}
|
|
11
|
+
]
|
|
12
|
+
}
|
|
13
|
+
],
|
|
14
|
+
"UserPromptSubmit": [
|
|
15
|
+
{
|
|
16
|
+
"hooks": [
|
|
17
|
+
{
|
|
18
|
+
"type": "command",
|
|
19
|
+
"command": "bash \"${CLAUDE_PLUGIN_ROOT}/core/scripts/round-start.sh\""
|
|
20
|
+
}
|
|
21
|
+
]
|
|
22
|
+
}
|
|
23
|
+
],
|
|
24
|
+
"PreToolUse": [
|
|
25
|
+
{
|
|
26
|
+
"hooks": [
|
|
27
|
+
{
|
|
28
|
+
"type": "command",
|
|
29
|
+
"command": "bash \"${CLAUDE_PLUGIN_ROOT}/core/scripts/segment-watch.sh\""
|
|
30
|
+
}
|
|
31
|
+
]
|
|
32
|
+
}
|
|
33
|
+
],
|
|
34
|
+
"PostToolUseFailure": [
|
|
35
|
+
{
|
|
36
|
+
"hooks": [
|
|
37
|
+
{
|
|
38
|
+
"type": "command",
|
|
39
|
+
"command": "bash \"${CLAUDE_PLUGIN_ROOT}/core/scripts/on-tool-failure.sh\""
|
|
40
|
+
}
|
|
41
|
+
]
|
|
42
|
+
}
|
|
43
|
+
],
|
|
44
|
+
"StopFailure": [
|
|
45
|
+
{
|
|
46
|
+
"hooks": [
|
|
47
|
+
{
|
|
48
|
+
"type": "command",
|
|
49
|
+
"command": "bash \"${CLAUDE_PLUGIN_ROOT}/core/scripts/on-stop-failure.sh\""
|
|
50
|
+
}
|
|
51
|
+
]
|
|
52
|
+
}
|
|
53
|
+
],
|
|
54
|
+
"SessionEnd": [
|
|
55
|
+
{
|
|
56
|
+
"hooks": [
|
|
57
|
+
{
|
|
58
|
+
"type": "command",
|
|
59
|
+
"command": "bash \"${CLAUDE_PLUGIN_ROOT}/core/scripts/on-session-end.sh\""
|
|
60
|
+
}
|
|
61
|
+
]
|
|
62
|
+
}
|
|
63
|
+
],
|
|
64
|
+
"Stop": [
|
|
65
|
+
{
|
|
66
|
+
"hooks": [
|
|
67
|
+
{
|
|
68
|
+
"type": "command",
|
|
69
|
+
"command": "bash \"${CLAUDE_PLUGIN_ROOT}/core/scripts/enforce-devlog.sh\""
|
|
70
|
+
}
|
|
71
|
+
]
|
|
72
|
+
}
|
|
73
|
+
]
|
|
74
|
+
}
|
|
75
|
+
}
|
package/cli/agents-md.js
CHANGED
|
@@ -5,13 +5,14 @@ const path = require('path');
|
|
|
5
5
|
const BEGIN = '<!-- devlog-tracker:begin -->';
|
|
6
6
|
const END = '<!-- devlog-tracker:end -->';
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
function codexBlock() {
|
|
9
|
+
return `${BEGIN}
|
|
9
10
|
## devlog-tracker
|
|
10
11
|
|
|
11
12
|
這個專案用 devlog-tracker 在 \`.devlog/devlog.md\` 維護逐輪紀錄(Claude Code 與 Codex 共用同一份)。Codex 指令是 \`.agents/skills/devlog-<名稱>/\` 底下的 skill,用 \`/skills\` 選或打 \`$devlog-<名稱>\` 執行;若 skill 不可用,請照下面對照做:
|
|
12
13
|
|
|
13
14
|
1. 先 \`source .devlog-tracker/env.sh\`(設定 \`DEVLOG_TRACKER_ROOT\`)。
|
|
14
|
-
2. 依使用者意圖讀對應的 \`.devlog-tracker/commands/<名稱>.md\`,照裡面的步驟做(腳本在 \`.devlog-tracker/
|
|
15
|
+
2. 依使用者意圖讀對應的 \`.devlog-tracker/commands/<名稱>.md\`,照裡面的步驟做(腳本在 \`.devlog-tracker/core/scripts/\`,執行時 \`DEVLOG_PROJECT_DIR\` 設成專案根目錄)。
|
|
15
16
|
|
|
16
17
|
| 使用者說 | 讀這份 |
|
|
17
18
|
|---|---|
|
|
@@ -22,6 +23,7 @@ const BLOCK = `${BEGIN}
|
|
|
22
23
|
| 歸檔 / compact | \`commands/compact.md\` |
|
|
23
24
|
| 清空重編 / clean(不可復原,先問使用者確認) | \`commands/clean.md\` |
|
|
24
25
|
| 保存主題 / keep、接續具名檔 / resume、跨主題總覽 / overview | \`commands/keep.md\`、\`commands/resume.md\`、\`commands/overview.md\` |
|
|
26
|
+
| 搜尋 / search | \`commands/search.md\` |
|
|
25
27
|
| 長任務定期記錄 / span | \`commands/span.md\` |
|
|
26
28
|
| 調整沉默門檻 / checkpoint、segment-watch | \`commands/checkpoint.md\`、\`commands/segment-watch.md\` |
|
|
27
29
|
| 開發歷程教訓 / lessons、lessons-on、lessons-off、lessons-drift | \`commands/lessons.md\`、\`commands/lessons-on.md\`、\`commands/lessons-off.md\`、\`commands/lessons-drift.md\` |
|
|
@@ -29,23 +31,28 @@ const BLOCK = `${BEGIN}
|
|
|
29
31
|
寫 devlog 的格式與規則見 \`.devlog-tracker/skills/devlog-tracker/SKILL.md\`。每輪結束前必須把當輪寫進 \`.devlog/\`;已 \`start\` 的專案,Stop hook 會擋沒寫完的輪次。
|
|
30
32
|
${END}
|
|
31
33
|
`;
|
|
34
|
+
}
|
|
32
35
|
|
|
33
|
-
function
|
|
34
|
-
const filePath = path.join(targetDir,
|
|
36
|
+
function upsertMarkdown(targetDir, { fileName = 'AGENTS.md', block = codexBlock() } = {}) {
|
|
37
|
+
const filePath = path.join(targetDir, fileName);
|
|
35
38
|
const existing = fs.existsSync(filePath) ? fs.readFileSync(filePath, 'utf8') : '';
|
|
36
39
|
const begin = existing.indexOf(BEGIN);
|
|
37
40
|
const end = existing.indexOf(END);
|
|
38
41
|
|
|
39
42
|
let next;
|
|
40
43
|
if (begin !== -1 && end > begin) {
|
|
41
|
-
next = existing.slice(0, begin) +
|
|
44
|
+
next = existing.slice(0, begin) + block + existing.slice(end + END.length).replace(/^\n/, '');
|
|
42
45
|
} else if (existing.trim() === '') {
|
|
43
|
-
next =
|
|
46
|
+
next = block;
|
|
44
47
|
} else {
|
|
45
|
-
next = `${existing.replace(/\n*$/, '\n')}\n${
|
|
48
|
+
next = `${existing.replace(/\n*$/, '\n')}\n${block}`;
|
|
46
49
|
}
|
|
47
50
|
if (next !== existing) fs.writeFileSync(filePath, next);
|
|
48
51
|
return filePath;
|
|
49
52
|
}
|
|
50
53
|
|
|
51
|
-
|
|
54
|
+
function upsertAgentsMd(targetDir) {
|
|
55
|
+
return upsertMarkdown(targetDir, { fileName: 'AGENTS.md', block: codexBlock() });
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
module.exports = { upsertAgentsMd, upsertMarkdown, codexBlock, BEGIN, END };
|
package/cli/agents-md.test.js
CHANGED
|
@@ -4,7 +4,7 @@ const assert = require('node:assert/strict');
|
|
|
4
4
|
const fs = require('fs');
|
|
5
5
|
const os = require('os');
|
|
6
6
|
const path = require('path');
|
|
7
|
-
const { upsertAgentsMd, BEGIN, END } = require('./agents-md');
|
|
7
|
+
const { upsertAgentsMd, upsertMarkdown, BEGIN, END } = require('./agents-md');
|
|
8
8
|
const { run } = require('./init');
|
|
9
9
|
|
|
10
10
|
function tmp() {
|
|
@@ -74,3 +74,23 @@ test('init --codex writes AGENTS.md and project skills; --cursor alone does not'
|
|
|
74
74
|
await run(['--cursor'], { repoRoot, targetDir: cursorOnly, version: '0.0.0' });
|
|
75
75
|
assert.ok(!fs.existsSync(path.join(cursorOnly, 'AGENTS.md')));
|
|
76
76
|
});
|
|
77
|
+
|
|
78
|
+
test('upsertMarkdown writes to a custom file name with a custom block', () => {
|
|
79
|
+
const targetDir = tmp();
|
|
80
|
+
|
|
81
|
+
const filePath = upsertMarkdown(targetDir, {
|
|
82
|
+
fileName: 'CLAUDE.md',
|
|
83
|
+
block: `${BEGIN}\n## custom\n${END}\n`,
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
assert.equal(filePath, path.join(targetDir, 'CLAUDE.md'));
|
|
87
|
+
assert.equal(fs.readFileSync(filePath, 'utf8'), `${BEGIN}\n## custom\n${END}\n`);
|
|
88
|
+
});
|
|
89
|
+
|
|
90
|
+
test('upsertAgentsMd keeps writing AGENTS.md by default (back-compat)', () => {
|
|
91
|
+
const targetDir = tmp();
|
|
92
|
+
|
|
93
|
+
const filePath = upsertAgentsMd(targetDir);
|
|
94
|
+
|
|
95
|
+
assert.equal(filePath, path.join(targetDir, 'AGENTS.md'));
|
|
96
|
+
});
|
package/cli/init.js
CHANGED
|
@@ -1,18 +1,20 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
const readline = require('readline');
|
|
3
3
|
const { vendor } = require('./vendor');
|
|
4
|
+
const claude = require('./platforms/claude');
|
|
4
5
|
const codex = require('./platforms/codex');
|
|
5
6
|
const cursor = require('./platforms/cursor');
|
|
6
7
|
|
|
7
|
-
const PLATFORMS = { codex, cursor };
|
|
8
|
+
const PLATFORMS = { claude, codex, cursor };
|
|
8
9
|
|
|
9
10
|
function parseArgs(argv) {
|
|
10
11
|
const platforms = [];
|
|
11
12
|
for (const arg of argv) {
|
|
12
|
-
if (arg === '--
|
|
13
|
+
if (arg === '--claude') platforms.push('claude');
|
|
14
|
+
else if (arg === '--codex') platforms.push('codex');
|
|
13
15
|
else if (arg === '--cursor') platforms.push('cursor');
|
|
14
16
|
else if (arg.startsWith('-')) {
|
|
15
|
-
throw new Error(`Unknown option: ${arg} (supported: --codex, --cursor)`);
|
|
17
|
+
throw new Error(`Unknown option: ${arg} (supported: --claude, --codex, --cursor)`);
|
|
16
18
|
}
|
|
17
19
|
}
|
|
18
20
|
return { platforms };
|
|
@@ -22,7 +24,7 @@ function promptPlatforms() {
|
|
|
22
24
|
if (!process.stdin.isTTY) return Promise.resolve(Object.keys(PLATFORMS));
|
|
23
25
|
const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
|
|
24
26
|
return new Promise((resolve) => {
|
|
25
|
-
rl.question('要裝哪個平台?(codex/cursor,逗號分隔,留空=全部): ', (answer) => {
|
|
27
|
+
rl.question('要裝哪個平台?(claude/codex/cursor,逗號分隔,留空=全部): ', (answer) => {
|
|
26
28
|
rl.close();
|
|
27
29
|
const trimmed = answer.trim();
|
|
28
30
|
if (!trimmed) return resolve(Object.keys(PLATFORMS));
|
package/cli/init.test.js
CHANGED
|
@@ -6,16 +6,17 @@ const os = require('os');
|
|
|
6
6
|
const path = require('path');
|
|
7
7
|
const { parseArgs, run } = require('./init');
|
|
8
8
|
|
|
9
|
-
test('parseArgs accepts --codex and --cursor', () => {
|
|
9
|
+
test('parseArgs accepts --claude, --codex and --cursor', () => {
|
|
10
|
+
assert.deepEqual(parseArgs(['--claude']), { platforms: ['claude'] });
|
|
10
11
|
assert.deepEqual(parseArgs(['--codex']), { platforms: ['codex'] });
|
|
11
|
-
assert.deepEqual(parseArgs(['--codex', '--cursor']), { platforms: ['codex', 'cursor'] });
|
|
12
|
+
assert.deepEqual(parseArgs(['--claude', '--codex', '--cursor']), { platforms: ['claude', 'codex', 'cursor'] });
|
|
12
13
|
assert.deepEqual(parseArgs([]), { platforms: [] });
|
|
13
14
|
});
|
|
14
15
|
|
|
15
16
|
test('parseArgs throws a clear error for unknown options', () => {
|
|
16
17
|
assert.throws(
|
|
17
|
-
() => parseArgs(['--
|
|
18
|
-
{ message: 'Unknown option: --
|
|
18
|
+
() => parseArgs(['--foo']),
|
|
19
|
+
{ message: 'Unknown option: --foo (supported: --claude, --codex, --cursor)' }
|
|
19
20
|
);
|
|
20
21
|
assert.throws(() => parseArgs(['--codex', '-x']), /Unknown option: -x/);
|
|
21
22
|
});
|
package/cli/merge-hooks.js
CHANGED
|
@@ -30,9 +30,12 @@ function readExisting(targetPath) {
|
|
|
30
30
|
return parsed;
|
|
31
31
|
}
|
|
32
32
|
|
|
33
|
-
function mergeHooksTemplate({ templatePath, targetPath, vendorRoot }) {
|
|
33
|
+
function mergeHooksTemplate({ templatePath, targetPath, vendorRoot, placeholders = ['${DEVLOG_TRACKER_ROOT}'] }) {
|
|
34
34
|
const escapedRoot = JSON.stringify(vendorRoot).slice(1, -1);
|
|
35
|
-
|
|
35
|
+
let rawTemplate = fs.readFileSync(templatePath, 'utf8');
|
|
36
|
+
for (const placeholder of placeholders) {
|
|
37
|
+
rawTemplate = rawTemplate.split(placeholder).join(escapedRoot);
|
|
38
|
+
}
|
|
36
39
|
const template = JSON.parse(rawTemplate);
|
|
37
40
|
|
|
38
41
|
const existing = readExisting(targetPath);
|
package/cli/merge-hooks.test.js
CHANGED
|
@@ -185,3 +185,55 @@ test('real templates quote the vendor path so project paths with spaces work', (
|
|
|
185
185
|
}
|
|
186
186
|
}
|
|
187
187
|
});
|
|
188
|
+
|
|
189
|
+
test('placeholders parameter substitutes multiple placeholder strings when provided', () => {
|
|
190
|
+
const dir = tmpdir();
|
|
191
|
+
const templatePath = path.join(dir, 'template.json');
|
|
192
|
+
fs.writeFileSync(
|
|
193
|
+
templatePath,
|
|
194
|
+
JSON.stringify({
|
|
195
|
+
hooks: {
|
|
196
|
+
SessionStart: [{ hooks: [{ type: 'command', command: 'bash "${CLAUDE_PLUGIN_ROOT}/script.sh"' }] }],
|
|
197
|
+
Stop: [{ hooks: [{ type: 'command', command: 'bash "${DEVLOG_TRACKER_ROOT}/other.sh"' }] }],
|
|
198
|
+
},
|
|
199
|
+
})
|
|
200
|
+
);
|
|
201
|
+
const targetPath = path.join(dir, 'hooks.json');
|
|
202
|
+
const vendorRoot = '/proj/.devlog-tracker';
|
|
203
|
+
|
|
204
|
+
mergeHooksTemplate({
|
|
205
|
+
templatePath,
|
|
206
|
+
targetPath,
|
|
207
|
+
vendorRoot,
|
|
208
|
+
placeholders: ['${DEVLOG_TRACKER_ROOT}', '${CLAUDE_PLUGIN_ROOT}'],
|
|
209
|
+
});
|
|
210
|
+
|
|
211
|
+
const written = JSON.parse(fs.readFileSync(targetPath, 'utf8'));
|
|
212
|
+
assert.equal(written.hooks.SessionStart[0].hooks[0].command, `bash "${vendorRoot}/script.sh"`);
|
|
213
|
+
assert.equal(written.hooks.Stop[0].hooks[0].command, `bash "${vendorRoot}/other.sh"`);
|
|
214
|
+
});
|
|
215
|
+
|
|
216
|
+
test('unlisted placeholders remain verbatim when placeholders parameter is provided', () => {
|
|
217
|
+
const dir = tmpdir();
|
|
218
|
+
const templatePath = path.join(dir, 'template.json');
|
|
219
|
+
fs.writeFileSync(
|
|
220
|
+
templatePath,
|
|
221
|
+
JSON.stringify({
|
|
222
|
+
hooks: {
|
|
223
|
+
Stop: [{ hooks: [{ type: 'command', command: 'bash "${UNLISTED_PLACEHOLDER}/script.sh"' }] }],
|
|
224
|
+
},
|
|
225
|
+
})
|
|
226
|
+
);
|
|
227
|
+
const targetPath = path.join(dir, 'hooks.json');
|
|
228
|
+
const vendorRoot = '/proj/.devlog-tracker';
|
|
229
|
+
|
|
230
|
+
mergeHooksTemplate({
|
|
231
|
+
templatePath,
|
|
232
|
+
targetPath,
|
|
233
|
+
vendorRoot,
|
|
234
|
+
placeholders: ['${DEVLOG_TRACKER_ROOT}'],
|
|
235
|
+
});
|
|
236
|
+
|
|
237
|
+
const written = JSON.parse(fs.readFileSync(targetPath, 'utf8'));
|
|
238
|
+
assert.equal(written.hooks.Stop[0].hooks[0].command, 'bash "${UNLISTED_PLACEHOLDER}/script.sh"');
|
|
239
|
+
});
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
const path = require('path');
|
|
3
|
+
const { mergeHooksTemplate } = require('../merge-hooks');
|
|
4
|
+
const { upsertMarkdown, BEGIN, END } = require('../agents-md');
|
|
5
|
+
const { generateSkillsFromCommands } = require('../skills-from-commands');
|
|
6
|
+
|
|
7
|
+
function claudeBlock() {
|
|
8
|
+
return `${BEGIN}
|
|
9
|
+
## devlog-tracker
|
|
10
|
+
|
|
11
|
+
這個專案用 devlog-tracker 在 \`.devlog/devlog.md\` 維護逐輪紀錄。指令是 \`.claude/skills/devlog-<名稱>/\` 底下的 skill,用 \`/devlog-<名稱>\` 執行;若 skill 不可用,請照下面對照做:
|
|
12
|
+
|
|
13
|
+
1. 先 \`source .devlog-tracker/env.sh\`(設定 \`DEVLOG_TRACKER_ROOT\`)。
|
|
14
|
+
2. 依使用者意圖讀對應的 \`.devlog-tracker/commands/<名稱>.md\`,照裡面的步驟做(腳本在 \`.devlog-tracker/core/scripts/\`,執行時 \`DEVLOG_PROJECT_DIR\` 設成專案根目錄)。
|
|
15
|
+
|
|
16
|
+
| 使用者說 | 讀這份 |
|
|
17
|
+
|---|---|
|
|
18
|
+
| 開始追蹤 / start | \`/devlog-start\`;\`commands/start.md\` |
|
|
19
|
+
| 暫停 / pause | \`/devlog-pause\`;\`commands/pause.md\` |
|
|
20
|
+
| 狀態 / status | \`/devlog-status\`;\`commands/status.md\` |
|
|
21
|
+
| 接續上一題 / continue(換過工具或 \`/clear\` 之後) | \`commands/continue.md\` |
|
|
22
|
+
| 歸檔 / compact | \`commands/compact.md\` |
|
|
23
|
+
| 清空重編 / clean(不可復原,先問使用者確認) | \`commands/clean.md\` |
|
|
24
|
+
| 保存主題 / keep、接續具名檔 / resume、跨主題總覽 / overview | \`commands/keep.md\`、\`commands/resume.md\`、\`commands/overview.md\` |
|
|
25
|
+
| 長任務定期記錄 / span | \`commands/span.md\` |
|
|
26
|
+
| 調整沉默門檻 / checkpoint、segment-watch | \`commands/checkpoint.md\`、\`commands/segment-watch.md\` |
|
|
27
|
+
| 開發歷程教訓 / lessons、lessons-on、lessons-off、lessons-drift | \`commands/lessons.md\`、\`commands/lessons-on.md\`、\`commands/lessons-off.md\`、\`commands/lessons-drift.md\` |
|
|
28
|
+
|
|
29
|
+
寫 devlog 的格式與規則見 \`.devlog-tracker/skills/devlog-tracker/SKILL.md\`。每輪結束前必須把當輪寫進 \`.devlog/\`;已 \`start\` 的專案,Stop hook 會擋沒寫完的輪次。
|
|
30
|
+
|
|
31
|
+
注意:若同時透過 Claude Code plugin marketplace 安裝了 devlog-tracker,這兩條安裝路線的 hook 都會生效,導致同一輪被記錄兩次;二選一即可。
|
|
32
|
+
${END}
|
|
33
|
+
`;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
function installSkills({ targetDir, vendorRoot }) {
|
|
37
|
+
generateSkillsFromCommands({
|
|
38
|
+
commandsDir: path.join(vendorRoot, 'commands'),
|
|
39
|
+
targetSkillsDir: path.join(targetDir, '.claude', 'skills'),
|
|
40
|
+
namePrefix: 'devlog',
|
|
41
|
+
});
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
function install({ repoRoot, targetDir, vendorRoot }) {
|
|
45
|
+
mergeHooksTemplate({
|
|
46
|
+
templatePath: path.join(repoRoot, 'claude', 'hooks.json'),
|
|
47
|
+
targetPath: path.join(targetDir, '.claude', 'settings.local.json'),
|
|
48
|
+
vendorRoot,
|
|
49
|
+
placeholders: ['${DEVLOG_TRACKER_ROOT}', '${CLAUDE_PLUGIN_ROOT}'],
|
|
50
|
+
});
|
|
51
|
+
installSkills({ targetDir, vendorRoot });
|
|
52
|
+
upsertMarkdown(targetDir, { fileName: 'CLAUDE.md', block: claudeBlock() });
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
module.exports = { install, installSkills };
|