cc-devflow 2.4.6 → 4.1.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/.claude/CLAUDE.md +1065 -48
- package/.claude/agents/dev-implementer.md +195 -0
- package/.claude/commands/{flow-archive.md → flow/archive.md} +46 -11
- package/.claude/commands/flow/context.md +150 -0
- package/.claude/commands/flow/delta.md +245 -0
- package/.claude/commands/{flow-dev.md → flow/dev.md} +112 -11
- package/.claude/commands/flow/init.md +45 -0
- package/.claude/commands/flow/quality.md +159 -0
- package/.claude/commands/flow/spec.md +186 -0
- package/.claude/commands/flow/workspace.md +146 -0
- package/.claude/commands/{cancel-ralph.md → util/cancel-ralph.md} +1 -0
- package/.claude/config/quality-gates.yml +305 -0
- package/.claude/docs/guides/TEAM_MODE_GUIDE.md +313 -0
- package/.claude/docs/templates/DELTA_SPEC_TEMPLATE.md +91 -0
- package/.claude/docs/templates/DESIGN_DECISIONS_TEMPLATE.md +151 -0
- package/.claude/docs/templates/JOURNAL_TEMPLATE.md +75 -0
- package/.claude/docs/templates/_shared/CLAUDE.md +36 -0
- package/.claude/docs/templates/_shared/CONSTITUTION_CHECK.md +125 -0
- package/.claude/docs/templates/_shared/VALIDATION_CHECKLIST.md +187 -0
- package/.claude/docs/templates/_shared/YAML_FRONTMATTER.md +164 -0
- package/.claude/docs/templates/context/dev.jsonl.template +6 -0
- package/.claude/docs/templates/context/epic.jsonl.template +5 -0
- package/.claude/docs/templates/context/prd.jsonl.template +4 -0
- package/.claude/docs/templates/context/research.jsonl.template +4 -0
- package/.claude/docs/templates/context/review.jsonl.template +5 -0
- package/.claude/docs/templates/context/tech.jsonl.template +5 -0
- package/.claude/hooks/CLAUDE.md +342 -0
- package/.claude/hooks/inject-agent-context.ts +480 -0
- package/.claude/hooks/inject-skill-context.ts +359 -0
- package/.claude/hooks/ralph-loop.ts +931 -0
- package/.claude/hooks/task-completed-hook.ts +593 -0
- package/.claude/hooks/teammate-idle-hook.ts +690 -0
- package/.claude/hooks/types/team-types.d.ts +238 -0
- package/.claude/rules/devflow-conventions.md +82 -9
- package/.claude/scripts/archive-requirement.sh +44 -1
- package/.claude/scripts/common.sh +670 -3
- package/.claude/scripts/delta-parser.ts +527 -0
- package/.claude/scripts/detect-file-conflicts.sh +151 -0
- package/.claude/scripts/flow-context-add.sh +134 -0
- package/.claude/scripts/flow-context-init.sh +133 -0
- package/.claude/scripts/flow-context-validate.sh +144 -0
- package/.claude/scripts/flow-delta-apply.sh +297 -0
- package/.claude/scripts/flow-delta-archive.sh +71 -0
- package/.claude/scripts/flow-delta-create.sh +202 -0
- package/.claude/scripts/flow-delta-list.sh +142 -0
- package/.claude/scripts/flow-delta-status.sh +235 -0
- package/.claude/scripts/flow-quality-full.sh +184 -0
- package/.claude/scripts/flow-quality-quick.sh +64 -0
- package/.claude/scripts/flow-workspace-init.sh +117 -0
- package/.claude/scripts/flow-workspace-record.sh +164 -0
- package/.claude/scripts/flow-workspace-start.sh +88 -0
- package/.claude/scripts/get-workflow-status.sh +415 -0
- package/.claude/scripts/parse-task-dependencies.js +334 -0
- package/.claude/scripts/record-quality-error.sh +165 -0
- package/.claude/scripts/run-quality-gates.sh +242 -0
- package/.claude/scripts/team-dev-init.sh +319 -0
- package/.claude/scripts/team-state-recovery.sh +229 -0
- package/.claude/scripts/workflow-status.ts +433 -0
- package/.claude/settings.json +19 -0
- package/.claude/skills/cc-devflow-orchestrator/SKILL.md +85 -200
- package/.claude/skills/domain/using-git-worktrees/SKILL.md +252 -0
- package/.claude/skills/domain/using-git-worktrees/assets/SHELL_ALIASES.md +133 -0
- package/.claude/skills/domain/using-git-worktrees/context.jsonl +4 -0
- package/.claude/skills/domain/using-git-worktrees/scripts/worktree-cleanup.sh +218 -0
- package/.claude/skills/domain/using-git-worktrees/scripts/worktree-create.sh +232 -0
- package/.claude/skills/domain/using-git-worktrees/scripts/worktree-list.sh +130 -0
- package/.claude/skills/domain/using-git-worktrees/scripts/worktree-status.sh +140 -0
- package/.claude/skills/domain/using-git-worktrees/scripts/worktree-switch.sh +70 -0
- package/.claude/skills/skill-rules.json +72 -1
- package/.claude/skills/utility/journey-checker/SKILL.md +199 -0
- package/.claude/skills/utility/journey-checker/pressure-scenarios.md +164 -0
- package/.claude/skills/utility/skill-creator/LICENSE.txt +202 -0
- package/.claude/skills/utility/skill-creator/SKILL.md +356 -0
- package/.claude/skills/utility/skill-creator/references/output-patterns.md +82 -0
- package/.claude/skills/utility/skill-creator/references/workflows.md +28 -0
- package/.claude/skills/utility/skill-creator/scripts/init_skill.py +303 -0
- package/.claude/skills/utility/skill-creator/scripts/package_skill.py +110 -0
- package/.claude/skills/utility/skill-creator/scripts/quick_validate.py +95 -0
- package/.claude/skills/workflow/flow-dev/CLAUDE.md +78 -0
- package/.claude/skills/workflow/flow-dev/SKILL.md +96 -0
- package/.claude/skills/workflow/flow-dev/assets/IMPLEMENTATION_PLAN_TEMPLATE.md +71 -0
- package/.claude/skills/workflow/flow-dev/context.jsonl +8 -0
- package/.claude/skills/workflow/flow-dev/dev-implementer.jsonl +8 -0
- package/.claude/skills/workflow/flow-dev/scripts/entry-gate.sh +116 -0
- package/.claude/skills/workflow/flow-dev/scripts/exit-gate.sh +101 -0
- package/.claude/skills/workflow/flow-dev/scripts/task-orchestrator.sh +106 -0
- package/.claude/skills/workflow/flow-fix/SKILL.md +105 -0
- package/.claude/skills/workflow/flow-fix/context.jsonl +6 -0
- package/.claude/skills/workflow/flow-fix/references/bug-analyzer.md +381 -0
- package/.claude/skills/workflow/flow-init/SKILL.md +211 -0
- package/.claude/skills/workflow/flow-init/assets/BRAINSTORM_TEMPLATE.md +148 -0
- package/.claude/skills/workflow/flow-init/assets/INIT_FLOW_TEMPLATE.md +198 -0
- package/.claude/skills/workflow/flow-init/assets/RESEARCH_TEMPLATE.md +276 -0
- package/.claude/skills/workflow/flow-init/context.jsonl +5 -0
- package/.claude/skills/workflow/flow-init/references/flow-researcher.md +132 -0
- package/.claude/skills/workflow/flow-init/scripts/check-prerequisites.sh +232 -0
- package/.claude/skills/workflow/flow-init/scripts/consolidate-research.sh +182 -0
- package/.claude/skills/workflow/flow-init/scripts/create-requirement.sh +515 -0
- package/.claude/skills/workflow/flow-init/scripts/generate-research-tasks.sh +157 -0
- package/.claude/skills/workflow/flow-init/scripts/populate-research-tasks.sh +284 -0
- package/.claude/skills/workflow/flow-init/scripts/validate-research.sh +332 -0
- package/.claude/skills/workflow/flow-quality/SKILL.md +94 -0
- package/.claude/skills/workflow/flow-quality/context.jsonl +6 -0
- package/.claude/skills/workflow/flow-quality/references/code-quality-reviewer.md +205 -0
- package/.claude/skills/workflow/flow-quality/references/qa-tester.md +313 -0
- package/.claude/skills/workflow/flow-quality/references/security-reviewer.md +314 -0
- package/.claude/skills/workflow/flow-quality/references/spec-reviewer.md +221 -0
- package/.claude/skills/workflow/flow-release/SKILL.md +126 -0
- package/.claude/skills/workflow/flow-release/context.jsonl +7 -0
- package/.claude/skills/workflow/flow-release/references/release-manager.md +295 -0
- package/.claude/skills/workflow/flow-spec/CLAUDE.md +103 -0
- package/.claude/skills/workflow/flow-spec/SKILL.md +545 -0
- package/.claude/skills/workflow/flow-spec/context.jsonl +7 -0
- package/.claude/skills/workflow/flow-spec/scripts/entry-gate.sh +194 -0
- package/.claude/skills/workflow/flow-spec/scripts/exit-gate.sh +244 -0
- package/.claude/skills/workflow/flow-spec/scripts/parallel-orchestrator.sh +205 -0
- package/.claude/skills/workflow/flow-spec/scripts/team-communication.sh +353 -0
- package/.claude/skills/workflow/flow-spec/scripts/team-init.sh +195 -0
- package/.claude/skills/workflow/flow-spec/scripts/test-team-mode.sh +496 -0
- package/.claude/skills/workflow/flow-spec/team-config.json +165 -0
- package/.claude/skills/workflow.yaml +417 -0
- package/CHANGELOG.md +254 -0
- package/README.md +193 -33
- package/README.zh-CN.md +206 -46
- package/lib/compiler/CLAUDE.md +77 -46
- package/lib/compiler/__tests__/multi-module-emitters.test.js +508 -0
- package/lib/compiler/context-expander.js +179 -0
- package/lib/compiler/emitters/antigravity-emitter.js +195 -5
- package/lib/compiler/emitters/base-emitter.js +217 -2
- package/lib/compiler/emitters/codex-emitter.js +200 -4
- package/lib/compiler/emitters/cursor-emitter.js +307 -3
- package/lib/compiler/emitters/qwen-emitter.js +196 -4
- package/lib/compiler/index.js +197 -2
- package/lib/compiler/platforms.js +270 -21
- package/package.json +1 -1
- package/.claude/commands/flow-epic.md +0 -183
- package/.claude/commands/flow-init.md +0 -370
- package/.claude/commands/flow-prd.md +0 -144
- package/.claude/commands/flow-qa.md +0 -93
- package/.claude/commands/flow-review.md +0 -257
- package/.claude/commands/flow-tech.md +0 -142
- package/.claude/commands/flow-ui.md +0 -189
- package/.claude/skills/file-header-guardian/SKILL.md +0 -56
- package/.claude/skills/skill-developer/ADVANCED.md +0 -197
- package/.claude/skills/skill-developer/HOOK_MECHANISMS.md +0 -306
- package/.claude/skills/skill-developer/PATTERNS_LIBRARY.md +0 -152
- package/.claude/skills/skill-developer/SKILL.md +0 -426
- package/.claude/skills/skill-developer/SKILL_RULES_REFERENCE.md +0 -315
- package/.claude/skills/skill-developer/TRIGGER_TYPES.md +0 -305
- package/.claude/skills/skill-developer/TROUBLESHOOTING.md +0 -514
- package/.claude/skills/writing-skills/SKILL.md +0 -655
- package/.claude/skills/writing-skills/anthropic-best-practices.md +0 -1150
- package/.claude/skills/writing-skills/examples/CLAUDE_MD_TESTING.md +0 -189
- package/.claude/skills/writing-skills/graphviz-conventions.dot +0 -172
- package/.claude/skills/writing-skills/persuasion-principles.md +0 -187
- package/.claude/skills/writing-skills/render-graphs.js +0 -168
- package/.claude/skills/writing-skills/testing-skills-with-subagents.md +0 -384
- package/.claude/tsc-cache/795ba6e3-b98a-423b-bab2-51aa62812569/affected-repos.txt +0 -1
- package/.claude/tsc-cache/ae335694-be5a-4ba4-a1a0-b676c09a7906/affected-repos.txt +0 -1
- /package/.claude/commands/{core-architecture.md → core/architecture.md} +0 -0
- /package/.claude/commands/{core-guidelines.md → core/guidelines.md} +0 -0
- /package/.claude/commands/{core-roadmap.md → core/roadmap.md} +0 -0
- /package/.claude/commands/{core-style.md → core/style.md} +0 -0
- /package/.claude/commands/{flow-checklist.md → flow/checklist.md} +0 -0
- /package/.claude/commands/{flow-clarify.md → flow/clarify.md} +0 -0
- /package/.claude/commands/{flow-constitution.md → flow/constitution.md} +0 -0
- /package/.claude/commands/{flow-fix.md → flow/fix.md} +0 -0
- /package/.claude/commands/{flow-ideate.md → flow/ideate.md} +0 -0
- /package/.claude/commands/{flow-new.md → flow/new.md} +0 -0
- /package/.claude/commands/{flow-release.md → flow/release.md} +0 -0
- /package/.claude/commands/{flow-restart.md → flow/restart.md} +0 -0
- /package/.claude/commands/{flow-status.md → flow/status.md} +0 -0
- /package/.claude/commands/{flow-update.md → flow/update.md} +0 -0
- /package/.claude/commands/{flow-upgrade.md → flow/upgrade.md} +0 -0
- /package/.claude/commands/{flow-verify.md → flow/verify.md} +0 -0
- /package/.claude/commands/{code-review-high.md → util/code-review.md} +0 -0
- /package/.claude/commands/{git-commit.md → util/git-commit.md} +0 -0
- /package/.claude/commands/{problem-analyzer.md → util/problem-analyzer.md} +0 -0
- /package/.claude/skills/{flow-attention-refresh → domain/attention-refresh}/SKILL.md +0 -0
- /package/.claude/skills/{flow-brainstorming → domain/brainstorming}/SKILL.md +0 -0
- /package/.claude/skills/{flow-debugging → domain/debugging}/SKILL.md +0 -0
- /package/.claude/skills/{flow-finishing-branch → domain/finishing-branch}/SKILL.md +0 -0
- /package/.claude/skills/{flow-receiving-review → domain/receiving-review}/SKILL.md +0 -0
- /package/.claude/skills/{flow-tdd → domain/tdd}/SKILL.md +0 -0
- /package/.claude/skills/{verification-before-completion → domain/verification}/SKILL.md +0 -0
- /package/.claude/skills/{constitution-guardian → guardrail/constitution-guardian}/SKILL.md +0 -0
- /package/.claude/skills/{devflow-tdd-enforcer → guardrail/tdd-enforcer}/SKILL.md +0 -0
- /package/.claude/skills/{devflow-constitution-quick-ref → utility/constitution-quick-ref}/SKILL.md +0 -0
- /package/.claude/skills/{devflow-file-standards → utility/file-standards}/SKILL.md +0 -0
- /package/.claude/skills/{fractal-docs-generator → utility/fractal-docs}/SKILL.md +0 -0
- /package/.claude/skills/{npm-release → utility/npm-release}/SKILL.md +0 -0
|
@@ -1,257 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: flow-review
|
|
3
|
-
description: 'Two-Stage Code Review. Usage: /flow-review "REQ-123" or /flow-review'
|
|
4
|
-
agents:
|
|
5
|
-
spec: .claude/agents/spec-reviewer.md
|
|
6
|
-
quality: .claude/agents/code-reviewer.md
|
|
7
|
-
skills:
|
|
8
|
-
verification: .claude/skills/verification-before-completion/SKILL.md
|
|
9
|
-
receiving: .claude/skills/flow-receiving-review/SKILL.md
|
|
10
|
-
---
|
|
11
|
-
|
|
12
|
-
# Flow-Review - 两阶段代码审查
|
|
13
|
-
|
|
14
|
-
## User Input
|
|
15
|
-
|
|
16
|
-
```text
|
|
17
|
-
$ARGUMENTS = "REQ_ID" 或 空 (自动检测当前分支)
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
**示例**:
|
|
21
|
-
```
|
|
22
|
-
/flow-review "REQ-123"
|
|
23
|
-
/flow-review # 自动从分支名提取 REQ-ID
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
---
|
|
27
|
-
|
|
28
|
-
## 核心理念
|
|
29
|
-
|
|
30
|
-
### Two-Stage Review
|
|
31
|
-
|
|
32
|
-
```
|
|
33
|
-
Stage 1: SPEC COMPLIANCE (先)
|
|
34
|
-
┌─────────────────────────────────────────┐
|
|
35
|
-
│ • 加载 PRD, EPIC, TASKS, BRAINSTORM │
|
|
36
|
-
│ • 创建需求清单 │
|
|
37
|
-
│ • 逐项验证(不信任实现者报告) │
|
|
38
|
-
│ • 检查超范围(scope creep) │
|
|
39
|
-
│ • 输出: SPEC_REVIEW.md │
|
|
40
|
-
└─────────────────────────────────────────┘
|
|
41
|
-
↓ Pass?
|
|
42
|
-
Stage 2: CODE QUALITY (后)
|
|
43
|
-
┌─────────────────────────────────────────┐
|
|
44
|
-
│ • 代码清晰度、结构、命名 │
|
|
45
|
-
│ • 测试质量和覆盖率 │
|
|
46
|
-
│ • Constitution 合规 │
|
|
47
|
-
│ • 性能和安全 │
|
|
48
|
-
│ • 输出: CODE_QUALITY_REVIEW.md │
|
|
49
|
-
└─────────────────────────────────────────┘
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
**关键**: Stage 2 只在 Stage 1 通过后执行。
|
|
53
|
-
|
|
54
|
-
---
|
|
55
|
-
|
|
56
|
-
## 执行流程
|
|
57
|
-
|
|
58
|
-
### Stage 0: Entry Gate
|
|
59
|
-
|
|
60
|
-
```yaml
|
|
61
|
-
1. 解析 REQ_ID
|
|
62
|
-
→ 从参数获取,或从分支名提取 (feature/REQ-123-xxx)
|
|
63
|
-
|
|
64
|
-
2. 验证需求目录存在
|
|
65
|
-
→ devflow/requirements/${REQ_ID}/
|
|
66
|
-
|
|
67
|
-
3. 加载必需文档
|
|
68
|
-
→ PRD.md, EPIC.md, TASKS.md, BRAINSTORM.md
|
|
69
|
-
|
|
70
|
-
4. 检查实现状态
|
|
71
|
-
→ TASKS.md 中所有任务标记为完成
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
---
|
|
75
|
-
|
|
76
|
-
### Stage 1: Spec Compliance Review
|
|
77
|
-
|
|
78
|
-
**调用**: `{AGENT:spec}` (spec-reviewer)
|
|
79
|
-
|
|
80
|
-
```yaml
|
|
81
|
-
执行:
|
|
82
|
-
1. 构建需求清单
|
|
83
|
-
→ 从 PRD 提取验收标准
|
|
84
|
-
→ 从 TASKS 提取预期结果
|
|
85
|
-
|
|
86
|
-
2. 代码验证 (不信任报告)
|
|
87
|
-
→ 读取实际代码
|
|
88
|
-
→ 逐项验证实现
|
|
89
|
-
→ 标记: ✅ 实现 | ❌ 缺失 | ⚠️ 部分 | 🚫 超范围
|
|
90
|
-
|
|
91
|
-
3. Scope Creep 检测
|
|
92
|
-
→ 扫描未在规格中的功能
|
|
93
|
-
→ 每个额外功能 = 缺陷
|
|
94
|
-
|
|
95
|
-
4. BRAINSTORM 对齐检查
|
|
96
|
-
→ 是否解决原始问题
|
|
97
|
-
→ 是否遵循选定方案
|
|
98
|
-
|
|
99
|
-
输出: devflow/requirements/${REQ_ID}/SPEC_REVIEW.md
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
**通过条件**:
|
|
103
|
-
- 所有需求项标记为 ✅
|
|
104
|
-
- 无 Scope Creep (🚫)
|
|
105
|
-
- BRAINSTORM 对齐
|
|
106
|
-
|
|
107
|
-
**失败处理**:
|
|
108
|
-
```yaml
|
|
109
|
-
如果 Stage 1 失败:
|
|
110
|
-
→ 输出 SPEC_REVIEW.md 包含失败项
|
|
111
|
-
→ 列出必需修复项
|
|
112
|
-
→ 停止,不进入 Stage 2
|
|
113
|
-
→ 返回给开发者修复
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
---
|
|
117
|
-
|
|
118
|
-
### Stage 2: Code Quality Review
|
|
119
|
-
|
|
120
|
-
**前置**: Stage 1 必须通过
|
|
121
|
-
|
|
122
|
-
**调用**: `{AGENT:quality}` (code-reviewer)
|
|
123
|
-
|
|
124
|
-
```yaml
|
|
125
|
-
执行:
|
|
126
|
-
1. 代码清晰度
|
|
127
|
-
→ 命名是否清晰
|
|
128
|
-
→ 结构是否合理
|
|
129
|
-
→ 注释是否必要且有用
|
|
130
|
-
|
|
131
|
-
2. 测试质量
|
|
132
|
-
→ 覆盖率 ≥ 80%
|
|
133
|
-
→ 测试是否有意义 (非 cheater tests)
|
|
134
|
-
→ 边界情况是否覆盖
|
|
135
|
-
|
|
136
|
-
3. Constitution 合规
|
|
137
|
-
→ Article I: 完整实现
|
|
138
|
-
→ Article II: 无重复代码
|
|
139
|
-
→ Article III: 无硬编码密钥
|
|
140
|
-
→ Article IV: 无资源泄漏
|
|
141
|
-
→ Article V: 无死代码
|
|
142
|
-
→ Article VI: TDD 顺序
|
|
143
|
-
|
|
144
|
-
4. 性能和安全
|
|
145
|
-
→ 无明显性能问题
|
|
146
|
-
→ 无安全漏洞
|
|
147
|
-
|
|
148
|
-
输出: devflow/requirements/${REQ_ID}/CODE_QUALITY_REVIEW.md
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
---
|
|
152
|
-
|
|
153
|
-
### Stage 3: Exit Gate
|
|
154
|
-
|
|
155
|
-
```yaml
|
|
156
|
-
验证:
|
|
157
|
-
1. SPEC_REVIEW.md 状态 = PASS
|
|
158
|
-
2. CODE_QUALITY_REVIEW.md 状态 = PASS
|
|
159
|
-
3. 所有阻塞问题已解决
|
|
160
|
-
|
|
161
|
-
输出:
|
|
162
|
-
→ 更新 orchestration_status.json
|
|
163
|
-
→ 记录到 EXECUTION_LOG.md
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
---
|
|
167
|
-
|
|
168
|
-
## 输出产物
|
|
169
|
-
|
|
170
|
-
```
|
|
171
|
-
devflow/requirements/${REQ_ID}/
|
|
172
|
-
├── SPEC_REVIEW.md # Stage 1 输出
|
|
173
|
-
├── CODE_QUALITY_REVIEW.md # Stage 2 输出
|
|
174
|
-
└── EXECUTION_LOG.md # 更新
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
---
|
|
178
|
-
|
|
179
|
-
## 收到审查反馈后
|
|
180
|
-
|
|
181
|
-
当收到审查反馈时,使用 `{SKILL:receiving}` 原则:
|
|
182
|
-
|
|
183
|
-
```yaml
|
|
184
|
-
处理反馈:
|
|
185
|
-
1. 不盲目同意
|
|
186
|
-
→ 反馈可能有误
|
|
187
|
-
→ 技术上可疑?先验证
|
|
188
|
-
|
|
189
|
-
2. 不清楚?提问澄清
|
|
190
|
-
→ "这个建议的具体原因是什么?"
|
|
191
|
-
→ "能否提供示例?"
|
|
192
|
-
|
|
193
|
-
3. 验证后再实现
|
|
194
|
-
→ 确认建议正确
|
|
195
|
-
→ 然后实施修改
|
|
196
|
-
```
|
|
197
|
-
|
|
198
|
-
---
|
|
199
|
-
|
|
200
|
-
## Rationalization Prevention
|
|
201
|
-
|
|
202
|
-
| Excuse | Reality |
|
|
203
|
-
|--------|---------|
|
|
204
|
-
| "实现者说完成了" | 读代码验证。不信任报告。 |
|
|
205
|
-
| "测试通过了" | 测试可能不覆盖所有需求。 |
|
|
206
|
-
| "差不多就行" | 差不多 ≠ 正确。规格是契约。 |
|
|
207
|
-
| "额外功能是好事" | 额外 = scope creep = 缺陷。 |
|
|
208
|
-
| "Stage 1 太严格" | 严格是为了质量。不妥协。 |
|
|
209
|
-
|
|
210
|
-
---
|
|
211
|
-
|
|
212
|
-
## 错误处理
|
|
213
|
-
|
|
214
|
-
### Stage 1 失败
|
|
215
|
-
|
|
216
|
-
```yaml
|
|
217
|
-
输出:
|
|
218
|
-
- SPEC_REVIEW.md (包含失败项)
|
|
219
|
-
- 必需修复清单
|
|
220
|
-
|
|
221
|
-
下一步:
|
|
222
|
-
- 开发者修复缺失/超范围项
|
|
223
|
-
- 重新运行 /flow-review
|
|
224
|
-
```
|
|
225
|
-
|
|
226
|
-
### Stage 2 失败
|
|
227
|
-
|
|
228
|
-
```yaml
|
|
229
|
-
输出:
|
|
230
|
-
- CODE_QUALITY_REVIEW.md (包含问题)
|
|
231
|
-
- 改进建议
|
|
232
|
-
|
|
233
|
-
下一步:
|
|
234
|
-
- 开发者修复质量问题
|
|
235
|
-
- 重新运行 /flow-review
|
|
236
|
-
```
|
|
237
|
-
|
|
238
|
-
---
|
|
239
|
-
|
|
240
|
-
## Next Step
|
|
241
|
-
|
|
242
|
-
```
|
|
243
|
-
/flow-qa "${REQ_ID}"
|
|
244
|
-
```
|
|
245
|
-
|
|
246
|
-
进入 QA 测试阶段
|
|
247
|
-
|
|
248
|
-
---
|
|
249
|
-
|
|
250
|
-
**Related Documentation**:
|
|
251
|
-
- [spec-reviewer.md](../.claude/agents/spec-reviewer.md) - Stage 1 Agent
|
|
252
|
-
- [code-reviewer.md](../.claude/agents/code-reviewer.md) - Stage 2 Agent
|
|
253
|
-
- [verification-before-completion](../.claude/skills/verification-before-completion/SKILL.md) - 验证技能
|
|
254
|
-
|
|
255
|
-
---
|
|
256
|
-
|
|
257
|
-
**[PROTOCOL]**: 变更时更新此头部,然后检查 CLAUDE.md
|
|
@@ -1,142 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: flow-tech
|
|
3
|
-
description: 'Generate Technical Design package. Usage: /flow-tech "REQ-123" or /flow-tech'
|
|
4
|
-
scripts:
|
|
5
|
-
prereq: .claude/scripts/check-prerequisites.sh
|
|
6
|
-
tech_analysis: .claude/scripts/generate-tech-analysis.sh
|
|
7
|
-
extract_data_model: .claude/scripts/extract-data-model.sh
|
|
8
|
-
export_contracts: .claude/scripts/export-contracts.sh
|
|
9
|
-
quickstart: .claude/scripts/generate-quickstart.sh
|
|
10
|
-
agent_scripts:
|
|
11
|
-
sh: .claude/scripts/update-agent-context.sh __AGENT__
|
|
12
|
-
ps: scripts/powershell/update-agent-context.ps1 -AgentType __AGENT__
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
# Flow-Tech - 技术方案生成命令
|
|
16
|
-
|
|
17
|
-
## User Input
|
|
18
|
-
```text
|
|
19
|
-
$ARGUMENTS = "REQ_ID"
|
|
20
|
-
```
|
|
21
|
-
若缺省则从当前分支或 `DEVFLOW_REQ_ID` 推断;进入流程前必须解析成功。
|
|
22
|
-
|
|
23
|
-
## 命令格式
|
|
24
|
-
```text
|
|
25
|
-
/flow-tech "REQ_ID"
|
|
26
|
-
/flow-tech # Auto-detect from current branch
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
### 参数说明
|
|
30
|
-
- **REQ_ID**: 需求编号 (可选,默认从当前 Git 分支或环境变量获取)
|
|
31
|
-
|
|
32
|
-
## 执行流程
|
|
33
|
-
|
|
34
|
-
### 阶段 0: Anti-Tech-Creep Gate
|
|
35
|
-
- 读取 `CLAUDE.md` 的技术架构章节并对照 `research/internal/codebase-overview.md`。
|
|
36
|
-
- 若缺失或与现状不符:重写 ≤15 行的架构摘要并记录核心原则。
|
|
37
|
-
- 触发约束:除非在技术方案中明确说明,禁止引入新技术或任意替换既有栈。
|
|
38
|
-
|
|
39
|
-
### 阶段 1: 前置条件检查 (Entry Gate)
|
|
40
|
-
```
|
|
41
|
-
1. 解析 REQ_ID
|
|
42
|
-
→ If $ARGUMENTS provided: use split("|") first token
|
|
43
|
-
→ Else: run {SCRIPT:prereq} --json --paths-only
|
|
44
|
-
→ If仍为空: ERROR "No requirement ID found."
|
|
45
|
-
|
|
46
|
-
2. 验证目录与产物
|
|
47
|
-
→ 检查: devflow/requirements/${REQ_ID}/
|
|
48
|
-
→ 必须存在: PRD.md, research/research.md, research/tasks.json, research/internal/codebase-overview.md
|
|
49
|
-
→ orchestration_status.json.phase0_complete 必须为 true
|
|
50
|
-
|
|
51
|
-
3. 状态门
|
|
52
|
-
→ status ∈ {prd_complete, ui_complete, tech_design_failed}
|
|
53
|
-
→ 未满足则拒绝进入。
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
### 阶段 2: 技术细化分析
|
|
57
|
-
```
|
|
58
|
-
1. 执行 {SCRIPT:tech_analysis} "${REQ_ID}"
|
|
59
|
-
→ 输出: research/codebase-tech-analysis.md
|
|
60
|
-
→ 内容: 数据模型模式、API 模式、认证、安全、数据库、可复用组件、测试、示例代码。
|
|
61
|
-
|
|
62
|
-
2. 同步 EXECUTION_LOG.md
|
|
63
|
-
→ 记录分析完成时间、重点洞察、待确认风险。
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
### 阶段 3: 资产生成与 Agent 调用
|
|
67
|
-
```
|
|
68
|
-
1. 准备 TECH_DESIGN 上下文
|
|
69
|
-
→ 读取: PRD.md, research/research.md, research/codebase-tech-analysis.md
|
|
70
|
-
→ 可选: UI_PROTOTYPE.html (存在时加载结构摘要)
|
|
71
|
-
→ 更新 orchestration_status: status=tech_design_in_progress, phase=technical_design.
|
|
72
|
-
|
|
73
|
-
2. 调用 tech-architect agent
|
|
74
|
-
→ 加载模板: .claude/docs/templates/TECH_DESIGN_TEMPLATE.md
|
|
75
|
-
→ 执行模板 Execution Flow,输出 TECH_DESIGN.md(无 {{PLACEHOLDER}})
|
|
76
|
-
→ 记录 log_event "${REQ_ID}" "Technical design completed"
|
|
77
|
-
|
|
78
|
-
3. 派生资产
|
|
79
|
-
→ Run: {SCRIPT:extract_data_model} "${REQ_ID}" → 生成 data-model.md
|
|
80
|
-
→ Run: {SCRIPT:export_contracts} "${REQ_ID}" → 生成 contracts/openapi.yaml (或其他格式)
|
|
81
|
-
→ Run: {SCRIPT:quickstart} "${REQ_ID}" → 生成 quickstart.md(包含环境、测试命令、验证步骤)
|
|
82
|
-
|
|
83
|
-
4. 更新代理上下文
|
|
84
|
-
→ Run: {AGENT_SCRIPT} # 仅新增技术条目,保持 markers 内手动内容
|
|
85
|
-
→ 在 EXECUTION_LOG.md 记录新增技术。
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
### 阶段 4: 完成校验 (Exit Gate)
|
|
89
|
-
```
|
|
90
|
-
1. 文件存在性
|
|
91
|
-
→ TECH_DESIGN.md, research/codebase-tech-analysis.md
|
|
92
|
-
→ data-model.md, contracts/, quickstart.md
|
|
93
|
-
|
|
94
|
-
2. 质量检查
|
|
95
|
-
→ TECH_DESIGN.md: 包含系统架构/技术栈/数据模型/API/安全/性能/Constitution Gate
|
|
96
|
-
→ data-model.md: 实体、字段、关系、校验、状态机
|
|
97
|
-
→ contracts/: 所有端点请求/响应 schema
|
|
98
|
-
→ quickstart.md: 环境准备、测试矩阵、验证指令
|
|
99
|
-
|
|
100
|
-
3. 宪法校验
|
|
101
|
-
→ Run: validate-constitution.sh --type tech_design --severity warning
|
|
102
|
-
→ 若有 ERROR 级别违规:终止并修复
|
|
103
|
-
|
|
104
|
-
4. 状态更新
|
|
105
|
-
→ orchestration_status.json:
|
|
106
|
-
• status = "tech_design_complete"
|
|
107
|
-
• phase = "epic_planning"
|
|
108
|
-
• phase1_complete = true
|
|
109
|
-
• completedSteps append "tech_design"
|
|
110
|
-
→ EXECUTION_LOG.md 记录出口验收。
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
### 阶段 5: 输出与下一步
|
|
114
|
-
- 汇总结果:
|
|
115
|
-
```
|
|
116
|
-
✅ TECH_DESIGN.md
|
|
117
|
-
✅ research/codebase-tech-analysis.md
|
|
118
|
-
✅ data-model.md
|
|
119
|
-
✅ contracts/openapi.yaml
|
|
120
|
-
✅ quickstart.md
|
|
121
|
-
```
|
|
122
|
-
- 建议操作:
|
|
123
|
-
1. 审阅技术方案关键决策。
|
|
124
|
-
2. 使用 `/flow-epic` 进入任务规划(会 gate 检查上述资产)。
|
|
125
|
-
3. 如需补充研究,回到 `/flow-init` 生成的 research/tasks.json 更新状态。
|
|
126
|
-
|
|
127
|
-
## 错误处理提示
|
|
128
|
-
- 缺少 PRD 或 research.md → 直接 ERROR,让用户先补 Phase 0。
|
|
129
|
-
- agent 输出不完整 → 保留临时文件并记录 `tech_design_failed`,用户可修正后重试。
|
|
130
|
-
- 派生资产脚本失败 → 标记 `phase1_complete = false`,提示对应脚本名与日志路径。
|
|
131
|
-
|
|
132
|
-
## 宪法遵循
|
|
133
|
-
- Simplicity Gate:设计 ≤3 栈层、禁止为未来功能做预设。
|
|
134
|
-
- Anti-Abstraction Gate:直接使用框架,不新增自定义抽象层。
|
|
135
|
-
- Integration-First Gate:所有 contracts 在 Phase 2 先定义,Phase 3 任务只需按合同落地。
|
|
136
|
-
|
|
137
|
-
## 产物摘要
|
|
138
|
-
- `TECH_DESIGN.md`: 技术总纲,引用子文档链接。
|
|
139
|
-
- `research/codebase-tech-analysis.md`: 深度分析,支撑方案假设。
|
|
140
|
-
- `data-model.md`: 供 planner 和 DB 工具使用的实体清单。
|
|
141
|
-
- `contracts/`: OpenAPI/GraphQL 等契约基线。
|
|
142
|
-
- `quickstart.md`: QA、Dev、CI 共享的执行脚本。
|
|
@@ -1,189 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: flow-ui
|
|
3
|
-
description: 'Generate interactive HTML prototype from PRD. Usage: /flow-ui "REQ-123" or /flow-ui'
|
|
4
|
-
scripts:
|
|
5
|
-
prereq: .claude/scripts/check-prerequisites.sh
|
|
6
|
-
validate_constitution: .claude/scripts/validate-constitution.sh
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# Flow-UI - UI 原型生成命令
|
|
10
|
-
|
|
11
|
-
## User Input
|
|
12
|
-
```text
|
|
13
|
-
$ARGUMENTS = "REQ_ID?"
|
|
14
|
-
```
|
|
15
|
-
缺省时依据当前分支或 `DEVFLOW_REQ_ID` 自动解析。
|
|
16
|
-
|
|
17
|
-
## 命令格式
|
|
18
|
-
```text
|
|
19
|
-
/flow-ui "REQ_ID"
|
|
20
|
-
/flow-ui # Auto-detect from current branch
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
## 触发原则
|
|
24
|
-
- **自动触发**:PRD 含 UI 关键词(用户界面、前端、页面、交互…),或仓库存在 `package.json`、`src/components/` 等前端特征。
|
|
25
|
-
- **手动触发**:用户显式调用 `/flow-ui`。
|
|
26
|
-
- **自动跳过**:PRD 标注“纯后端/无 UI”,或项目缺少前端栈特征。跳过时记录 `ui_skipped`。
|
|
27
|
-
|
|
28
|
-
## 执行流程
|
|
29
|
-
|
|
30
|
-
### 阶段 1: Entry Gate
|
|
31
|
-
```
|
|
32
|
-
1. 解析 REQ_ID
|
|
33
|
-
→ If argument provided: use it
|
|
34
|
-
→ Else: run {SCRIPT:prereq} --json --paths-only
|
|
35
|
-
→ If仍为空: ERROR "No requirement ID found."
|
|
36
|
-
|
|
37
|
-
2. 校验资产
|
|
38
|
-
→ 必须存在:
|
|
39
|
-
• PRD.md(无 {{PLACEHOLDER}})
|
|
40
|
-
• research/research.md
|
|
41
|
-
• orchestration_status.status == "prd_complete"
|
|
42
|
-
→ 如果 UI_PROTOTYPE.html 已存在 → WARN 并确认覆盖
|
|
43
|
-
|
|
44
|
-
3. UI 需求检测
|
|
45
|
-
→ 检查 PRD 关键词 + 项目结构
|
|
46
|
-
→ 如检测不到且用户拒绝继续 → 记录 EXECUTION_LOG "ui_skipped" 后退出
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
### 阶段 2: 设计风格加载与灵感采样
|
|
50
|
-
```
|
|
51
|
-
1. 检查项目级 STYLE.md 是否存在
|
|
52
|
-
→ 检查 devflow/STYLE.md 文件
|
|
53
|
-
→ 如存在:
|
|
54
|
-
• 加载 STYLE.md 作为首要参考(优先级最高)
|
|
55
|
-
• 所有颜色、字体、间距、组件必须严格遵循 STYLE.md
|
|
56
|
-
• 在 EXECUTION_LOG.md 记录 STYLE.md 版本和使用情况
|
|
57
|
-
→ 如不存在:
|
|
58
|
-
• 使用默认采样策略(80+ 设计大师)
|
|
59
|
-
• 建议用户先运行 /flow-style 建立项目设计标准
|
|
60
|
-
|
|
61
|
-
2. 从 PRD 抽取风格线索(作为 STYLE.md 的补充或默认策略)
|
|
62
|
-
→ 背景/目标、用户画像、NFR 中的视觉/品牌要求
|
|
63
|
-
→ 关键词示例: 现代、简约、科技感、典雅、活泼、企业级、极简、暗色、明快
|
|
64
|
-
|
|
65
|
-
3. 建立关键词 → 设计风格/大师映射(仅在无 STYLE.md 时使用完整策略)
|
|
66
|
-
• 现代 / 简约 / 专业:
|
|
67
|
-
- 现代主义信息设计 (Josef Müller-Brockmann, Massimo Vignelli)
|
|
68
|
-
- 工业设计 (Dieter Rams, Jony Ive)
|
|
69
|
-
• 科技感 / 创新 / 动态:
|
|
70
|
-
- 生成艺术 (Refik Anadol, John Maeda)
|
|
71
|
-
- 未来派建筑 (Zaha Hadid, BIG)
|
|
72
|
-
• 典雅 / 文化 / 文艺:
|
|
73
|
-
- 亚洲与当代艺术 (原研哉, 草间弥生)
|
|
74
|
-
- 平面设计 (Paula Scher, Neville Brody)
|
|
75
|
-
• 活泼 / 年轻 / 时尚:
|
|
76
|
-
- 后现代图形 (David Carson, April Greiman)
|
|
77
|
-
- 抽象艺术 (Henri Matisse, Joan Miró)
|
|
78
|
-
• 企业级 / 金融 / 严肃:
|
|
79
|
-
- 现代主义建筑 (Le Corbusier, Alvar Aalto)
|
|
80
|
-
- 工业设计 (Braun School)
|
|
81
|
-
• 未匹配关键词:
|
|
82
|
-
- 默认组合: 现代主义 + 工业设计
|
|
83
|
-
|
|
84
|
-
3. 可选灵感采集
|
|
85
|
-
→ 若 PRD 或用户提供参考站点/风格,使用 WebSearch/WebFetch 收集视觉要点,
|
|
86
|
-
保存至 `research/ui_inspiration_*.md`
|
|
87
|
-
|
|
88
|
-
4. 生成 `research/ui_design_strategy.md`
|
|
89
|
-
→ 结构建议:
|
|
90
|
-
```
|
|
91
|
-
# UI 设计策略 - ${REQ_ID}
|
|
92
|
-
|
|
93
|
-
## 项目级风格指南引用(如存在)
|
|
94
|
-
- STYLE.md 路径: devflow/STYLE.md
|
|
95
|
-
- STYLE.md 版本: v1.0.0
|
|
96
|
-
- 必须遵循的设计元素:
|
|
97
|
-
• 颜色: 主色 #XXXXXX, 辅色 #XXXXXX, ...(来自 STYLE.md)
|
|
98
|
-
• 字体: Font Family, Weight, Size(来自 STYLE.md)
|
|
99
|
-
• 间距: 4px, 8px, 16px, ...(来自 STYLE.md)
|
|
100
|
-
• 组件风格: Button, Card, Input 样式(来自 STYLE.md)
|
|
101
|
-
• 阴影、圆角、动画等(来自 STYLE.md)
|
|
102
|
-
- STYLE.md 未覆盖的部分处理策略:
|
|
103
|
-
• 使用 PRD 风格线索 + 默认采样策略
|
|
104
|
-
|
|
105
|
-
## PRD 风格提取
|
|
106
|
-
- 领域 / 用户画像 / 场景
|
|
107
|
-
- 关键词列表
|
|
108
|
-
- 明确要求 / 禁忌
|
|
109
|
-
|
|
110
|
-
## 采样策略(仅在无 STYLE.md 或 STYLE.md 未覆盖部分)
|
|
111
|
-
- 选定流派 1 (大师列表 + 采样理由)
|
|
112
|
-
- 选定流派 2 (大师列表 + 采样理由)
|
|
113
|
-
- 默认样式(无关键词时的 fallback)
|
|
114
|
-
|
|
115
|
-
## 色彩 / 字体 / 布局假设
|
|
116
|
-
- 主/辅色、对比度、排版方向
|
|
117
|
-
- (如有 STYLE.md,此部分直接引用 STYLE.md)
|
|
118
|
-
|
|
119
|
-
## 交互与响应式要点
|
|
120
|
-
- 核心动效、断点策略、可访问性注意事项
|
|
121
|
-
- (如有 STYLE.md,响应式断点、动画时长等引用 STYLE.md)
|
|
122
|
-
|
|
123
|
-
## 外部灵感 (如有)
|
|
124
|
-
- 引用链接 + 摘要
|
|
125
|
-
```
|
|
126
|
-
→ EXECUTION_LOG.md 记录策略生成、STYLE.md 使用情况、关键词
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
### 阶段 3: 调用 ui-designer Agent
|
|
130
|
-
```
|
|
131
|
-
Prompt 要求:
|
|
132
|
-
- 输入:
|
|
133
|
-
• PRD.md
|
|
134
|
-
• ui_design_strategy.md
|
|
135
|
-
• research 集合
|
|
136
|
-
• devflow/STYLE.md(如存在,必须作为首要参考)
|
|
137
|
-
- 输出: UI_PROTOTYPE.html
|
|
138
|
-
- 遵循模板 (.claude/docs/templates/UI_PROTOTYPE_TEMPLATE.md):
|
|
139
|
-
• 页面列表、组件清单、设计系统 (颜色/字体/间距)
|
|
140
|
-
• 响应式断点 (320/768/1024)
|
|
141
|
-
• 交互状态 (hover/active/disabled)
|
|
142
|
-
• 文档内注释说明各部分映射的 PRD 验收标准
|
|
143
|
-
- STYLE.md 约束(如存在):
|
|
144
|
-
• 所有颜色必须使用 STYLE.md 定义的色板(主色、辅色、语义色、中性色)
|
|
145
|
-
• 所有字体必须使用 STYLE.md 定义的字体系统(字体族、字阶)
|
|
146
|
-
• 所有间距必须使用 STYLE.md 定义的间距系统(spacing scale)
|
|
147
|
-
• 所有组件样式必须遵循 STYLE.md 定义的组件规范(Button, Card, Input 等)
|
|
148
|
-
• 阴影、圆角、动画、透明度等必须遵循 STYLE.md
|
|
149
|
-
• 响应式断点必须遵循 STYLE.md(如有定义)
|
|
150
|
-
• 仅在 STYLE.md 未覆盖的部分,才使用默认采样策略(80+ 设计大师)
|
|
151
|
-
- Constitution: 禁止外链资源、禁止敏感数据硬编码
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
### 阶段 4: Exit Gate
|
|
155
|
-
```
|
|
156
|
-
1. 文件存在
|
|
157
|
-
→ UI_PROTOTYPE.html
|
|
158
|
-
→ research/ui_design_strategy.md
|
|
159
|
-
|
|
160
|
-
2. 结构检查
|
|
161
|
-
→ HTML 内包含设计系统、页面导航、组件说明
|
|
162
|
-
→ 注释中标注 PRD 用户故事和验收点
|
|
163
|
-
|
|
164
|
-
3. 状态更新
|
|
165
|
-
→ orchestration_status:
|
|
166
|
-
status = "ui_complete"
|
|
167
|
-
completedSteps append "ui"
|
|
168
|
-
→ 如跳过,则 status = "ui_skipped" 并记录原因
|
|
169
|
-
|
|
170
|
-
4. 宪法校验(可选)
|
|
171
|
-
→ {SCRIPT:validate_constitution} --type ui --severity warning
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
## 输出
|
|
175
|
-
```
|
|
176
|
-
✅ UI_PROTOTYPE.html
|
|
177
|
-
✅ research/ui_design_strategy.md
|
|
178
|
-
✅ EXECUTION_LOG.md 更新(完成或跳过)
|
|
179
|
-
```
|
|
180
|
-
|
|
181
|
-
## 错误处理
|
|
182
|
-
- 缺少 PRD 或研究资产 → 提示先完成 `/flow-prd`、`/flow-init` Consolidation。
|
|
183
|
-
- Agent 生成失败 → status 设为 `ui_generation_failed`,可修正后重试。
|
|
184
|
-
- 用户确认跳过 → 标记 `ui_skipped`,后续流程仍可继续。
|
|
185
|
-
|
|
186
|
-
## 下一步
|
|
187
|
-
1. 审阅原型并与产品对齐。
|
|
188
|
-
2. 若涉及前端实现,确保 `/flow-tech` 引用 UI_PROTOTYPE 中的组件与断点。
|
|
189
|
-
3. Planner 在 `/flow-epic` 阶段加载页面/组件清单生成对应任务。
|
|
@@ -1,56 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: file-header-guardian
|
|
3
|
-
description: 文件头三行契约注释。触发:create file、新建文件、编写代码。
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# 文件头注释守护者
|
|
7
|
-
|
|
8
|
-
触发:创建代码文件,修改文件后检查头注释准确性。
|
|
9
|
-
|
|
10
|
-
## 模板
|
|
11
|
-
|
|
12
|
-
**TS/JS:**
|
|
13
|
-
```typescript
|
|
14
|
-
/**
|
|
15
|
-
* @input 依赖什么
|
|
16
|
-
* @output 提供什么
|
|
17
|
-
* @pos 系统地位
|
|
18
|
-
* ⚠️ 修改后同步:文件头 + 目录 CLAUDE.md
|
|
19
|
-
*/
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
**Python:**
|
|
23
|
-
```python
|
|
24
|
-
"""
|
|
25
|
-
@input 依赖什么
|
|
26
|
-
@output 提供什么
|
|
27
|
-
@pos 系统地位
|
|
28
|
-
⚠️ 修改后同步:文件头 + 目录 CLAUDE.md
|
|
29
|
-
"""
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
**Shell:**
|
|
33
|
-
```bash
|
|
34
|
-
# @input 依赖什么
|
|
35
|
-
# @output 提供什么
|
|
36
|
-
# @pos 系统地位
|
|
37
|
-
# ⚠️ 修改后同步:文件头 + 目录 CLAUDE.md
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
## 示例
|
|
41
|
-
|
|
42
|
-
```typescript
|
|
43
|
-
/**
|
|
44
|
-
* @input prisma.service 数据库连接
|
|
45
|
-
* @output UserService: create/update/delete
|
|
46
|
-
* @pos 用户模块核心
|
|
47
|
-
* ⚠️ 修改后同步:文件头 + 目录 CLAUDE.md
|
|
48
|
-
*/
|
|
49
|
-
export class UserService { }
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
## 豁免
|
|
53
|
-
|
|
54
|
-
配置文件(json/yaml)、样式(css)、生成文件(*.d.ts)、node_modules。
|
|
55
|
-
|
|
56
|
-
协作:本 skill 管文件,fractal-docs-generator 管目录。
|