@michaelxwb/code-flow 0.8.1 → 1.0.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 (268) hide show
  1. package/README.md +73 -152
  2. package/bin/code-flow.js +12 -0
  3. package/docs/README.md +19 -0
  4. package/docs/USAGE.md +156 -1417
  5. package/docs/v1-design.md +1858 -0
  6. package/docs/v1-implementation.md +186 -0
  7. package/lib/adapters.js +126 -0
  8. package/lib/cli.js +258 -0
  9. package/lib/config.js +85 -0
  10. package/lib/doctor.js +283 -0
  11. package/lib/frontmatter.js +42 -0
  12. package/lib/fs.js +141 -0
  13. package/lib/glob.js +23 -0
  14. package/lib/hook.js +99 -0
  15. package/lib/init.js +132 -0
  16. package/lib/learn.js +170 -0
  17. package/lib/locks.js +52 -0
  18. package/lib/markdown.js +13 -0
  19. package/lib/process.js +116 -0
  20. package/lib/render.js +115 -0
  21. package/lib/repo.js +48 -0
  22. package/lib/runs.js +155 -0
  23. package/lib/session.js +40 -0
  24. package/lib/spec.js +80 -0
  25. package/lib/task.js +258 -0
  26. package/lib/taskdoc.js +308 -0
  27. package/lib/toml.js +140 -0
  28. package/lib/verify.js +168 -0
  29. package/lib/worktree.js +930 -0
  30. package/package.json +18 -21
  31. package/templates/adapters/opencode.mjs +65 -0
  32. package/templates/config.json +39 -0
  33. package/templates/instructions.md +13 -0
  34. package/templates/launcher/bridge.cjs +295 -0
  35. package/templates/launcher/hook.cmd +15 -0
  36. package/templates/launcher/hook.ps1 +10 -0
  37. package/templates/launcher/hook.sh +20 -0
  38. package/templates/skills/cf-check.md +19 -0
  39. package/templates/skills/cf-init.md +16 -0
  40. package/templates/skills/cf-spec.md +20 -0
  41. package/templates/skills/cf-task-align.md +19 -0
  42. package/templates/skills/cf-task-archive.md +20 -0
  43. package/templates/skills/cf-task-plan.md +31 -0
  44. package/templates/skills/cf-task-prd.md +14 -0
  45. package/templates/skills/cf-task-start.md +41 -0
  46. package/{src/core/code-flow/specs/shared/design → templates/workflow}/design-frontend.md +12 -12
  47. package/{src/core/code-flow/specs/shared/design → templates/workflow}/design-full.md +17 -19
  48. package/{src/core/code-flow/specs/shared/design → templates/workflow}/design-lite.md +12 -12
  49. package/{src/core/code-flow/specs/shared/prd-template.md → templates/workflow/prd.md} +1 -1
  50. package/templates/workflow/project-guidelines.md +48 -0
  51. package/templates/workflow/scenarios.md +67 -0
  52. package/templates/workflow/task.md +56 -0
  53. package/docs/acceptance-contract.md +0 -217
  54. package/docs/ci/acceptance-evidence.md +0 -77
  55. package/docs/migrations/runtime-0.7.0.md +0 -41
  56. package/docs/migrations/runtime-0.8.0.md +0 -154
  57. package/docs/migrations/runtime-0.9.0.md +0 -40
  58. package/docs/migrations/spec-workflow-0.6.0.md +0 -42
  59. package/docs/spec-injection-hardening.md +0 -54
  60. package/docs/spec-injection-performance.json +0 -73
  61. package/docs/spec-optimization.md +0 -12
  62. package/src/adapters/claude/CLAUDE.md +0 -45
  63. package/src/adapters/claude/commands/cf-init.md +0 -262
  64. package/src/adapters/claude/commands/cf-learn.md +0 -291
  65. package/src/adapters/claude/commands/cf-spec.md +0 -87
  66. package/src/adapters/claude/commands/cf-stats.md +0 -96
  67. package/src/adapters/claude/commands/cf-sync.md +0 -39
  68. package/src/adapters/claude/commands/cf-task/align.md +0 -331
  69. package/src/adapters/claude/commands/cf-task/archive.md +0 -155
  70. package/src/adapters/claude/commands/cf-task/block.md +0 -49
  71. package/src/adapters/claude/commands/cf-task/graph.md +0 -92
  72. package/src/adapters/claude/commands/cf-task/note.md +0 -248
  73. package/src/adapters/claude/commands/cf-task/plan.md +0 -477
  74. package/src/adapters/claude/commands/cf-task/prd.md +0 -173
  75. package/src/adapters/claude/commands/cf-task/start.md +0 -317
  76. package/src/adapters/claude/commands/cf-task/status.md +0 -71
  77. package/src/adapters/claude/commands/cf-task/verify-e2e.md +0 -148
  78. package/src/adapters/claude/commands/cf-validate.md +0 -100
  79. package/src/adapters/claude/settings.local.json +0 -50
  80. package/src/adapters/codex/AGENTS.md +0 -45
  81. package/src/adapters/codex/config.toml +0 -3
  82. package/src/adapters/codex/hooks.json +0 -54
  83. package/src/adapters/codex/skills/cf-init/SKILL.md +0 -273
  84. package/src/adapters/codex/skills/cf-learn/SKILL.md +0 -296
  85. package/src/adapters/codex/skills/cf-spec/SKILL.md +0 -88
  86. package/src/adapters/codex/skills/cf-stats/SKILL.md +0 -97
  87. package/src/adapters/codex/skills/cf-sync/SKILL.md +0 -45
  88. package/src/adapters/codex/skills/cf-task-align/SKILL.md +0 -332
  89. package/src/adapters/codex/skills/cf-task-archive/SKILL.md +0 -156
  90. package/src/adapters/codex/skills/cf-task-block/SKILL.md +0 -50
  91. package/src/adapters/codex/skills/cf-task-graph/SKILL.md +0 -93
  92. package/src/adapters/codex/skills/cf-task-note/SKILL.md +0 -245
  93. package/src/adapters/codex/skills/cf-task-plan/SKILL.md +0 -478
  94. package/src/adapters/codex/skills/cf-task-prd/SKILL.md +0 -174
  95. package/src/adapters/codex/skills/cf-task-start/SKILL.md +0 -318
  96. package/src/adapters/codex/skills/cf-task-status/SKILL.md +0 -72
  97. package/src/adapters/codex/skills/cf-task-verify-e2e/SKILL.md +0 -145
  98. package/src/adapters/codex/skills/cf-validate/SKILL.md +0 -102
  99. package/src/adapters/commands.json +0 -115
  100. package/src/adapters/costrict/CLAUDE.md +0 -45
  101. package/src/adapters/costrict/commands/cf-init.md +0 -262
  102. package/src/adapters/costrict/commands/cf-learn.md +0 -291
  103. package/src/adapters/costrict/commands/cf-spec.md +0 -87
  104. package/src/adapters/costrict/commands/cf-stats.md +0 -96
  105. package/src/adapters/costrict/commands/cf-sync.md +0 -39
  106. package/src/adapters/costrict/commands/cf-task/align.md +0 -331
  107. package/src/adapters/costrict/commands/cf-task/archive.md +0 -155
  108. package/src/adapters/costrict/commands/cf-task/block.md +0 -49
  109. package/src/adapters/costrict/commands/cf-task/graph.md +0 -92
  110. package/src/adapters/costrict/commands/cf-task/note.md +0 -248
  111. package/src/adapters/costrict/commands/cf-task/plan.md +0 -477
  112. package/src/adapters/costrict/commands/cf-task/prd.md +0 -173
  113. package/src/adapters/costrict/commands/cf-task/start.md +0 -317
  114. package/src/adapters/costrict/commands/cf-task/status.md +0 -71
  115. package/src/adapters/costrict/commands/cf-task/verify-e2e.md +0 -148
  116. package/src/adapters/costrict/commands/cf-validate.md +0 -100
  117. package/src/adapters/costrict/settings.local.json +0 -50
  118. package/src/adapters/install-plan.json +0 -100
  119. package/src/adapters/opencode/AGENTS.md +0 -45
  120. package/src/adapters/opencode/commands/cf-init.md +0 -281
  121. package/src/adapters/opencode/commands/cf-learn.md +0 -295
  122. package/src/adapters/opencode/commands/cf-spec.md +0 -91
  123. package/src/adapters/opencode/commands/cf-stats.md +0 -100
  124. package/src/adapters/opencode/commands/cf-sync.md +0 -44
  125. package/src/adapters/opencode/commands/cf-task/align.md +0 -331
  126. package/src/adapters/opencode/commands/cf-task/archive.md +0 -160
  127. package/src/adapters/opencode/commands/cf-task/block.md +0 -54
  128. package/src/adapters/opencode/commands/cf-task/graph.md +0 -97
  129. package/src/adapters/opencode/commands/cf-task/note.md +0 -253
  130. package/src/adapters/opencode/commands/cf-task/plan.md +0 -477
  131. package/src/adapters/opencode/commands/cf-task/prd.md +0 -178
  132. package/src/adapters/opencode/commands/cf-task/start.md +0 -317
  133. package/src/adapters/opencode/commands/cf-task/status.md +0 -76
  134. package/src/adapters/opencode/commands/cf-task/verify-e2e.md +0 -148
  135. package/src/adapters/opencode/commands/cf-validate.md +0 -105
  136. package/src/adapters/opencode/opencode.json +0 -3
  137. package/src/adapters/opencode/plugins/code-flow/index.js +0 -162
  138. package/src/adapters/opencode/plugins/code-flow/package.json +0 -6
  139. package/src/adapters/platform-bindings.json +0 -370
  140. package/src/cli.js +0 -1076
  141. package/src/core/code-flow/config.yml +0 -161
  142. package/src/core/code-flow/runtime-commands.json +0 -259
  143. package/src/core/code-flow/scripts/cf_acceptance_manifest.py +0 -10
  144. package/src/core/code-flow/scripts/cf_acceptance_runner.py +0 -10
  145. package/src/core/code-flow/scripts/cf_audit.py +0 -10
  146. package/src/core/code-flow/scripts/cf_codex_hook.py +0 -10
  147. package/src/core/code-flow/scripts/cf_design_lint.py +0 -10
  148. package/src/core/code-flow/scripts/cf_evidence_import.py +0 -10
  149. package/src/core/code-flow/scripts/cf_feedback.py +0 -10
  150. package/src/core/code-flow/scripts/cf_opencode_event.py +0 -10
  151. package/src/core/code-flow/scripts/cf_post_hook.py +0 -11
  152. package/src/core/code-flow/scripts/cf_pre_tool_hook.py +0 -11
  153. package/src/core/code-flow/scripts/cf_scenarios.py +0 -10
  154. package/src/core/code-flow/scripts/cf_spec_context.py +0 -10
  155. package/src/core/code-flow/scripts/cf_spec_gate.py +0 -10
  156. package/src/core/code-flow/scripts/cf_spec_session.py +0 -10
  157. package/src/core/code-flow/scripts/cf_stats.py +0 -10
  158. package/src/core/code-flow/scripts/cf_stop_hook.py +0 -11
  159. package/src/core/code-flow/scripts/cf_sync.py +0 -10
  160. package/src/core/code-flow/scripts/cf_task_index.py +0 -10
  161. package/src/core/code-flow/scripts/cf_task_parallel.py +0 -10
  162. package/src/core/code-flow/scripts/cf_task_workflow.py +0 -10
  163. package/src/core/code-flow/scripts/cf_user_prompt_hook.py +0 -11
  164. package/src/core/code-flow/scripts/cf_validation.py +0 -10
  165. package/src/core/code-flow/scripts/codeflow/__init__.py +0 -0
  166. package/src/core/code-flow/scripts/codeflow/acceptance/__init__.py +0 -0
  167. package/src/core/code-flow/scripts/codeflow/acceptance/cf_acceptance_evidence.py +0 -347
  168. package/src/core/code-flow/scripts/codeflow/acceptance/cf_acceptance_manifest_core.py +0 -660
  169. package/src/core/code-flow/scripts/codeflow/acceptance/cf_acceptance_plan.py +0 -202
  170. package/src/core/code-flow/scripts/codeflow/acceptance/cf_acceptance_registration.py +0 -60
  171. package/src/core/code-flow/scripts/codeflow/acceptance/cf_acceptance_risk.py +0 -73
  172. package/src/core/code-flow/scripts/codeflow/acceptance/cf_acceptance_schema.py +0 -282
  173. package/src/core/code-flow/scripts/codeflow/acceptance/cf_acceptance_selection.py +0 -266
  174. package/src/core/code-flow/scripts/codeflow/acceptance/cf_check_inputs.py +0 -172
  175. package/src/core/code-flow/scripts/codeflow/acceptance/cf_check_registration.py +0 -326
  176. package/src/core/code-flow/scripts/codeflow/acceptance/cf_checks.py +0 -333
  177. package/src/core/code-flow/scripts/codeflow/acceptance/cf_plan_quality.py +0 -197
  178. package/src/core/code-flow/scripts/codeflow/acceptance/cf_scenario_quality.py +0 -174
  179. package/src/core/code-flow/scripts/codeflow/acceptance/cf_scenario_source.py +0 -300
  180. package/src/core/code-flow/scripts/codeflow/acceptance/cf_traceability.py +0 -502
  181. package/src/core/code-flow/scripts/codeflow/cli/__init__.py +0 -0
  182. package/src/core/code-flow/scripts/codeflow/cli/cf_acceptance_manifest.py +0 -347
  183. package/src/core/code-flow/scripts/codeflow/cli/cf_acceptance_runner.py +0 -1490
  184. package/src/core/code-flow/scripts/codeflow/cli/cf_audit.py +0 -533
  185. package/src/core/code-flow/scripts/codeflow/cli/cf_design_lint.py +0 -172
  186. package/src/core/code-flow/scripts/codeflow/cli/cf_evidence_import.py +0 -607
  187. package/src/core/code-flow/scripts/codeflow/cli/cf_feedback.py +0 -53
  188. package/src/core/code-flow/scripts/codeflow/cli/cf_scenarios.py +0 -58
  189. package/src/core/code-flow/scripts/codeflow/cli/cf_spec_context.py +0 -1175
  190. package/src/core/code-flow/scripts/codeflow/cli/cf_spec_gate.py +0 -60
  191. package/src/core/code-flow/scripts/codeflow/cli/cf_spec_session.py +0 -46
  192. package/src/core/code-flow/scripts/codeflow/cli/cf_stats.py +0 -540
  193. package/src/core/code-flow/scripts/codeflow/cli/cf_sync.py +0 -144
  194. package/src/core/code-flow/scripts/codeflow/cli/cf_task_index.py +0 -177
  195. package/src/core/code-flow/scripts/codeflow/cli/cf_task_parallel.py +0 -1142
  196. package/src/core/code-flow/scripts/codeflow/cli/cf_task_workflow.py +0 -742
  197. package/src/core/code-flow/scripts/codeflow/cli/cf_validation.py +0 -31
  198. package/src/core/code-flow/scripts/codeflow/core/__init__.py +0 -0
  199. package/src/core/code-flow/scripts/codeflow/core/cf_context_cache.py +0 -67
  200. package/src/core/code-flow/scripts/codeflow/core/cf_core.py +0 -609
  201. package/src/core/code-flow/scripts/codeflow/core/cf_exec_base.py +0 -325
  202. package/src/core/code-flow/scripts/codeflow/core/cf_fs.py +0 -57
  203. package/src/core/code-flow/scripts/codeflow/core/cf_git.py +0 -92
  204. package/src/core/code-flow/scripts/codeflow/core/cf_log.py +0 -160
  205. package/src/core/code-flow/scripts/codeflow/core/cf_markdown.py +0 -77
  206. package/src/core/code-flow/scripts/codeflow/core/cf_native_paths.py +0 -26
  207. package/src/core/code-flow/scripts/codeflow/core/cf_patch.py +0 -33
  208. package/src/core/code-flow/scripts/codeflow/core/cf_runtime_install.py +0 -32
  209. package/src/core/code-flow/scripts/codeflow/core/cf_session_state.py +0 -37
  210. package/src/core/code-flow/scripts/codeflow/core/cf_stop_guard.py +0 -53
  211. package/src/core/code-flow/scripts/codeflow/core/cf_task_state.py +0 -9
  212. package/src/core/code-flow/scripts/codeflow/core/cf_validators.py +0 -408
  213. package/src/core/code-flow/scripts/codeflow/core/cf_worktree_env.py +0 -253
  214. package/src/core/code-flow/scripts/codeflow/evidence/__init__.py +0 -0
  215. package/src/core/code-flow/scripts/codeflow/evidence/cf_evidence_store.py +0 -527
  216. package/src/core/code-flow/scripts/codeflow/hooks/__init__.py +0 -0
  217. package/src/core/code-flow/scripts/codeflow/hooks/cf_codex_hook.py +0 -95
  218. package/src/core/code-flow/scripts/codeflow/hooks/cf_opencode_event.py +0 -98
  219. package/src/core/code-flow/scripts/codeflow/hooks/cf_post_hook.py +0 -30
  220. package/src/core/code-flow/scripts/codeflow/hooks/cf_pre_tool_hook.py +0 -41
  221. package/src/core/code-flow/scripts/codeflow/hooks/cf_stop_hook.py +0 -292
  222. package/src/core/code-flow/scripts/codeflow/hooks/cf_user_prompt_hook.py +0 -161
  223. package/src/core/code-flow/scripts/codeflow/spec/__init__.py +0 -0
  224. package/src/core/code-flow/scripts/codeflow/spec/cf_active_task.py +0 -412
  225. package/src/core/code-flow/scripts/codeflow/spec/cf_context_refresh.py +0 -301
  226. package/src/core/code-flow/scripts/codeflow/spec/cf_edit_service.py +0 -149
  227. package/src/core/code-flow/scripts/codeflow/spec/cf_injection.py +0 -111
  228. package/src/core/code-flow/scripts/codeflow/spec/cf_rule_readiness.py +0 -114
  229. package/src/core/code-flow/scripts/codeflow/spec/cf_scan.py +0 -367
  230. package/src/core/code-flow/scripts/codeflow/spec/cf_spec_budget.py +0 -55
  231. package/src/core/code-flow/scripts/codeflow/spec/cf_spec_context_model.py +0 -477
  232. package/src/core/code-flow/scripts/codeflow/spec/cf_spec_impact.py +0 -119
  233. package/src/core/code-flow/scripts/codeflow/spec/cf_spec_metadata.py +0 -387
  234. package/src/core/code-flow/scripts/codeflow/spec/cf_spec_migrate.py +0 -529
  235. package/src/core/code-flow/scripts/codeflow/spec/cf_spec_optimize.py +0 -193
  236. package/src/core/code-flow/scripts/codeflow/spec/cf_spec_optimize_apply.py +0 -187
  237. package/src/core/code-flow/scripts/codeflow/spec/cf_spec_resolver.py +0 -369
  238. package/src/core/code-flow/scripts/codeflow/spec/cf_spec_router.py +0 -304
  239. package/src/core/code-flow/scripts/codeflow/spec/cf_spec_verify.py +0 -687
  240. package/src/core/code-flow/scripts/codeflow/spec/cf_stage_gate.py +0 -330
  241. package/src/core/code-flow/scripts/codeflow/spec/cf_task_projection.py +0 -83
  242. package/src/core/code-flow/scripts/codeflow/spec/cf_workflow_service.py +0 -755
  243. package/src/core/code-flow/scripts/codeflow/spec/cf_workflow_transaction.py +0 -110
  244. package/src/core/code-flow/scripts/codeflow/task/__init__.py +0 -0
  245. package/src/core/code-flow/scripts/codeflow/task/cf_requirement_verification.py +0 -867
  246. package/src/core/code-flow/scripts/codeflow/task/cf_task_doc.py +0 -178
  247. package/src/core/code-flow/scripts/codeflow/task/cf_task_merge.py +0 -635
  248. package/src/core/code-flow/scripts/codeflow/task/cf_task_plan.py +0 -251
  249. package/src/core/code-flow/scripts/codeflow/task/cf_task_runtime.py +0 -570
  250. package/src/core/code-flow/scripts/codeflow/task/cf_validation_service.py +0 -73
  251. package/src/core/code-flow/scripts/runtime-resources.json +0 -29
  252. package/src/core/code-flow/specs/backend/_map.md +0 -56
  253. package/src/core/code-flow/specs/backend/code-quality-performance.md +0 -59
  254. package/src/core/code-flow/specs/backend/database.md +0 -51
  255. package/src/core/code-flow/specs/backend/directory-structure.md +0 -54
  256. package/src/core/code-flow/specs/backend/logging.md +0 -50
  257. package/src/core/code-flow/specs/backend/platform-rules.md +0 -55
  258. package/src/core/code-flow/specs/frontend/_map.md +0 -52
  259. package/src/core/code-flow/specs/frontend/component-specs.md +0 -68
  260. package/src/core/code-flow/specs/frontend/directory-structure.md +0 -53
  261. package/src/core/code-flow/specs/frontend/quality-standards.md +0 -58
  262. package/src/core/code-flow/specs/shared/_map.md +0 -57
  263. package/src/core/code-flow/specs/shared/scenarios-template.md +0 -55
  264. package/src/core/code-flow/tasks/.gitkeep +0 -0
  265. package/src/core/code-flow/validation.yml +0 -59
  266. package/src/migrate/runtime.js +0 -213
  267. package/src/migrate/spec-workflow.js +0 -253
  268. package/src/runtime.js +0 -219
@@ -1,50 +0,0 @@
1
- {
2
- "hooks": {
3
- "PreToolUse": [
4
- {
5
- "matcher": "Edit|Write|MultiEdit",
6
- "hooks": [
7
- {
8
- "type": "command",
9
- "command": "d=\"${CLAUDE_PROJECT_DIR:-$(git rev-parse --show-toplevel 2>/dev/null || pwd)}\"; f=\"$d/.code-flow/scripts/cf_pre_tool_hook.py\"; if [ -f \"$f\" ]; then cd \"$d\" && python3 \"$f\"; fi",
10
- "timeout": 5
11
- }
12
- ]
13
- }
14
- ],
15
- "PostToolUse": [
16
- {
17
- "matcher": "Edit|Write|MultiEdit",
18
- "hooks": [
19
- {
20
- "type": "command",
21
- "command": "d=\"${CLAUDE_PROJECT_DIR:-$(git rev-parse --show-toplevel 2>/dev/null || pwd)}\"; f=\"$d/.code-flow/scripts/cf_post_hook.py\"; if [ -f \"$f\" ]; then cd \"$d\" && python3 \"$f\"; fi",
22
- "timeout": 5
23
- }
24
- ]
25
- }
26
- ],
27
- "UserPromptSubmit": [
28
- {
29
- "hooks": [
30
- {
31
- "type": "command",
32
- "command": "d=\"${CLAUDE_PROJECT_DIR:-$(git rev-parse --show-toplevel 2>/dev/null || pwd)}\"; f=\"$d/.code-flow/scripts/cf_user_prompt_hook.py\"; if [ -f \"$f\" ]; then cd \"$d\" && python3 \"$f\"; fi",
33
- "timeout": 5
34
- }
35
- ]
36
- }
37
- ],
38
- "Stop": [
39
- {
40
- "hooks": [
41
- {
42
- "type": "command",
43
- "command": "d=\"${CLAUDE_PROJECT_DIR:-$(git rev-parse --show-toplevel 2>/dev/null || pwd)}\"; f=\"$d/.code-flow/scripts/cf_stop_hook.py\"; if [ -f \"$f\" ]; then cd \"$d\" && python3 \"$f\"; fi",
44
- "timeout": 35
45
- }
46
- ]
47
- }
48
- ]
49
- }
50
- }
@@ -1,45 +0,0 @@
1
- # Project Guidelines
2
-
3
- ## Team Identity
4
- - Team: [team name]
5
- - Project: [project name]
6
- - Language: [primary language]
7
-
8
- ## Core Principles
9
- - All changes must include tests
10
- - Single responsibility per function (<= 50 lines)
11
- - No loose typing or silent exception handling
12
- - Handle errors explicitly
13
-
14
- ## Forbidden Patterns
15
- - Hard-coded secrets or credentials
16
- - Unparameterized SQL
17
- - Network calls inside tight loops
18
-
19
- <!-- code-flow:spec-loading schema=1 start -->
20
- ## Spec Workflow (schema 1)
21
-
22
- - If `.code-flow/.active-task.json` exists, validate it and `spec-context.yml`, then use only the active TASK's `Spec-Refs`, Design refs, and Acceptance Contract. Never reselect Specs from Catalog.
23
- - Without an active TASK, explicit file paths use deterministic `path_mapping` constraints; prompts without paths receive the Spec Catalog for exploration or creation of the next Context.
24
- - PRD, Design, Plan, Start, Coding, and Done inherit one persisted Context. Required rules must be applied and verified before their stage gate passes.
25
- - A corrupt marker, Context hash drift, or required scope expansion is `SPEC_WORKFLOW_BLOCKED`; run `cf-spec refresh/doctor` instead of falling back.
26
- - Tier 0 `_map.md` files are navigation only. Rule constraints live in metadata-bearing Tier 1 Specs.
27
-
28
- Do NOT ask the user which Specs to load—the Context-first router is authoritative.
29
- <!-- code-flow:spec-loading schema=1 end -->
30
-
31
- ## 合规反馈协议(quality_loop)
32
-
33
- 1. 编辑代码后收到 **Spec 合规反馈 (auto-check)** 时,先按提示修正违规,再继续当前任务
34
- 2. 用户表示某条反馈是误报("这是误报"/"忽略这个检查")时,代为执行:
35
- `code-flow feedback ignore <check-id>`
36
- (check-id 见反馈中的 `规则: <spec>#<check-id>`;同一规则误报达阈值会自动停用)
37
- 3. 会话收尾被校验拦回(cf-stop 反馈未过项)时,修复后再结束;不要绕过
38
- 4. 新增/修改规范时优先用 ✅/❌ 代码对照示例表达(见 spec 模板 Examples 段)
39
-
40
- ## Task Documents (cf-task workflow)
41
-
42
- - `.code-flow/specs/shared/` holds PRD/design templates(含前端 `design-frontend.md`)used by `cf-task-prd` and `cf-task-align`
43
- - 一个需求的 prd / design / tasks 同放需求目录 `.code-flow/tasks/<日期>/<需求>/`;全栈需求可有 `<需求>.frontend.design.md` + `<需求>.backend.design.md`,`cf-task-plan <需求目录>` 合并拆解,`cf-task-archive` 按整个需求目录归档(旧扁平布局仍兼容)
44
- - Workflow: `cf-task-prd` → `.prd.md` → `cf-task-align <.prd.md>` → `.design.md`(s) → `cf-task-plan <需求目录>` → tasks
45
- - Templates are read by the skills themselves; you do not need to pre-load them
@@ -1,3 +0,0 @@
1
- # code-flow Codex adapter
2
- [features]
3
- hooks = true
@@ -1,54 +0,0 @@
1
- {
2
- "hooks": {
3
- "PreToolUse": [
4
- {
5
- "matcher": "^apply_patch$",
6
- "hooks": [
7
- {
8
- "type": "command",
9
- "command": "d=\"$PWD\"; while [ ! -f \"$d/.code-flow/scripts/cf_codex_hook.py\" ] && [ \"$d\" != / ]; do d=\"$(dirname \"$d\")\"; done; f=\"$d/.code-flow/scripts/cf_codex_hook.py\"; if [ -f \"$f\" ]; then python3 \"$f\"; fi",
10
- "timeout": 5,
11
- "commandWindows": "py -3 -c \"import pathlib,runpy,sys; roots=(pathlib.Path.cwd(), *pathlib.Path.cwd().parents); script=next((root/'.code-flow/scripts/cf_codex_hook.py' for root in roots if (root/'.code-flow/scripts/cf_codex_hook.py').is_file()), None); sys.path.insert(0,str(script.parent)) if script else None; runpy.run_path(str(script),run_name='__main__') if script else None\""
12
- }
13
- ]
14
- }
15
- ],
16
- "PostToolUse": [
17
- {
18
- "matcher": "^apply_patch$",
19
- "hooks": [
20
- {
21
- "type": "command",
22
- "command": "d=\"$PWD\"; while [ ! -f \"$d/.code-flow/scripts/cf_codex_hook.py\" ] && [ \"$d\" != / ]; do d=\"$(dirname \"$d\")\"; done; f=\"$d/.code-flow/scripts/cf_codex_hook.py\"; if [ -f \"$f\" ]; then python3 \"$f\"; fi",
23
- "timeout": 5,
24
- "commandWindows": "py -3 -c \"import pathlib,runpy,sys; roots=(pathlib.Path.cwd(), *pathlib.Path.cwd().parents); script=next((root/'.code-flow/scripts/cf_codex_hook.py' for root in roots if (root/'.code-flow/scripts/cf_codex_hook.py').is_file()), None); sys.path.insert(0,str(script.parent)) if script else None; runpy.run_path(str(script),run_name='__main__') if script else None\""
25
- }
26
- ]
27
- }
28
- ],
29
- "UserPromptSubmit": [
30
- {
31
- "hooks": [
32
- {
33
- "type": "command",
34
- "command": "d=\"$PWD\"; while [ ! -f \"$d/.code-flow/scripts/cf_codex_hook.py\" ] && [ \"$d\" != / ]; do d=\"$(dirname \"$d\")\"; done; f=\"$d/.code-flow/scripts/cf_codex_hook.py\"; if [ -f \"$f\" ]; then python3 \"$f\"; fi",
35
- "timeout": 5,
36
- "commandWindows": "py -3 -c \"import pathlib,runpy,sys; roots=(pathlib.Path.cwd(), *pathlib.Path.cwd().parents); script=next((root/'.code-flow/scripts/cf_codex_hook.py' for root in roots if (root/'.code-flow/scripts/cf_codex_hook.py').is_file()), None); sys.path.insert(0,str(script.parent)) if script else None; runpy.run_path(str(script),run_name='__main__') if script else None\""
37
- }
38
- ]
39
- }
40
- ],
41
- "Stop": [
42
- {
43
- "hooks": [
44
- {
45
- "type": "command",
46
- "command": "d=\"$PWD\"; while [ ! -f \"$d/.code-flow/scripts/cf_codex_hook.py\" ] && [ \"$d\" != / ]; do d=\"$(dirname \"$d\")\"; done; f=\"$d/.code-flow/scripts/cf_codex_hook.py\"; if [ -f \"$f\" ]; then python3 \"$f\"; fi",
47
- "timeout": 35,
48
- "commandWindows": "py -3 -c \"import pathlib,runpy,sys; roots=(pathlib.Path.cwd(), *pathlib.Path.cwd().parents); script=next((root/'.code-flow/scripts/cf_codex_hook.py' for root in roots if (root/'.code-flow/scripts/cf_codex_hook.py').is_file()), None); sys.path.insert(0,str(script.parent)) if script else None; runpy.run_path(str(script),run_name='__main__') if script else None\""
49
- }
50
- ]
51
- }
52
- ]
53
- }
54
- }
@@ -1,273 +0,0 @@
1
- ---
2
- name: cf-init
3
- description: Initialize the code-flow spec system in a project. Use when setting up .code-flow/ directory, generating spec files, configuring Codex hooks (.codex/hooks.json), creating AGENTS.md, or bootstrapping coding standards for a new or existing project.
4
- ---
5
-
6
- # cf-init
7
-
8
- 项目规范体系一键初始化。检测技术栈,基于 `code-flow init` 已部署的核心模板完成裁剪与填充,生成可检索、可注入、可维护的 specs。
9
-
10
- ## 输入
11
-
12
- - `cf-init` — 自动检测技术栈
13
- - `cf-init frontend` — 强制前端项目
14
- - `cf-init backend` — 强制后端项目
15
- - `cf-init fullstack` — 强制全栈项目
16
- - `cf-init --skip-learn` — 跳过自动扫描,仅生成/修补模板
17
-
18
- ## 执行步骤
19
-
20
- ### 1. 检测技术栈
21
-
22
- 先用文件清单扫描项目根目录,再读取关键配置文件交叉判断。不要只因为 `package.json` 存在就判定为前端。
23
-
24
- **扫描信号**:
25
- - 前端依赖:`react`、`vue`、`@angular/core`、`svelte`、`next`、`nuxt`、`vite`、`webpack`
26
- - Node 后端依赖:`express`、`fastify`、`koa`、`@nestjs/*`、`hapi`、`prisma`、`typeorm`
27
- - Python 后端:`pyproject.toml`、`requirements.txt`、`setup.cfg`,以及 `fastapi`、`django`、`flask`、`sqlalchemy`、`pytest`、`ruff`、`mypy`
28
- - Go 后端:`go.mod`、`cmd/`、`internal/`、`pkg/`
29
- - Rust/Java 后端:`Cargo.toml`、`pom.xml`、`build.gradle`
30
- - 前端目录:`src/components`、`src/pages`、`src/hooks`、`app/`、`pages/`、`components/`、`styles/`
31
- - 后端目录:`api/`、`services/`、`handlers/`、`controllers/`、`models/`、`migrations/`、`routes/`
32
- - Monorepo:`apps/`、`packages/`、`frontend/`、`backend/`、`client/`、`server/`
33
-
34
- **判定规则**:
35
- - 用户指定 `frontend|backend|fullstack` 时,以用户参数为准,但仍记录检测到的框架和语言。
36
- - 同时命中明确前端和后端信号 → `fullstack`。
37
- - 只有前端框架/目录信号 → `frontend`。
38
- - 只有后端框架/目录信号 → `backend`。
39
- - 只有 `package.json` 且命中 Node 后端依赖 → `backend`;只有 `package.json` 但无框架信号 → `generic`,不要强行写前端规范。
40
- - 无明确技术栈 → `generic`,生成 frontend + backend 基础模板,但在摘要中标注“需人工确认”。
41
-
42
- ### 2. 校准 .code-flow/config.yml
43
-
44
- `code-flow init` 已从 `src/core/code-flow/config.yml` 复制当前核心模板。cf-init 不要复制或手写旧版 YAML;应该读取现有 `.code-flow/config.yml`,只做保守修补。
45
-
46
- 必须保持或补齐这些核心能力:
47
- - `spec_workflow.schema_version: 1`
48
- - `spec_workflow.catalog.dedup_window: 5`
49
- - `quality_loop.compress: true`
50
- - 完整 `skip_extensions`,包括图片、压缩包、PDF 等非代码文件
51
- - `skip_paths` 中的平台目录:`.claude/**`、`.codex/**`、`.costrict/**`、`.opencode/**`
52
- - `path_mapping.shared`,包括 `shared/_map.md`、`shared/prd-template.md`、`shared/design/design-lite.md`、`shared/design/design-full.md`、`shared/design/design-frontend.md`
53
- - backend patterns 中同时包含 `*.py` 与 `**/*.py`
54
- - 按检测到的前端框架动态补 `frontend.patterns`:Vue→`**/*.vue`、Svelte→`**/*.svelte`、Next→`app/**` 等(保守追加,按检测结果,不预塞所有框架)
55
-
56
- 根据技术栈只裁剪 `frontend` / `backend` 域:
57
- - `frontend`:保留 `shared` + `frontend`,删除 `backend`
58
- - `backend`:保留 `shared` + `backend`,删除 `frontend`
59
- - `fullstack` / `generic`:保留 `shared` + `frontend` + `backend`
60
- - 用户已有自定义域(如 `infra`、`mobile`、`cli`、`scripts`)必须保留,不得删除
61
-
62
- 如果发现 `.code-flow/config.yml` 缺失,提示用户先运行 `code-flow init --platform=<platform>`,不要手工拼装整份 YAML。
63
-
64
- ### 3. 裁剪 .code-flow/validation.yml
65
-
66
- `code-flow init` 已复制默认 `.code-flow/validation.yml`。读取并按技术栈删除不相关 validator,保持 YAML 结构和已有用户修改。
67
-
68
- - 纯前端项目:删除 `Python 类型检查`、`Pytest`
69
- - Python 后端项目:删除 `TypeScript 类型检查`、`Vue 类型检查`、`ESLint`、`Stylelint`、`前端单元测试`
70
- - Go/Rust/Java 后端:删除前端 validator;如果没有对应语言 validator,保留文件并在摘要中提示用户补充
71
- - fullstack / generic:全部保留,除非项目明确没有对应语言文件
72
- - 全量测试 / e2e 等慢命令(`pytest`、`vitest run`、Playwright 等)标 `heavy: true`:Stop 每轮跳过,任务 finish 自动执行一次,也可 `cf-validate` 手动执行
73
-
74
- 若 `.code-flow/validation.yml` 缺失,提示用户重跑 `code-flow init`,不要手工拼装 YAML。
75
-
76
- ### 4. 生成 spec 文件
77
-
78
- 严格按步骤 1 的 stack 生成,禁止超出范围:
79
-
80
- | stack | 生成目录 | 禁止生成 |
81
- |-------|---------|---------|
82
- | `frontend` | `specs/frontend/` + `specs/shared/` | `specs/backend/` |
83
- | `backend` | `specs/backend/` + `specs/shared/` | `specs/frontend/` |
84
- | `fullstack` / `generic` | `specs/frontend/` + `specs/backend/` + `specs/shared/` | — |
85
-
86
- shared 模板必须存在:
87
- - `.code-flow/specs/shared/_map.md`
88
- - `.code-flow/specs/shared/prd-template.md`
89
- - `.code-flow/specs/shared/design/design-lite.md`
90
- - `.code-flow/specs/shared/design/design-full.md`
91
- - `.code-flow/specs/shared/design/design-frontend.md`
92
-
93
- 约束规范格式:
94
-
95
- ```markdown
96
- # [规范名称]
97
-
98
- ## Rules
99
- - 规则1
100
-
101
- ## Patterns
102
- - 推荐模式
103
-
104
- ## Anti-Patterns
105
- - 禁止模式
106
- ```
107
-
108
- 导航地图(`_map.md`)格式:
109
-
110
- ```markdown
111
- # [Domain] Retrieval Map
112
-
113
- > AI 导航地图:帮助快速定位代码结构和关键模块。
114
-
115
- ## Purpose
116
- [项目角色描述]
117
-
118
- ## Architecture
119
- [技术栈和架构模式]
120
-
121
- ## Key Files
122
- | File | Purpose |
123
- |------|---------|
124
-
125
- ## Module Map
126
- [目录树形图]
127
-
128
- ## Data Flow
129
- [数据流向]
130
-
131
- ## Navigation Guide
132
- [做 X 去哪里的快速指引]
133
- ```
134
-
135
- 前端域文件:
136
- - `.code-flow/specs/frontend/_map.md`
137
- - `.code-flow/specs/frontend/directory-structure.md`
138
- - `.code-flow/specs/frontend/quality-standards.md`
139
- - `.code-flow/specs/frontend/component-specs.md`
140
-
141
- 后端域文件:
142
- - `.code-flow/specs/backend/_map.md`
143
- - `.code-flow/specs/backend/directory-structure.md`
144
- - `.code-flow/specs/backend/logging.md`
145
- - `.code-flow/specs/backend/database.md`
146
- - `.code-flow/specs/backend/platform-rules.md`
147
- - `.code-flow/specs/backend/code-quality-performance.md`
148
-
149
- 已存在的 spec 文件不覆盖;只补缺失文件。填充已有空模板时要先展示 diff。
150
-
151
- ### 5. 校准 AGENTS.md
152
-
153
- AGENTS.md 的完整内容由适配器模板统一定义,`code-flow init` 已部署到项目根;cf-init 不再内嵌副本,避免双份维护导致不一致。
154
-
155
- - 读取现有 AGENTS.md,根据检测到的技术栈填充 `## Team Identity` 占位符(team / project / language)。
156
- - 若用户已自定义,只补充缺失的 `##` 段落,不覆盖已有内容;写入前展示 diff 供确认。
157
- - 若 AGENTS.md 缺失,提示用户先运行 `code-flow init --platform=codex`,不要手工拼装完整模板。
158
-
159
- ### 6. 生成 .codex/hooks.json 和 .codex/config.toml
160
-
161
- 安装 Hook 和配置必须执行 `code-flow init --platform=codex`,由适配器模板统一生成/合并,保留用户配置。`PreToolUse`、`PostToolUse`、`UserPromptSubmit`、`Stop` 四个事件调用 `cf_codex_hook.py`,配置启用 `[features] hooks = true`,保留用户模型、sandbox、approval 设置,不得整文件覆盖;写文件 matcher 为 `^apply_patch$`,输入来自 `tool_input.command`、`cwd`、`session_id`。不得手工拼装或修改受管理 Hook。
162
-
163
- 旧安装或清单校验失败时执行 `code-flow migrate --runtime --dry-run` 查看范围,再执行 `code-flow migrate --runtime --apply` 更新全部已安装平台。
164
-
165
- Codex 会要求 review/trust 非 managed command hooks。生成或更新 hook 后,提醒用户在 Codex CLI 中运行 `/hooks` 并信任 code-flow hooks。
166
-
167
- ### 7. 安装 pyyaml
168
-
169
- 先探测依赖,不要直接安装:
170
-
171
- ```bash
172
- python3 -c "import yaml"
173
- ```
174
-
175
- 如果探测失败,再按顺序尝试:
176
-
177
- ```bash
178
- python3 -m pip install --user pyyaml
179
- python3 -m pip install pyyaml
180
- python3 -m pip install --user --break-system-packages pyyaml
181
- ```
182
-
183
- 全部失败时只输出 warning 和手动安装建议,不阻塞 cf-init 主流程。
184
-
185
- ### 8. 自动扫描项目规范(Auto-learn)
186
-
187
- 如果传入 `--skip-learn`,跳过此步骤。否则自动执行扫描,但必须遵守“证据优先”:只写入能从配置、代码、CI、测试或目录结构中找到依据的规范;不确定的内容写入 TODO 或留空,禁止编造项目规范。
188
-
189
- #### 8.1 扫描输入
190
-
191
- 读取以下配置文件(存在才使用):
192
-
193
- **前端配置**:
194
- - `.eslintrc*` / `eslint.config.*` — lint 规则
195
- - `tsconfig.json` — strict 模式、path alias、target
196
- - `.prettierrc*` / `prettier.config.*` — 格式化规则
197
- - `tailwind.config.*` — 自定义 theme
198
- - `next.config.*` / `nuxt.config.*` / `vite.config.*` — 框架约束
199
- - `jest.config.*` / `vitest.config.*` — 测试配置
200
-
201
- **后端配置**:
202
- - `pyproject.toml` — ruff/mypy/pytest 配置、Python 版本
203
- - `.golangci.yml` — Go lint 规则
204
- - `Makefile` — 构建和测试命令
205
- - `Dockerfile` / `docker-compose.yml` — 运行时约束
206
-
207
- **通用配置**:
208
- - `.github/workflows/*.yml` / `.gitlab-ci.yml` — CI 检查步骤
209
- - `.editorconfig` — 编辑器配置
210
- - `package.json` scripts — 常用命令
211
- - `README*` — 项目用途和运行方式
212
-
213
- 扫描代码结构和模式:
214
- - 目录结构、入口文件、路由、handler/service/model 调用链 → 写入 `_map.md`
215
- - 错误处理、日志、测试、导入、命名模式 → 写入对应约束 specs
216
- - 纯格式化规则(formatter 自动处理)默认不写入 Rules,除非项目明确要求人工遵守
217
-
218
- #### 8.2 写入策略
219
-
220
- 先展示扫描摘要和拟写入内容,等待用户确认。用户确认 `all` 后再写入;用户输入 `skip` 时保留模板不填充。
221
-
222
- 写入规则:
223
- - `_map.md`:Purpose、Architecture、Key Files、Module Map、Data Flow、Navigation Guide 必须来自实际文件或配置
224
- - `Rules`:只放强制约束,如 strict mode、CI 必跑命令、禁止模式
225
- - `Patterns`:只放代码中重复出现的成熟模式,并标注来源
226
- - `Anti-Patterns`:只放配置或代码审查中明确禁止的做法
227
- - 每条自动提取内容建议带来源,如 `[tsconfig.json] strict=true`、`[CI] npm test`
228
- - 去重:不要重复模板已有规则;不要把同一规则写入多个 spec,除非它确实跨域
229
-
230
- 展示格式:
231
-
232
- ```text
233
- 项目规范扫描完成:
234
-
235
- 导航地图 (Retrieval Map):
236
- frontend/_map.md:
237
- Purpose: ...
238
- Architecture: ...
239
- Key Files: ...
240
-
241
- 编码约束 (从配置和代码中提取):
242
- frontend/quality-standards.md:
243
- 1. [tsconfig.json] strict 模式已启用
244
- backend/code-quality-performance.md:
245
- 2. [pyproject.toml] pytest 配置存在
246
-
247
- 确认写入?(all 全部写入 / 输入编号选择 / skip 跳过):
248
- ```
249
-
250
- ### 9. 输出摘要
251
-
252
- ```text
253
- cf-init 完成
254
-
255
- 技术栈: <检测结果>
256
- 文件结构:
257
- Created: ...
258
- Updated: ...
259
- Skipped: ...
260
- Token 估算: ...
261
-
262
- 下一步:
263
- - 审阅并补充 spec 文件中的 TODO
264
- - 运行 cf-learn 补充更多规范
265
- - 运行 cf-learn --map 更新导航地图
266
- - 开始开发: cf-task-plan <设计文档>
267
- ```
268
-
269
- ## v0.5 质量闭环部署说明
270
-
271
- init/upgrade 后新增:PostToolUse / Stop hook 注册(合规反馈与收尾守门)、`.code-flow/.gitignore`(运行时数据不入库)。运行时数据 `.session-log.jsonl` / `.check-state.json` 首次使用自动创建,仅存本地。规范写作建议:frontmatter 加 `description`(Spec Catalog 行)与 `checks`(机检标注),规则优先用 ✅/❌ Examples 段表达(cf-learn 候选自动生成草稿)。
272
-
273
- 安装产物由 `code-flow init --platform=codex` 统一部署。脚本、Skill、Hook 的完整性由安装清单校验;损坏时执行 `code-flow migrate --runtime --dry-run` 查看修复范围,再执行 `code-flow migrate --runtime --apply`。不得凭技能名猜 Python 脚本入口。