@house365/comate 0.5.0 → 0.7.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.
Files changed (30) hide show
  1. package/README.md +27 -9
  2. package/bin/cli.mjs +6 -0
  3. package/bin/doctor.mjs +86 -2
  4. package/bin/init-run.mjs +1 -1
  5. package/bin/init.mjs +2 -2
  6. package/bin/usage.mjs +252 -0
  7. package/docs/COMATE_MANUAL.md +710 -669
  8. package/package.json +3 -2
  9. package/skills/comate/SKILL.md +17 -20
  10. package/skills/comate/reference/decision-points.md +3 -3
  11. package/skills/comate/reference/prerequisites.md +1 -2
  12. package/skills/comate/scripts/comate-lib.sh +29 -12
  13. package/skills/comate/scripts/comate.sh +10 -10
  14. package/skills/comate/tests/comate.bats +31 -26
  15. package/skills/comate-build/SKILL.md +3 -3
  16. package/skills/comate-fix/SKILL.md +153 -0
  17. package/skills/{comate-intake → comate-gate}/SKILL.md +26 -6
  18. package/skills/{comate-intake → comate-gate}/scaffold/docs/README.md +2 -2
  19. package/skills/{comate-intake → comate-gate}/scaffold/docs/architecture/README.md +2 -2
  20. package/skills/{comate-intake → comate-gate}/scaffold/docs/knowledge-base/README.md +8 -8
  21. package/skills/comate-gate/scaffold/docs/knowledge-base/integrations/README.md +31 -0
  22. package/skills/{comate-intake → comate-gate}/scaffold/docs/knowledge-base/requirements/_templates/PRD.md +2 -2
  23. package/skills/comate-grill/SKILL.md +6 -6
  24. package/skills/comate-kb-integration/SKILL.md +128 -0
  25. package/skills/comate-kb-integration/scripts/fetch_rendered_doc.py +84 -0
  26. package/skills/comate-open/SKILL.md +5 -5
  27. package/skills/comate-hotfix/SKILL.md +0 -115
  28. package/skills/comate-tweak/SKILL.md +0 -109
  29. /package/skills/{comate-intake → comate-gate}/scaffold/docs/knowledge-base/integrations/_TEMPLATE/README.md +0 -0
  30. /package/skills/{comate-intake → comate-gate}/scaffold/docs/knowledge-base/integrations/_TEMPLATE/api-snapshot.md +0 -0
@@ -61,14 +61,14 @@ bash "$COMATE" sources <name> track docs/knowledge-base/<path>.md --note "<可
61
61
 
62
62
  ### 2c. PRD 门禁前置守卫(从 PRD 建 change 时必须通过)
63
63
 
64
- 若本 change **来自一份原始 PRD**(用户经 `/comate-intake` 拆分而来,或直接指定了来源 PRD),在创建 change 结构**之前**必须先过门禁守卫:
64
+ 若本 change **来自一份原始 PRD**(用户经 `/comate-gate` 拆分而来,或直接指定了来源 PRD),在创建 change 结构**之前**必须先过门禁守卫:
65
65
 
66
66
  ```bash
67
67
  bash "$COMATE" gate <prd路径> check
68
68
  ```
69
69
 
70
70
  - **PASS(exit 0)**:`<PRD>.gate.yaml` 存在、`gate_status ∈ {passed, passed-with-tbd}`、且 PRD 哈希未漂移。继续建 change。
71
- - **BLOCK(exit 1)**:门禁不存在 / 未通过 / PRD 通过后被改(stale)。**不得创建 change**,停止并提示用户先跑 `/comate-intake` 对该 PRD 过门禁。
71
+ - **BLOCK(exit 1)**:门禁不存在 / 未通过 / PRD 通过后被改(stale)。**不得创建 change**,停止并提示用户先跑 `/comate-gate` 对该 PRD 过门禁。
72
72
 
73
73
  建成后把该 change 记回门禁:
74
74
 
@@ -76,7 +76,7 @@ bash "$COMATE" gate <prd路径> check
76
76
  bash "$COMATE" gate <prd路径> spawned <name>
77
77
  ```
78
78
 
79
- 需求**来自对话**(非 PRD)时跳过本步——门禁只约束「PRD → change」这条路径。通常本 skill 由 `/comate-intake` 调用并已备妥门禁;用户绕过 intake 直接建 change 时,本守卫是最后一道硬闸门。
79
+ 需求**来自对话**(非 PRD)时跳过本步——门禁只约束「PRD → change」这条路径。通常本 skill 由 `/comate-gate` 调用并已备妥门禁;用户绕过 gate 直接建 change 时,本守卫是最后一道硬闸门。
80
80
 
81
81
  ### 3. 入口状态验证
82
82
 
@@ -117,7 +117,7 @@ bash "$COMATE" state <name> check open
117
117
  bash "$COMATE" guard <name> open --apply
118
118
  ```
119
119
 
120
- full 流程自动更新为 `phase: design`;hotfix/tweak 预设自动更新为 `phase: build`。
120
+ full 流程自动更新为 `phase: design`;fix 预设自动更新为 `phase: build`。
121
121
 
122
122
  ## 自动流转
123
123
 
@@ -125,4 +125,4 @@ full 流程自动更新为 `phase: design`;hotfix/tweak 预设自动更新为
125
125
 
126
126
  > **REQUIRED NEXT SKILL(完整流程):** 调用 `comate-design` skill 进入深度设计。
127
127
  >
128
- > hotfix/tweak 预设由对应预设 skill 控制后续流转(phase 直接进 build),不经过本节。
128
+ > fix 预设由 `/comate-fix` skill 控制后续流转(phase 直接进 build),不经过本节。
@@ -1,115 +0,0 @@
1
- ---
2
- name: comate-hotfix
3
- description: "comate 预设路径:Bug fix / 热修复。跳过 brainstorming,直接 open → build → verify → archive。适用于行为修复、不涉及新 capability 设计的场景。"
4
- ---
5
-
6
- # comate 预设路径:Hotfix
7
-
8
- 快速 bug fix 工作流:open → build → verify → archive。跳过 brainstorming 和完整 plan。
9
-
10
- **适用条件**(必须全部满足):
11
- 1. 修复已有功能 bug,不新增 capability
12
- 2. 不涉及接口变更或架构调整
13
- 3. 改动范围可预估(通常 ≤ 2 文件)
14
-
15
- **不适用**:修复过程发现需架构调整时,升级为完整 `/comate`。
16
-
17
- ---
18
-
19
- ## 流程(5 阶段)
20
-
21
- 执行链路:open → build → verify → archive。先定位脚本:
22
-
23
- ```bash
24
- COMATE="${COMATE:-$(for r in . ./.claude/skills "$HOME"/.claude/skills "$HOME"/.config/skills "$HOME"/.cursor/skills; do
25
- [ -d "$r" ] && find "$r" -maxdepth 6 -path '*/comate/scripts/comate.sh' -type f -print -quit 2>/dev/null
26
- done | head -1)}"
27
- if [ -z "$COMATE" ]; then
28
- echo "ERROR: comate.sh 未找到,请确认 comate skill 已安装。" >&2
29
- return 1 2>/dev/null || exit 1
30
- fi
31
- ```
32
-
33
- ### 1. 快速开启(preset open)
34
-
35
- 复用 open 能力但用 hotfix 默认值:不执行 `openspec-explore` 长探索,直接精简创建。
36
-
37
- **立即执行:** 使用 Skill 工具加载 `openspec-new-change`。按其指引创建精简产物:proposal.md(问题 + 根因 + 修复目标)、design.md(1 个修复方案)、tasks.md(修复任务)。**无需 delta spec**(除非修复改变已有 spec 验收场景)。
38
-
39
- ```bash
40
- bash "$COMATE" state <name> init hotfix
41
- bash "$COMATE" state <name> check open
42
- bash "$COMATE" guard <name> open --apply
43
- ```
44
-
45
- ### 2. 直接构建(preset build)
46
-
47
- 用 hotfix 默认值 `build_mode: direct`。跳过 `superpowers:brainstorming` 和 `superpowers:writing-plans`(除非任务 > 3,则转入 `/comate-build` 的计划与执行方式选择)。
48
-
49
- 继续或开始修改前,按 `comate/reference/dirty-worktree.md` 处理未提交改动。归因后若发现超出 hotfix,按「升级条件」处理。
50
-
51
- **立即执行:** 按 tasks.md 逐个执行:读未完成任务 → 改代码 → 运行格式化命令 → 运行测试 → 勾选 `- [x]` → 提交(`fix: <简述>`)。全部完成后显式运行测试和构建命令。
52
-
53
- 修复影响已有 spec 验收场景时,在 `specs/<capability>/spec.md` 创建仅含 `## MODIFIED Requirements` 的 delta spec。
54
-
55
- ### 3. 根因消除检查
56
-
57
- **在运行 build guard 之前**:读 proposal.md 的 bug 与根因,搜索验证问题代码不再存在。根因未消除则回 Step 2 继续(仍在 build,无需状态回退)。
58
-
59
- 升级条件命中(深层架构问题 / 需额外接口变更)→ 停止 hotfix,按升级条件阻塞确认。
60
-
61
- 根因确认消除后,生成 build 交接包并流转:
62
-
63
- ```bash
64
- bash "$COMATE" handoff <name> build --write
65
- bash "$COMATE" guard <name> build --apply
66
- ```
67
-
68
- ### 4. 验证(preset verify)
69
-
70
- **立即执行:** 使用 Skill 工具加载 `comate-verify`。由其规模评估决定轻量或完整验证。无 delta spec 的小 hotfix 通常走轻量验证。验证通过后按其规则记录 `verify_result: pass`。
71
-
72
- ### 5. 归档(preset archive)
73
-
74
- **立即执行:** 使用 Skill 工具加载 `comate-archive`。归档前必须 `verify_result: pass`。有 delta spec 则同步到 main spec。
75
-
76
- ---
77
-
78
- ## 连续执行模式
79
-
80
- <IMPORTANT>
81
- Hotfix 为**一次性连续执行**。调用后在自有步骤间自动推进,但以下必须暂停(决策点见 `comate/reference/decision-points.md`):
82
- 1. 命中升级条件(决策点 6)→ AskUserQuestion 确认升级
83
- 2. 任务 > 3 转入 `/comate-build` 时的隔离和执行方式选择(决策点 3)
84
- 3. comate-verify 的验证失败决策(决策点 4)和分支处理决策(决策点 5)
85
-
86
- 执行顺序:快速开启 → 直接构建 → 根因消除检查 → 验证 → 归档 → 完成。
87
- </IMPORTANT>
88
-
89
- ---
90
-
91
- ## 升级条件(决策阻塞点 6)
92
-
93
- 满足**任一**即停止 hotfix 升级为完整 `/comate`:
94
-
95
- | 条件 | 说明 |
96
- |------|------|
97
- | 改动 **3+ 文件** | 超出单点修复 |
98
- | 架构变更 | 新模块、新接口、新依赖 |
99
- | 数据库 schema 变更 | 结构性调整 |
100
- | 引入新 public API | 修复产生新对外接口 |
101
- | 范围超出单一函数/模块 | 需多处协调 |
102
-
103
- **必须使用 AskUserQuestion 工具暂停确认升级**。不得直接进 `/comate-design`,不得自动补 Design Doc。用户确认后**先更新 workflow**:
104
-
105
- ```bash
106
- bash "$COMATE" state <name> set workflow full
107
- ```
108
-
109
- 然后**立即加载 `comate-design` skill** 补 Design Doc,走完整流程。用户不确认则停止 hotfix 并报告超出适用范围。
110
-
111
- ## 退出条件
112
-
113
- - Bug 已修复,测试通过,change 已归档
114
- - 如有 spec 变更已同步到 main spec
115
- - **阶段守卫**:build → verify 前 `bash "$COMATE" guard <name> build --apply`,verify → archive 按 `/comate-verify` 规则运行
@@ -1,109 +0,0 @@
1
- ---
2
- name: comate-tweak
3
- description: "comate 预设路径:非 bug 的小改动(tweak)。跳过 brainstorming 和完整 plan,直接 open → 轻量 build → 轻量 verify → archive。适用于文案、配置、文档或 prompt 的局部优化。"
4
- ---
5
-
6
- # comate 预设路径:Tweak
7
-
8
- Tweak 是 comate 五阶段能力的预设工作流,复用 open/build/verify/archive,仅跳过 brainstorming 和完整 plan。
9
-
10
- 适用于非 bug 的小范围变更(文案、配置、文档、prompt 局部优化)。
11
-
12
- **适用条件**(必须全部满足):
13
- 1. 不新增 capability
14
- 2. 不改变架构
15
- 3. 不涉及接口变化
16
- 4. 通常不超过 3 个 tasks、4 个文件
17
-
18
- **不适用**:发现需 capability、架构或接口调整时升级为完整 `/comate`。
19
-
20
- ---
21
-
22
- ## 流程(4 阶段)
23
-
24
- 执行链路:open → 轻量 build → 轻量 verify → archive。先定位脚本:
25
-
26
- ```bash
27
- COMATE="${COMATE:-$(for r in . ./.claude/skills "$HOME"/.claude/skills "$HOME"/.config/skills "$HOME"/.cursor/skills; do
28
- [ -d "$r" ] && find "$r" -maxdepth 6 -path '*/comate/scripts/comate.sh' -type f -print -quit 2>/dev/null
29
- done | head -1)}"
30
- if [ -z "$COMATE" ]; then
31
- echo "ERROR: comate.sh 未找到,请确认 comate skill 已安装。" >&2
32
- return 1 2>/dev/null || exit 1
33
- fi
34
- ```
35
-
36
- ### 1. 快速开启(preset open)
37
-
38
- 复用 open 能力但用 tweak 默认值:不执行 `openspec-explore` 长探索。
39
-
40
- **立即执行:** 使用 Skill 工具加载 `openspec-new-change`。创建精简产物:proposal.md(动机 + 目标 + 范围)、design.md(简短实现说明)、tasks.md(≤ 3 任务)。**无需 delta spec**(一旦需要 delta spec 即升级为完整 `/comate`)。
41
-
42
- ```bash
43
- bash "$COMATE" state <name> init tweak
44
- bash "$COMATE" state <name> check open
45
- bash "$COMATE" guard <name> open --apply
46
- ```
47
-
48
- ### 2. 轻量构建(preset build)
49
-
50
- 用 tweak 默认值 `build_mode: direct`。跳过 `superpowers:brainstorming` 和 `superpowers:writing-plans`。
51
-
52
- 继续或开始修改前,按 `comate/reference/dirty-worktree.md` 处理未提交改动。归因后若超出 tweak,按「升级条件」处理。
53
-
54
- **立即执行:** 按 tasks.md 逐个执行:改目标文件 → 运行格式化命令 → 运行测试 → 勾选 `- [x]` → 提交(`tweak: <简述>`)。全部完成后显式运行测试和构建命令,然后流转:
55
-
56
- ```bash
57
- bash "$COMATE" guard <name> build --apply
58
- ```
59
-
60
- > tweak 默认无 plan,build guard 的 impl-context 检查可能要求 `handoff <name> build --write`。tweak 若未写 plan,仍应在全部任务完成后运行 `bash "$COMATE" handoff <name> build --write` 以记录 tasks 的 impl_hash,再跑 build guard。
61
-
62
- ### 3. 轻量验证(preset verify)
63
-
64
- **立即执行:** 使用 Skill 工具加载 `comate-verify`。Tweak 必须保持轻量验证条件(≤ 3 tasks、≤ 4 files、无 delta spec、无新 capability)。若规模评估进入完整验证路径,停止 tweak 按升级条件确认。验证通过后记录 `verify_result: pass`。
65
-
66
- ### 4. 归档(preset archive)
67
-
68
- **立即执行:** 使用 Skill 工具加载 `comate-archive`。归档前必须 `verify_result: pass`。
69
-
70
- ---
71
-
72
- ## 连续执行模式
73
-
74
- <IMPORTANT>
75
- Tweak 为**一次性连续执行**。调用后在自有步骤间自动推进,但以下必须暂停(决策点见 `comate/reference/decision-points.md`):
76
- 1. 命中升级条件(决策点 6)→ AskUserQuestion 确认升级
77
- 2. comate-verify 的验证失败决策(决策点 4)和分支处理决策(决策点 5)
78
-
79
- 执行顺序:快速开启 → 轻量构建 → 轻量验证 → 归档 → 完成。
80
- </IMPORTANT>
81
-
82
- ---
83
-
84
- ## 升级条件(决策阻塞点 6)
85
-
86
- 满足**任一**即停止 tweak 升级为完整 `/comate`:
87
-
88
- | 条件 | 说明 |
89
- |------|------|
90
- | 改动 **5+ 文件** | 超出小改动 |
91
- | 多模块协调 | 跨组件协调 |
92
- | 需新增 **5+** 测试用例 | 复杂度上升 |
93
- | 配置项增删 | 非值修改的配置变更 |
94
- | 需新增 capability | 超出局部优化 |
95
- | 需 delta spec | 影响已有规格 |
96
-
97
- **必须使用 AskUserQuestion 工具暂停确认升级**。用户确认后**先更新 workflow** 再走完整流程:
98
-
99
- ```bash
100
- bash "$COMATE" state <name> set workflow full
101
- ```
102
-
103
- 然后**立即加载 `comate-design` skill** 补 Design Doc。用户不确认则停止 tweak 并报告超出适用范围。
104
-
105
- ## 退出条件
106
-
107
- - 小改动已完成,测试通过,change 已归档
108
- - 未新增 capability、架构调整或接口变化
109
- - **阶段守卫**:build → verify 前 `bash "$COMATE" guard <name> build --apply`,verify → archive 按 `/comate-verify` 规则运行