@edupia-tutor/spec-driven-docs 0.14.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/bin/build.js +230 -0
- package/bin/index.js +598 -0
- package/commands/debug.md +830 -0
- package/commands/debug.tmpl +257 -0
- package/commands/define-product.md +652 -0
- package/commands/define-product.tmpl +158 -0
- package/commands/dev-gen-test.md +1010 -0
- package/commands/dev-gen-test.tmpl +490 -0
- package/commands/dev-run-test.md +744 -0
- package/commands/dev-run-test.tmpl +224 -0
- package/commands/dev-smoke-test.md +711 -0
- package/commands/dev-smoke-test.tmpl +217 -0
- package/commands/fix-bug.md +744 -0
- package/commands/fix-bug.tmpl +171 -0
- package/commands/generate-bdd.md +1054 -0
- package/commands/generate-bdd.tmpl +534 -0
- package/commands/generate-code.md +869 -0
- package/commands/generate-code.tmpl +349 -0
- package/commands/generate-design-spec.md +958 -0
- package/commands/generate-design-spec.tmpl +464 -0
- package/commands/generate-prd.md +748 -0
- package/commands/generate-prd.tmpl +254 -0
- package/commands/generate-spec-manifest.md +658 -0
- package/commands/generate-spec-manifest.tmpl +164 -0
- package/commands/generate-tech-docs.md +849 -0
- package/commands/generate-tech-docs.tmpl +355 -0
- package/commands/learn.md +636 -0
- package/commands/learn.tmpl +63 -0
- package/commands/map-testids.md +575 -0
- package/commands/map-testids.tmpl +81 -0
- package/commands/propose-scenario.md +623 -0
- package/commands/propose-scenario.tmpl +129 -0
- package/commands/qc-analyze.md +580 -0
- package/commands/qc-analyze.tmpl +86 -0
- package/commands/qc-design-test.md +562 -0
- package/commands/qc-design-test.tmpl +68 -0
- package/commands/qc-plan.md +543 -0
- package/commands/qc-plan.tmpl +49 -0
- package/commands/qc-report.md +554 -0
- package/commands/qc-report.tmpl +60 -0
- package/commands/qc-review.md +547 -0
- package/commands/qc-review.tmpl +53 -0
- package/commands/qc-run-test.md +604 -0
- package/commands/qc-run-test.tmpl +84 -0
- package/commands/refine-prd.md +772 -0
- package/commands/refine-prd.tmpl +140 -0
- package/commands/report-bug.md +639 -0
- package/commands/report-bug.tmpl +145 -0
- package/commands/review-code.md +677 -0
- package/commands/review-code.tmpl +104 -0
- package/commands/review-context.md +1047 -0
- package/commands/review-context.tmpl +415 -0
- package/commands/review-tech-docs.md +811 -0
- package/commands/review-tech-docs.tmpl +317 -0
- package/commands/setup-ai-first.md +545 -0
- package/commands/setup-ai-first.tmpl +358 -0
- package/commands/sync.md +451 -0
- package/commands/sync.tmpl +351 -0
- package/commands/update-framework.md +251 -0
- package/commands/update-framework.tmpl +151 -0
- package/commands/validate-traces.md +842 -0
- package/commands/validate-traces.tmpl +348 -0
- package/core/FRAMEWORK_VERSION +1 -0
- package/core/commands/debug.md +830 -0
- package/core/commands/define-product.md +652 -0
- package/core/commands/dev-gen-test.md +1010 -0
- package/core/commands/dev-run-test.md +744 -0
- package/core/commands/dev-smoke-test.md +711 -0
- package/core/commands/fix-bug.md +744 -0
- package/core/commands/generate-bdd.md +1054 -0
- package/core/commands/generate-code.md +869 -0
- package/core/commands/generate-design-spec.md +958 -0
- package/core/commands/generate-prd.md +748 -0
- package/core/commands/generate-spec-manifest.md +658 -0
- package/core/commands/generate-tech-docs.md +849 -0
- package/core/commands/learn.md +636 -0
- package/core/commands/map-testids.md +575 -0
- package/core/commands/propose-scenario.md +623 -0
- package/core/commands/qc-analyze.md +580 -0
- package/core/commands/qc-design-test.md +562 -0
- package/core/commands/qc-plan.md +543 -0
- package/core/commands/qc-report.md +554 -0
- package/core/commands/qc-review.md +547 -0
- package/core/commands/qc-run-test.md +604 -0
- package/core/commands/refine-prd.md +772 -0
- package/core/commands/report-bug.md +639 -0
- package/core/commands/review-code.md +677 -0
- package/core/commands/review-context.md +1047 -0
- package/core/commands/review-tech-docs.md +811 -0
- package/core/commands/setup-ai-first.md +545 -0
- package/core/commands/sync.md +451 -0
- package/core/commands/update-framework.md +251 -0
- package/core/commands/validate-traces.md +842 -0
- package/core/hooks/data-guard.js +141 -0
- package/core/hooks/settings.json +18 -0
- package/core/modules/android-compose/module.yaml +13 -0
- package/core/modules/android-compose/stack-profile.yaml +57 -0
- package/core/modules/angular/architecture-snippets/component-patterns.md +187 -0
- package/core/modules/angular/module.yaml +6 -0
- package/core/modules/angular/stack-profile.yaml +38 -0
- package/core/modules/context-engineering/architecture-snippets/context-design.md +119 -0
- package/core/modules/context-engineering/module.yaml +9 -0
- package/core/modules/context-engineering/stack-profile.yaml +61 -0
- package/core/modules/dotnet/architecture-snippets/clean-arch.md +160 -0
- package/core/modules/dotnet/module.yaml +6 -0
- package/core/modules/dotnet/stack-profile.yaml +50 -0
- package/core/modules/flutter/module.yaml +14 -0
- package/core/modules/flutter/stack-profile.yaml +59 -0
- package/core/modules/golang/architecture-snippets/domain-layout.md +283 -0
- package/core/modules/golang/module.yaml +6 -0
- package/core/modules/golang/stack-profile.yaml +40 -0
- package/core/modules/ios-swiftui/module.yaml +13 -0
- package/core/modules/ios-swiftui/stack-profile.yaml +55 -0
- package/core/modules/java-spring/architecture-snippets/layered-arch.md +201 -0
- package/core/modules/java-spring/module.yaml +15 -0
- package/core/modules/java-spring/stack-profile.yaml +28 -0
- package/core/modules/nextjs/architecture-snippets/app-router-patterns.md +269 -0
- package/core/modules/nextjs/module.yaml +14 -0
- package/core/modules/nextjs/stack-profile.yaml +74 -0
- package/core/modules/nuxt/module.yaml +14 -0
- package/core/modules/nuxt/stack-profile.yaml +58 -0
- package/core/modules/php-laravel/architecture-snippets/service-repository.md +302 -0
- package/core/modules/php-laravel/module.yaml +15 -0
- package/core/modules/php-laravel/stack-profile.yaml +56 -0
- package/core/modules/qc-playwright/stack-profile.yaml +66 -0
- package/core/modules/react/architecture-snippets/hooks-query-patterns.md +254 -0
- package/core/modules/react/module.yaml +14 -0
- package/core/modules/react/stack-profile.yaml +63 -0
- package/core/modules/react-native/module.yaml +14 -0
- package/core/modules/react-native/stack-profile.yaml +56 -0
- package/core/modules/vue/module.yaml +14 -0
- package/core/modules/vue/stack-profile.yaml +65 -0
- package/core/rules/data-protection.md +80 -0
- package/core/rules/workflow.md +44 -0
- package/core/skills/code/SKILL.md +770 -0
- package/core/skills/debug/SKILL.md +869 -0
- package/core/skills/design-spec/SKILL.md +589 -0
- package/core/skills/discovery/SKILL.md +554 -0
- package/core/skills/prd/SKILL.md +562 -0
- package/core/skills/qc/qa-analyst/DOC_GAPS.template.md +63 -0
- package/core/skills/qc/qa-analyst/acceptance-criteria.md +60 -0
- package/core/skills/qc/qa-analyst/business-rules.md +59 -0
- package/core/skills/qc/qa-analyst/data-flow.md +64 -0
- package/core/skills/qc/qa-analyst/spec-breakdown.md +61 -0
- package/core/skills/qc/qa-designer/e2e/journey.md +41 -0
- package/core/skills/qc/qa-designer/exploratory/charter.md +68 -0
- package/core/skills/qc/qa-designer/exploratory/explore-to-functional.md +43 -0
- package/core/skills/qc/qa-designer/functional/api.md +45 -0
- package/core/skills/qc/qa-designer/functional/gui-feature.md +46 -0
- package/core/skills/qc/qa-designer/functional/gui-screen.md +52 -0
- package/core/skills/qc/qa-designer/integration/api.md +42 -0
- package/core/skills/qc/qa-designer/integration/db.md +39 -0
- package/core/skills/qc/qa-designer/integration/gui.md +40 -0
- package/core/skills/qc/qa-designer/integration/kafka.md +40 -0
- package/core/skills/qc/qa-designer/non-functional.md +40 -0
- package/core/skills/qc/qa-planner/test-plan.md +120 -0
- package/core/skills/qc/qa-reviewer/script/e2e.md +87 -0
- package/core/skills/qc/qa-reviewer/script/exploratory.md +45 -0
- package/core/skills/qc/qa-reviewer/script/functional.md +101 -0
- package/core/skills/qc/qa-reviewer/script/integration.md +91 -0
- package/core/skills/qc/qa-reviewer/script/non-functional.md +126 -0
- package/core/skills/qc/qa-reviewer/test-case/e2e.md +73 -0
- package/core/skills/qc/qa-reviewer/test-case/exploratory.md +43 -0
- package/core/skills/qc/qa-reviewer/test-case/functional.md +76 -0
- package/core/skills/qc/qa-reviewer/test-case/integration.md +69 -0
- package/core/skills/qc/qa-reviewer/test-case/non-functional.md +73 -0
- package/core/skills/qc/qa-runner/e2e.md +49 -0
- package/core/skills/qc/qa-runner/exploratory/session.md +36 -0
- package/core/skills/qc/qa-runner/functional/api.md +35 -0
- package/core/skills/qc/qa-runner/functional/gui-feature.md +51 -0
- package/core/skills/qc/qa-runner/functional/gui-screen.md +55 -0
- package/core/skills/qc/qa-runner/integration.md +47 -0
- package/core/skills/qc/qa-runner/non-functional.md +49 -0
- package/core/skills/qc/qa-runner/report/report.md +37 -0
- package/core/skills/setup-ai-first/SKILL.md +216 -0
- package/core/skills/spec/SKILL.md +461 -0
- package/core/skills/test/SKILL.md +1297 -0
- package/core/steps/capture-lesson.md +79 -0
- package/core/steps/context-loader.md +307 -0
- package/core/steps/gate.md +87 -0
- package/core/steps/report-footer.md +100 -0
- package/core/steps/review-fanout.md +138 -0
- package/core/steps/spawn-agent.md +124 -0
- package/core/steps/trace-mirror.md +26 -0
- package/core/templates/architecture.template.md +113 -0
- package/core/templates/design-spec.template.md +217 -0
- package/core/templates/feature.template +259 -0
- package/core/templates/platform-guide.template.md +145 -0
- package/core/templates/prd.template.md +327 -0
- package/core/templates/product-definition.template.md +168 -0
- package/core/templates/project-context.yaml +161 -0
- package/docs/01-getting-started/README.md +19 -0
- package/docs/01-getting-started/core-concepts.md +102 -0
- package/docs/01-getting-started/installation.md +156 -0
- package/docs/01-getting-started/quickstart.md +85 -0
- package/docs/02-guides/README.md +26 -0
- package/docs/02-guides/developer/README.md +46 -0
- package/docs/02-guides/developer/bdd-and-trace.md +125 -0
- package/docs/02-guides/developer/commands.md +76 -0
- package/docs/02-guides/developer/pr-checklist.md +15 -0
- package/docs/02-guides/developer/scenarios.md +460 -0
- package/docs/02-guides/developer/workflow.md +121 -0
- package/docs/02-guides/product-owner/README.md +79 -0
- package/docs/02-guides/product-owner/commands.md +30 -0
- package/docs/02-guides/product-owner/handoff-checklist.md +42 -0
- package/docs/02-guides/product-owner/prd-writing-rules.md +45 -0
- package/docs/02-guides/product-owner/scenarios.md +436 -0
- package/docs/02-guides/tester/README.md +75 -0
- package/docs/02-guides/tester/bug-reporting.md +117 -0
- package/docs/02-guides/tester/qc-automation.md +165 -0
- package/docs/02-guides/tester/reading-specs.md +79 -0
- package/docs/02-guides/tester/scenarios.md +186 -0
- package/docs/02-guides/tester/spec-manifest.md +130 -0
- package/docs/02-guides/tester/test-checklist.md +31 -0
- package/docs/02-guides/tester/workflow.md +77 -0
- package/docs/03-concepts/README.md +19 -0
- package/docs/03-concepts/architecture.md +248 -0
- package/docs/03-concepts/pipeline.md +274 -0
- package/docs/03-concepts/traceability.md +149 -0
- package/docs/04-operations/README.md +33 -0
- package/docs/04-operations/bug-flow.md +362 -0
- package/docs/04-operations/publishing.md +137 -0
- package/docs/04-operations/sync-and-update.md +522 -0
- package/docs/05-reference/README.md +32 -0
- package/docs/05-reference/command-cheatsheet.md +147 -0
- package/docs/05-reference/commands.md +232 -0
- package/docs/05-reference/modules.md +110 -0
- package/docs/05-reference/trace-schema.md +153 -0
- package/docs/README.md +49 -0
- package/hooks/data-guard.js +141 -0
- package/hooks/settings.json +18 -0
- package/modules/android-compose/module.yaml +13 -0
- package/modules/android-compose/stack-profile.yaml +57 -0
- package/modules/angular/architecture-snippets/component-patterns.md +187 -0
- package/modules/angular/module.yaml +6 -0
- package/modules/angular/stack-profile.yaml +38 -0
- package/modules/context-engineering/architecture-snippets/context-design.md +119 -0
- package/modules/context-engineering/module.yaml +9 -0
- package/modules/context-engineering/stack-profile.yaml +61 -0
- package/modules/dotnet/architecture-snippets/clean-arch.md +160 -0
- package/modules/dotnet/module.yaml +6 -0
- package/modules/dotnet/stack-profile.yaml +50 -0
- package/modules/flutter/module.yaml +14 -0
- package/modules/flutter/stack-profile.yaml +59 -0
- package/modules/golang/architecture-snippets/domain-layout.md +283 -0
- package/modules/golang/module.yaml +6 -0
- package/modules/golang/stack-profile.yaml +40 -0
- package/modules/ios-swiftui/module.yaml +13 -0
- package/modules/ios-swiftui/stack-profile.yaml +55 -0
- package/modules/java-spring/architecture-snippets/layered-arch.md +201 -0
- package/modules/java-spring/module.yaml +15 -0
- package/modules/java-spring/stack-profile.yaml +28 -0
- package/modules/nextjs/architecture-snippets/app-router-patterns.md +269 -0
- package/modules/nextjs/module.yaml +14 -0
- package/modules/nextjs/stack-profile.yaml +74 -0
- package/modules/nuxt/module.yaml +14 -0
- package/modules/nuxt/stack-profile.yaml +58 -0
- package/modules/php-laravel/architecture-snippets/service-repository.md +302 -0
- package/modules/php-laravel/module.yaml +15 -0
- package/modules/php-laravel/stack-profile.yaml +56 -0
- package/modules/qc-playwright/stack-profile.yaml +66 -0
- package/modules/react/architecture-snippets/hooks-query-patterns.md +254 -0
- package/modules/react/module.yaml +14 -0
- package/modules/react/stack-profile.yaml +63 -0
- package/modules/react-native/module.yaml +14 -0
- package/modules/react-native/stack-profile.yaml +56 -0
- package/modules/vue/module.yaml +14 -0
- package/modules/vue/stack-profile.yaml +65 -0
- package/package.json +49 -0
- package/rules/data-protection.md +80 -0
- package/rules/workflow.md +44 -0
- package/scripts/init.sh +49 -0
- package/scripts/migrate-specs.js +256 -0
- package/scripts/upgrade.sh +94 -0
- package/skills/code/SKILL.md +770 -0
- package/skills/code/SKILL.tmpl +176 -0
- package/skills/debug/SKILL.md +869 -0
- package/skills/debug/SKILL.tmpl +262 -0
- package/skills/design-spec/SKILL.md +589 -0
- package/skills/design-spec/SKILL.tmpl +95 -0
- package/skills/discovery/SKILL.md +554 -0
- package/skills/discovery/SKILL.tmpl +147 -0
- package/skills/prd/SKILL.md +562 -0
- package/skills/prd/SKILL.tmpl +188 -0
- package/skills/qc/qa-analyst/DOC_GAPS.template.md +63 -0
- package/skills/qc/qa-analyst/acceptance-criteria.md +60 -0
- package/skills/qc/qa-analyst/business-rules.md +59 -0
- package/skills/qc/qa-analyst/data-flow.md +64 -0
- package/skills/qc/qa-analyst/spec-breakdown.md +61 -0
- package/skills/qc/qa-designer/e2e/journey.md +41 -0
- package/skills/qc/qa-designer/exploratory/charter.md +68 -0
- package/skills/qc/qa-designer/exploratory/explore-to-functional.md +43 -0
- package/skills/qc/qa-designer/functional/api.md +45 -0
- package/skills/qc/qa-designer/functional/gui-feature.md +46 -0
- package/skills/qc/qa-designer/functional/gui-screen.md +52 -0
- package/skills/qc/qa-designer/integration/api.md +42 -0
- package/skills/qc/qa-designer/integration/db.md +39 -0
- package/skills/qc/qa-designer/integration/gui.md +40 -0
- package/skills/qc/qa-designer/integration/kafka.md +40 -0
- package/skills/qc/qa-designer/non-functional.md +40 -0
- package/skills/qc/qa-planner/test-plan.md +120 -0
- package/skills/qc/qa-reviewer/script/e2e.md +87 -0
- package/skills/qc/qa-reviewer/script/exploratory.md +45 -0
- package/skills/qc/qa-reviewer/script/functional.md +101 -0
- package/skills/qc/qa-reviewer/script/integration.md +91 -0
- package/skills/qc/qa-reviewer/script/non-functional.md +126 -0
- package/skills/qc/qa-reviewer/test-case/e2e.md +73 -0
- package/skills/qc/qa-reviewer/test-case/exploratory.md +43 -0
- package/skills/qc/qa-reviewer/test-case/functional.md +76 -0
- package/skills/qc/qa-reviewer/test-case/integration.md +69 -0
- package/skills/qc/qa-reviewer/test-case/non-functional.md +73 -0
- package/skills/qc/qa-runner/e2e.md +49 -0
- package/skills/qc/qa-runner/exploratory/session.md +36 -0
- package/skills/qc/qa-runner/functional/api.md +35 -0
- package/skills/qc/qa-runner/functional/gui-feature.md +51 -0
- package/skills/qc/qa-runner/functional/gui-screen.md +55 -0
- package/skills/qc/qa-runner/integration.md +47 -0
- package/skills/qc/qa-runner/non-functional.md +49 -0
- package/skills/qc/qa-runner/report/report.md +37 -0
- package/skills/setup-ai-first/SKILL.md +216 -0
- package/skills/setup-ai-first/SKILL.tmpl +116 -0
- package/skills/spec/SKILL.md +461 -0
- package/skills/spec/SKILL.tmpl +174 -0
- package/skills/test/SKILL.md +1297 -0
- package/skills/test/SKILL.tmpl +296 -0
- package/steps/capture-lesson.md +79 -0
- package/steps/context-loader.md +307 -0
- package/steps/gate.md +87 -0
- package/steps/report-footer.md +100 -0
- package/steps/review-fanout.md +138 -0
- package/steps/spawn-agent.md +124 -0
- package/steps/trace-mirror.md +26 -0
- package/templates/architecture.template.md +113 -0
- package/templates/design-spec.template.md +217 -0
- package/templates/feature.template +259 -0
- package/templates/platform-guide.template.md +145 -0
- package/templates/prd.template.md +327 -0
- package/templates/product-definition.template.md +168 -0
- package/templates/project-context.yaml +161 -0
|
@@ -0,0 +1,1010 @@
|
|
|
1
|
+
# /dev-gen-test — Generate Dev Self-Check Tests
|
|
2
|
+
|
|
3
|
+
> **Scope — dev self-check (smoke), not the official test suite.** These tests let the
|
|
4
|
+
> developer quickly verify their own generated code against the BDD scenarios. They are a
|
|
5
|
+
> developer self-check, **not** the QC/dev-team's authoritative test suite (that has its
|
|
6
|
+
> own separate flow, implemented elsewhere). Results surface to the Living Docs dashboard
|
|
7
|
+
> as a **dev self-test** signal so QC can see the dev already ran their own checks.
|
|
8
|
+
|
|
9
|
+
## Gate
|
|
10
|
+
# Gate — Universal Entry Procedure
|
|
11
|
+
|
|
12
|
+
Every command must execute this gate before proceeding with its specific logic.
|
|
13
|
+
|
|
14
|
+
## Step 0 — Sub-Agent Mode Check
|
|
15
|
+
|
|
16
|
+
Before anything else, check if `$ARGUMENTS` is a JSON payload from an orchestrator:
|
|
17
|
+
|
|
18
|
+
1. Attempt to parse `$ARGUMENTS` as JSON.
|
|
19
|
+
2. If it parses successfully **and** contains `"_agent_mode": true`:
|
|
20
|
+
- **Skip Steps 1, 2, and 3 of this Gate entirely.**
|
|
21
|
+
- Set target file = `payload.target_file`
|
|
22
|
+
- Set loaded context = `payload.context` (do NOT run context-loader.md)
|
|
23
|
+
- Set UC scope = `payload.uc_id` (process only this UC)
|
|
24
|
+
- Set line range = `payload.uc_section` (read only that PRD section)
|
|
25
|
+
- Proceed directly to the command-specific logic.
|
|
26
|
+
3. If `$ARGUMENTS` is not JSON or `_agent_mode` is absent → continue to Step 1 (normal mode).
|
|
27
|
+
|
|
28
|
+
## Step 0-B — Model Check
|
|
29
|
+
|
|
30
|
+
*Skip this step if `_agent_mode: true` (sub-agent — orchestrator already validated).*
|
|
31
|
+
|
|
32
|
+
Complex generation and review commands require strong reasoning.
|
|
33
|
+
Using a smaller model risks missed edge cases, incomplete spec analysis, and architecture violations.
|
|
34
|
+
|
|
35
|
+
Display and wait for response:
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
⚙️ MODEL CHECK
|
|
39
|
+
──────────────────────────────────────────────────────────────────
|
|
40
|
+
Recommended : claude-opus-4 (or latest Opus model)
|
|
41
|
+
Why needed : Spec analysis, architecture review, code generation
|
|
42
|
+
require deep reasoning. Smaller models miss edge cases.
|
|
43
|
+
|
|
44
|
+
To switch in Claude Code:
|
|
45
|
+
• Settings → Model → select "claude-opus"
|
|
46
|
+
• or: /model → choose claude-opus
|
|
47
|
+
|
|
48
|
+
Running on claude-opus?
|
|
49
|
+
Y — yes, on claude-opus → proceed
|
|
50
|
+
S — skip check (I accept lower quality risk with current model)
|
|
51
|
+
──────────────────────────────────────────────────────────────────
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
- "Y" → proceed to Step 1.
|
|
55
|
+
- "S" → proceed to Step 1 (user accepts risk, add ⚠️ to final report).
|
|
56
|
+
- "N" or anything else → **STOP.** Output: "Please switch to claude-opus, then re-run this command."
|
|
57
|
+
|
|
58
|
+
## Step 1 — Resolve Target File
|
|
59
|
+
|
|
60
|
+
1. If `$ARGUMENTS` is provided and points to an existing file → use it directly as the target.
|
|
61
|
+
2. If `$ARGUMENTS` is a **bare UC-ID / ticket ID / partial name** (no path) → resolve it to a file by globbing the feature-package layout. The `{prd-slug}` is **not known yet**, so use a `*` wildcard for that segment, and a recursive `**` under `bdd/` so the platform subfolders (`bdd/web/`, `bdd/app/`, `bdd/system/`) are all covered:
|
|
62
|
+
- **BDD commands** (target is a `.feature`): `{specs_dir}/{domain}/*/bdd/**/{UC-ID}*.feature` — or `{specs_dir}/*/*/bdd/**/{UC-ID}*.feature` if the domain is also unknown. If a platform/scope is implied by the command (e.g. a system tech-doc needs the `system/` BDD), prefer the match under that platform subfolder.
|
|
63
|
+
- **PRD commands** (target is `prd.md`): `{specs_dir}/{domain}/*/prd.md` (match the feature folder whose id corresponds), else `{specs_dir}/*/*/prd.md`.
|
|
64
|
+
- **tech-docs commands**: `{specs_dir}/{domain}/*/tech-docs/{UC-ID}*-tech-design*.md`.
|
|
65
|
+
- **design-spec commands**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
66
|
+
|
|
67
|
+
Once a file matches: set it as the target **and** record `domain` + `prd_slug` from its path (per the extraction rule in `context-loader.md` Step 1 — `prd_slug` = first segment after `{specs_dir}/{domain}/`). Every path the command later reads or writes (sibling BDD/tech-docs/design-spec/trace) uses **that resolved `prd_slug`**, so all artifacts stay in one feature package. If several files match (e.g. multiple platforms), pick per the command's platform/scope or list them and ask.
|
|
68
|
+
3. If `$ARGUMENTS` is empty or no match found:
|
|
69
|
+
- List files in the relevant directory for this command (e.g., `specs/*/*/prd.md` for PRD commands, `specs/*/*/bdd/**/*.feature` for BDD commands).
|
|
70
|
+
- Present the list to the user and ask: "Which file do you want to work with? (Enter number or filename)"
|
|
71
|
+
- Wait for user selection before continuing.
|
|
72
|
+
|
|
73
|
+
## Step 2 — Execute Context Loader
|
|
74
|
+
|
|
75
|
+
Load all project context by following the procedure in `steps/context-loader.md`.
|
|
76
|
+
Store all loaded context in memory for use throughout this command session.
|
|
77
|
+
|
|
78
|
+
## Step 3 — CHECKPOINT
|
|
79
|
+
|
|
80
|
+
After completing Steps 1 and 2, display a summary and wait for confirmation:
|
|
81
|
+
|
|
82
|
+
```
|
|
83
|
+
CHECKPOINT
|
|
84
|
+
-----------
|
|
85
|
+
Target : {resolved file path}
|
|
86
|
+
Project : {project.name from project-context.yaml}
|
|
87
|
+
Tech stack : {language} / {framework}
|
|
88
|
+
Module : {module if set, else "not configured"}
|
|
89
|
+
Domains : {comma-separated domain list}
|
|
90
|
+
|
|
91
|
+
Proceed? (Y/N)
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Wait for explicit "Y" or "N" from the user before continuing.
|
|
95
|
+
- "Y" → proceed to the command-specific steps below.
|
|
96
|
+
- "N" → stop and ask what the user wants to change.
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
*Note: For this command, the target in Step 1 is a UC-ID or `.feature` file path. Find the feature file at `{paths.specs_dir}/{domain}/*/bdd/**/{UC-ID}-*.feature` (glob match across PRDs — filename includes slug suffix) and the implementation files tagged `@trace.implements={UC-ID}`.*
|
|
100
|
+
|
|
101
|
+
## Context
|
|
102
|
+
# Context Loader — Load All Project Context
|
|
103
|
+
|
|
104
|
+
Execute these steps in order. Store everything in memory for the duration of the command session.
|
|
105
|
+
|
|
106
|
+
**Priority guide (anti-lost-in-middle):**
|
|
107
|
+
- Steps 1–2 are PROJECT-CONFIG — loaded first, resolve all paths and metadata.
|
|
108
|
+
- Step 3 is CRITICAL — architecture + coding standards, the highest-priority facts for generation.
|
|
109
|
+
- Step 4 is SAFETY — data protection rules, enforced silently for the entire session.
|
|
110
|
+
- Steps 5–6 are DOMAIN KNOWLEDGE — terminology and entity definitions.
|
|
111
|
+
- Step 7 is the WORKING MEMORY RECAP — locks critical facts into the top of working memory.
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## Step 1 — [PROJECT-CONFIG] Load project-context.yaml
|
|
116
|
+
|
|
117
|
+
Read `.agent/project-context.yaml`. Extract and store:
|
|
118
|
+
|
|
119
|
+
**Tech Stack:**
|
|
120
|
+
- `tech_stack.language` → active language (e.g., Java 17, TypeScript, C#, Go)
|
|
121
|
+
- `tech_stack.framework` → active framework (e.g., Spring Boot 3.2, Angular 17, .NET 8)
|
|
122
|
+
- `tech_stack.build_tool` → build tool (e.g., Maven, npm, dotnet, go)
|
|
123
|
+
- `tech_stack.test_framework` → test framework (e.g., JUnit 5 + Mockito, Jest, xUnit)
|
|
124
|
+
- `tech_stack.database` → database (e.g., PostgreSQL, MySQL, MongoDB)
|
|
125
|
+
- `tech_stack.module` → active module profile (e.g., java-spring, angular, dotnet, golang, context-engineering)
|
|
126
|
+
|
|
127
|
+
**Conventions:**
|
|
128
|
+
- `conventions.build_command` → how to compile/build
|
|
129
|
+
- `conventions.test_command` → how to run tests
|
|
130
|
+
- `conventions.service_run` → how to start the service
|
|
131
|
+
- `conventions.ticket_prefix` → ticket ID prefix (e.g., PROJ, FEAT, UC)
|
|
132
|
+
|
|
133
|
+
**Domains:**
|
|
134
|
+
- `domains` → list of active business domains
|
|
135
|
+
|
|
136
|
+
**Paths (if present):**
|
|
137
|
+
- `paths.specs_dir` → spec artifacts root — PRD, BDD, tech-docs, design-spec. Structure: `{specs_dir}/{domain}/{prd-slug}/{prd.md | bdd/ | tech-docs/ | design-spec/}`
|
|
138
|
+
- `paths.refinement_dir` → findings/review output dir
|
|
139
|
+
- `paths.qc_dir` → QC automation artifacts root (visible top-level, one subfolder per UC: `{qc_dir}/{UC-ID}/`)
|
|
140
|
+
- `paths.qc_skills_dir` → where qc-* commands load QC skills from (default bundled `.agent/skills/qc`; override to the QC team's own repo/submodule so framework upgrade won't overwrite them)
|
|
141
|
+
- `paths.product_definitions_dir` → product definitions root
|
|
142
|
+
- `paths.domain_knowledge_dir` → domain knowledge root
|
|
143
|
+
- `paths.business_dictionary` → path to business-dictionary.md
|
|
144
|
+
- `paths.core_entities` → path to core-entities.md
|
|
145
|
+
- `paths.tech_docs_dir` → technical documentation root (merged with specs_dir in feature-package layout — tech-docs live under `{specs_dir}/{domain}/{prd-slug}/tech-docs/`)
|
|
146
|
+
- `paths.trace_dir` → trace state directory; structure: `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`
|
|
147
|
+
|
|
148
|
+
If `paths` section is absent, use these defaults:
|
|
149
|
+
- `specs_dir` = `specs`
|
|
150
|
+
- `refinement_dir` = `.agent/review`
|
|
151
|
+
- `qc_dir` = `docs`
|
|
152
|
+
- `qc_skills_dir` = `.agent/skills/qc`
|
|
153
|
+
- `product_definitions_dir` = `specs/product-definition`
|
|
154
|
+
- `domain_knowledge_dir` = `specs/domain-knowledge`
|
|
155
|
+
- `business_dictionary` = `specs/domain-knowledge/business-dictionary.md`
|
|
156
|
+
- `core_entities` = `specs/domain-knowledge/core-entities.md`
|
|
157
|
+
- `tech_docs_dir` = `specs`
|
|
158
|
+
- `trace_dir` = `.trace`
|
|
159
|
+
|
|
160
|
+
Note: In the feature-package layout, `specs_dir` is the unified root. All spec artifact types (PRD, BDD, tech-docs, design-spec) live under `{specs_dir}/{domain}/{prd-slug}/`. The `prd-slug` is the feature-package folder name, not a separate config variable.
|
|
161
|
+
|
|
162
|
+
**How to extract `prd_slug` (works for ANY target file, regardless of nesting depth):** given a target path of the form `{specs_dir}/{domain}/{prd-slug}/...`, take the **first path segment after `{specs_dir}/{domain}/`** — i.e. the `{prd-slug}` position. Do NOT use the file's immediate parent folder, because BDD/tech-docs/design-spec artifacts are nested one or two levels deeper inside the package. Examples:
|
|
163
|
+
- `specs/payment/create-invoice/prd.md` → `prd_slug = create-invoice`
|
|
164
|
+
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(NOT `system`)*
|
|
165
|
+
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(NOT `web`)*
|
|
166
|
+
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(NOT `tech-docs`)*
|
|
167
|
+
- `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
|
|
168
|
+
|
|
169
|
+
All sibling artifacts of one feature (PRD, every platform's BDD, the BE + FE tech-docs, the design-spec, and the trace TSV) therefore resolve to the **same `prd_slug`** — so a synthesized **system** BDD or **system/BE** tech-doc lands in the same `{specs_dir}/{domain}/{prd-slug}/` package as the web/app artifacts it was derived from.
|
|
170
|
+
|
|
171
|
+
If `tech_stack.module` is set, also load `.agent/modules/{module}/stack-profile.yaml` if it exists.
|
|
172
|
+
|
|
173
|
+
---
|
|
174
|
+
|
|
175
|
+
## Step 1.5 — [SERVICE ROUTING] Resolve service paths (umbrella mode)
|
|
176
|
+
|
|
177
|
+
*Skip this step entirely if `setup.mode` is not `"umbrella"` and `services` section is absent from project-context.yaml.*
|
|
178
|
+
|
|
179
|
+
If `services` section is present:
|
|
180
|
+
|
|
181
|
+
**1. Detect active domain** (in priority order):
|
|
182
|
+
- Read `@trace.domain` from target file frontmatter (if Gate loaded a target file)
|
|
183
|
+
- Extract from target file path: `domain` = the first segment after the `specs_dir` base path; `prd_slug` = the next segment (the feature-package folder). This holds for any target depth — see the `prd_slug` extraction rule in Step 1.
|
|
184
|
+
*(e.g., `specs/user/create-account/prd.md` **and** `specs/user/create-account/bdd/system/UC1.feature` both → domain = `user`, prd_slug = `create-account`)*
|
|
185
|
+
- If `$ARGUMENTS` contains a path, extract the domain segment after `specs_dir`
|
|
186
|
+
|
|
187
|
+
**2. Route to service** — if active domain matches a key in `services`:
|
|
188
|
+
- Override `paths.specs_dir` → `services.{domain}.specs_dir` — **only if `setup.spec_source` is NOT set.** When `spec_source` IS set, ALL BDD (web/app/**system**) is a shared cross-team artifact → leave `specs_dir` for step 4 to route to the spec repo; do NOT pin it per-service here.
|
|
189
|
+
- Override `paths.tech_docs_dir` → `services.{domain}.tech_docs_dir` — **only if `setup.spec_source` is NOT set.** When `spec_source` IS set, the tech-design (API contract) is a cross-team artifact and must live in the shared spec repo (handled in step 4), so leave `tech_docs_dir` for step 4 to route — do NOT pin it per-service here.
|
|
190
|
+
- Store `active_service` = `services.{domain}.path`
|
|
191
|
+
- Store `active_service_module` = `services.{domain}.module`
|
|
192
|
+
- If service has its own `module` → use it as `active_module` (overrides `tech_stack.module`)
|
|
193
|
+
|
|
194
|
+
**3. Fallback** — if domain not detected or no matching service key:
|
|
195
|
+
- Keep default paths from Step 1
|
|
196
|
+
- Set `active_service = unresolved`
|
|
197
|
+
|
|
198
|
+
**4. Spec source auto-override** — if `setup.spec_source` is set AND the corresponding path was not already explicitly set in `paths:`:
|
|
199
|
+
- Override `paths.specs_dir` → `{spec_source}/specs` — **always when `spec_source` is set.** All spec artifacts (PRD, BDD, tech-docs, design-spec) live under the unified spec root in the shared spec repo using the feature-package layout: `{spec_source}/specs/{domain}/{prd-slug}/`. Every umbrella (FE/App/BE) reads from here. *(Per-service `specs/` only when there is no `spec_source`.)*
|
|
200
|
+
- Override `paths.tech_docs_dir` → `{spec_source}/specs` — **always when `spec_source` is set** (step 2 no longer pins tech-docs per-service in this case). Tech-docs live at `{spec_source}/specs/{domain}/{prd-slug}/tech-docs/`. The tech-design IS the cross-team API contract: BE authors it here, and FE/App read it from the same spec submodule at `/generate-code --phase=integration`. *(Per-service tech-docs only happen when there is no `spec_source` — a pure multi-service BE repo with no shared spec module.)*
|
|
201
|
+
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
202
|
+
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
203
|
+
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
204
|
+
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
205
|
+
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
206
|
+
- Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
|
|
207
|
+
- Override `paths.trace_dir` → `{spec_source}/.trace` — **always when `spec_source` is set.** Trace TSVs are consolidated in the spec repo (single authoritative location, no per-service split) so the PM/PO has one place to manage status. Internal structure: `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`. Code-side commands (`/generate-code`, `/dev-run-test`, `/qc-run-test`) run from `service_root` but **write their trace row into `{spec_source}/.trace/{domain}/{prd-slug}/`** — like they already push `feedback/` there. *(Per-service `.trace` only when there is no `spec_source`.)*
|
|
208
|
+
|
|
209
|
+
> **Why under `spec_source`:** PRD, BDD, tech-docs, design-spec, domain knowledge, tester feedback, **and the `.trace/` coverage state** are all **cross-team artifacts** — they live in the **shared spec repo** using the feature-package layout so every umbrella (FE/App/BE) and the PM read one source via `/sync`. In the feature-package layout, a single `specs/{domain}/{prd-slug}/` folder groups all artifact types for one PRD, making the spec repo self-contained and navigable by feature. The service submodule holds only **code** (+ build/test tooling). `.trace/` and `feedback/` are the dev/QC **write areas** in the spec repo. In single-service mode (no `spec_source`), everything defaults under the repo root — still one repo.
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
## Step 1.6 — [SERVICE CONVENTIONS] Load service-specific conventions (umbrella mode)
|
|
214
|
+
|
|
215
|
+
*Skip this step entirely if `active_service` is `"unresolved"` or context is single-service mode.*
|
|
216
|
+
|
|
217
|
+
When `active_service` has been resolved to a real path in Step 1.5 (e.g., `user-service/`):
|
|
218
|
+
|
|
219
|
+
**1. Locate service config** — try in priority order:
|
|
220
|
+
- `{active_service}/.agent/project-context.yaml`
|
|
221
|
+
- `{active_service}/project-context.yaml`
|
|
222
|
+
|
|
223
|
+
**2. If found, override with service-specific values:**
|
|
224
|
+
|
|
225
|
+
| Variable | Source |
|
|
226
|
+
|----------|--------|
|
|
227
|
+
| `conventions.test_command` | service's `conventions.test_command` |
|
|
228
|
+
| `conventions.build_command` | service's `conventions.build_command` |
|
|
229
|
+
| `paths.trace_dir` | **If `spec_source` is set → keep the Step 4 spec-repo route (`{spec_source}/.trace`); ignore any service-level `trace_dir`.** Only when there is no `spec_source`: `{active_service}/{service paths.trace_dir}` (default `{active_service}/.trace`). |
|
|
230
|
+
| `paths.specs_dir` | **If `spec_source` is set → keep the Step 4 spec-repo route (`{spec_source}/specs`); ignore any service-level `specs_dir`** (all spec artifacts are cross-team, never per-service in this mode). Only when there is no `spec_source`: `{active_service}/{service paths.specs_dir}` if set, else the Step 1.5 override. |
|
|
231
|
+
|
|
232
|
+
**3. Store** `service_root = {active_service}` as the working directory anchor for all downstream commands:
|
|
233
|
+
- Shell commands (`/dev-run-test`, `/dev-gen-test`) run **from within** `service_root`
|
|
234
|
+
- **Source/test files** are written relative to `service_root`; **trace TSVs** are written to `{paths.trace_dir}` (the spec repo when `spec_source` is set — a cross-repo write, committed/pushed to the spec submodule like `feedback/`).
|
|
235
|
+
|
|
236
|
+
**4. If service config not found** — keep umbrella defaults, still set `service_root = {active_service}` (path anchor is always needed even without a config override).
|
|
237
|
+
|
|
238
|
+
---
|
|
239
|
+
|
|
240
|
+
## Step 2 — [PROJECT-CONFIG] Load module stack profile (conditional)
|
|
241
|
+
|
|
242
|
+
If `tech_stack.module` is set, read `.agent/modules/{module}/stack-profile.yaml`.
|
|
243
|
+
Merge framework-specific conventions (layer patterns, test patterns, naming rules) into the loaded context.
|
|
244
|
+
If the file does not exist → skip silently.
|
|
245
|
+
|
|
246
|
+
---
|
|
247
|
+
|
|
248
|
+
## Step 3 — [CRITICAL] Load CLAUDE.md (layered: root + service overlay)
|
|
249
|
+
|
|
250
|
+
*This is the highest-priority context — it defines HOW to write code and documents for this project.*
|
|
251
|
+
|
|
252
|
+
CLAUDE.md is loaded in **two layers** so umbrella-wide rules and service-specific
|
|
253
|
+
architecture/coding standards compose correctly. The agent always sits at the umbrella
|
|
254
|
+
root, but the implementation code lives in a service submodule with its OWN stack,
|
|
255
|
+
architecture, and conventions — so the service's CLAUDE.md must win for code generation.
|
|
256
|
+
|
|
257
|
+
**Layer 1 — [BASE] Root CLAUDE.md (umbrella-wide).**
|
|
258
|
+
Read `CLAUDE.md` at the repo root. Treat its contents as the **shared baseline** for the
|
|
259
|
+
whole umbrella — git conventions, data-protection posture, cross-cutting rules, and (in
|
|
260
|
+
single-service mode) the project's only architecture + coding standards.
|
|
261
|
+
|
|
262
|
+
**Layer 2 — [OVERLAY] Service CLAUDE.md (umbrella mode only).**
|
|
263
|
+
*Run only if `service_root` was set in Step 1.6 (i.e. a real service was routed to).*
|
|
264
|
+
Read `{service_root}/CLAUDE.md`. This file defines the architecture + coding standards of
|
|
265
|
+
the **actual stack being implemented** (e.g. `user-service` = java-spring, `web` = nextjs).
|
|
266
|
+
Overlay it on top of Layer 1: **on any conflict, the service value WINS** for architecture,
|
|
267
|
+
coding standards, and error handling. Layer-1 values that the service does not redefine
|
|
268
|
+
(e.g. git conventions, banned patterns shared org-wide) remain in effect.
|
|
269
|
+
|
|
270
|
+
From the **merged** result, extract and store:
|
|
271
|
+
|
|
272
|
+
- **§1 Project Overview** → project name, language, framework, build/test commands, domains
|
|
273
|
+
- **§2 Architecture** → layer order (e.g., Controller → Facade → Service → Repository), architectural rules — *service overlay wins*
|
|
274
|
+
- **§3 Coding Standards** → naming conventions (classes, methods), response wrapper type, forbidden patterns — *service overlay wins*
|
|
275
|
+
- **§5 Error Handling** → exception types, HTTP status code mapping, not-found exception class name — *service overlay wins*
|
|
276
|
+
- **§7 Git Conventions** → branch naming pattern, commit message format — *root baseline unless service redefines*
|
|
277
|
+
|
|
278
|
+
**Resolution rules:**
|
|
279
|
+
- If both layers exist → merge as above; record `claude_md_source = root + {service_root}`.
|
|
280
|
+
- If only the service overlay exists (no root CLAUDE.md) → use the service file alone; `claude_md_source = {service_root}`.
|
|
281
|
+
- If `service_root` is set but `{service_root}/CLAUDE.md` is **missing** → fall back to root CLAUDE.md and flag ⚠️ in the Step 7 recap (the service has no architecture/coding-standards definition — code generation will use umbrella defaults, which may be the wrong stack).
|
|
282
|
+
- If neither exists → note CLAUDE.md as missing and continue with project-context.yaml data only.
|
|
283
|
+
|
|
284
|
+
---
|
|
285
|
+
|
|
286
|
+
## Step 4 — [SAFETY] Load Data Protection Rules
|
|
287
|
+
|
|
288
|
+
Read `.agent/rules/data-protection.md` (or `rules/data-protection.md` from the framework installation).
|
|
289
|
+
|
|
290
|
+
Store the sensitive file patterns — you must **never** read, write, display, or reference content from files matching those patterns for the entire session.
|
|
291
|
+
|
|
292
|
+
If neither file exists → apply built-in defaults: never access `.env*`, `*.key`, `*.pem`, `*secret*`, `*password*`, `*credential*`.
|
|
293
|
+
|
|
294
|
+
---
|
|
295
|
+
|
|
296
|
+
## Step 5 — [DOMAIN] Load Business Dictionary (conditional)
|
|
297
|
+
|
|
298
|
+
Check if the business dictionary file exists (use `paths.business_dictionary` resolved in Step 1).
|
|
299
|
+
|
|
300
|
+
If it exists, read it and extract:
|
|
301
|
+
- **Canonical Terms** → complete list of approved terms and their definitions
|
|
302
|
+
- **Banned Terms** → complete list of banned terms and their canonical replacements
|
|
303
|
+
- **Status / Enum Registry** → allowed enum values per entity
|
|
304
|
+
|
|
305
|
+
Store the banned terms list for **active enforcement** throughout the command session:
|
|
306
|
+
- When generating any text (PRD, BDD, code comments, tech docs), verify no banned terms appear
|
|
307
|
+
- Replace banned terms with their canonical equivalents automatically
|
|
308
|
+
|
|
309
|
+
If the file does not exist → skip silently. Do not warn or block.
|
|
310
|
+
|
|
311
|
+
---
|
|
312
|
+
|
|
313
|
+
## Step 6 — [DOMAIN] Load Core Entities (conditional)
|
|
314
|
+
|
|
315
|
+
Check if the core entities file exists at `paths.core_entities` (resolved in Step 1).
|
|
316
|
+
Default path: `specs/domain-knowledge/core-entities.md`.
|
|
317
|
+
|
|
318
|
+
If it exists, read it and store:
|
|
319
|
+
- **Entity catalog** → for each entity: its name, purpose, owner service, key fields (name + type), business invariants, and relationships
|
|
320
|
+
- **Field name registry** → canonical field names to use in generated code and documents
|
|
321
|
+
- **Relationship map** → how entities relate to each other (1:N, N:N, embedded, etc.)
|
|
322
|
+
|
|
323
|
+
**How to use this catalog:**
|
|
324
|
+
- When generating code: use the field names, types, and relationships defined here — do NOT infer from existing code
|
|
325
|
+
- When generating PRD/BDD: reference entity names from this catalog for consistency
|
|
326
|
+
- When generating tech-docs: use this catalog as the source-of-truth for entity definitions
|
|
327
|
+
|
|
328
|
+
If the file does not exist → skip silently.
|
|
329
|
+
|
|
330
|
+
---
|
|
331
|
+
|
|
332
|
+
## Step 6.5 — [PLATFORM] Derive active_module and platform_type
|
|
333
|
+
|
|
334
|
+
Using `tech_stack.module` loaded in Step 1, derive and store two variables for use by all downstream commands:
|
|
335
|
+
|
|
336
|
+
```
|
|
337
|
+
active_module = tech_stack.module (e.g. "java-spring", "react", "flutter")
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
| `platform_type` | Modules |
|
|
341
|
+
|---|---|
|
|
342
|
+
| `backend` | `java-spring`, `golang`, `dotnet`, `php-laravel`, `context-engineering` |
|
|
343
|
+
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
|
|
344
|
+
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
345
|
+
|
|
346
|
+
If `tech_stack.module` is blank or not recognized → set `platform_type = "unknown"` and flag as ⚠️ in the Step 7 recap.
|
|
347
|
+
|
|
348
|
+
These two variables (`active_module`, `platform_type`) are the canonical source for all branching logic in commands that need platform-specific behavior (dev-gen-test, debug, fix-bug, dev-smoke-test).
|
|
349
|
+
|
|
350
|
+
---
|
|
351
|
+
|
|
352
|
+
## Step 6.7 — [GUARDRAILS] Load Project Lessons (conditional)
|
|
353
|
+
|
|
354
|
+
*Accumulated mistakes the AI must not repeat in this project. These are added over time via `/learn`
|
|
355
|
+
or accepted during `/review-code`, `/fix-bug`, `/debug`.*
|
|
356
|
+
|
|
357
|
+
Resolve the lessons file path:
|
|
358
|
+
- Use `paths.lessons_file` if set (may be service-overridden in umbrella mode, Step 1.6)
|
|
359
|
+
- Else default `specs/domain-knowledge/lessons-learned.md`
|
|
360
|
+
- In umbrella/service mode (when `service_root` is set), if `paths.lessons_file` is unset, default to `{service_root}/.agent/project-lessons.md`
|
|
361
|
+
|
|
362
|
+
If the file exists, read it and store ALL lessons as **ACTIVE GUARDRAILS** for the session:
|
|
363
|
+
- Treat each lesson's **Rule** as a hard constraint — same priority as CLAUDE.md coding standards (Step 3).
|
|
364
|
+
- Before generating or modifying any artifact (PRD, BDD, tech-doc, code, test), check the output against every lesson whose `category` matches the current command AND whose `scope` matches the target (domain / file).
|
|
365
|
+
- If a generated output would violate a lesson → correct it **before** presenting, and note which lesson (`L-NNN`) was applied.
|
|
366
|
+
|
|
367
|
+
If the file does not exist → skip silently (no lessons captured yet).
|
|
368
|
+
|
|
369
|
+
---
|
|
370
|
+
|
|
371
|
+
## Step 7 — [RECAP] Working Memory Recap (anti-lost-in-middle)
|
|
372
|
+
|
|
373
|
+
After loading all context, synthesize and output a compact summary block.
|
|
374
|
+
This recap ensures the most critical facts are stated at the END of context loading
|
|
375
|
+
(recency effect — freshest in working memory when the task begins).
|
|
376
|
+
|
|
377
|
+
Output exactly this block:
|
|
378
|
+
```
|
|
379
|
+
[CTX LOADED]
|
|
380
|
+
Stack : {language} / {framework} / {database}
|
|
381
|
+
Platform : {active_module} ({platform_type})
|
|
382
|
+
Layers : {layer order from merged CLAUDE.md §2, e.g., Controller → Facade → Service → Repository}
|
|
383
|
+
CLAUDE.md : {root + {service_root} | {service_root} only | root only | ⚠️ service overlay MISSING — using root | missing}
|
|
384
|
+
Ticket : {ticket_prefix}-
|
|
385
|
+
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
386
|
+
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
387
|
+
Lessons : {loaded — N guardrails | none yet}
|
|
388
|
+
Service : {active_service} ({active_service_module}) | single-service
|
|
389
|
+
Svc Root : {service_root} — conventions + trace_dir loaded from service config | —
|
|
390
|
+
Status : {FULL | PARTIAL — missing: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
391
|
+
```
|
|
392
|
+
|
|
393
|
+
If any CRITICAL file is missing (CLAUDE.md), flag it clearly so the user can decide whether to proceed.
|
|
394
|
+
|
|
395
|
+
---
|
|
396
|
+
|
|
397
|
+
## Context Load Complete
|
|
398
|
+
|
|
399
|
+
After completing all steps, you have loaded:
|
|
400
|
+
- Project identity, tech stack, module conventions
|
|
401
|
+
- Architecture rules and layer order ← **[CRITICAL — hold in working memory]**
|
|
402
|
+
- Coding standards and naming conventions ← **[CRITICAL — hold in working memory]**
|
|
403
|
+
- Data protection rules (sensitive file patterns to never access)
|
|
404
|
+
- Terminology rules with banned-term list ← **[DOMAIN — apply to every generated word]**
|
|
405
|
+
- Entity catalog (field names, types, invariants) ← **[DOMAIN — use for code generation]**
|
|
406
|
+
- All configured paths
|
|
407
|
+
|
|
408
|
+
Proceed to the next step of the calling command.
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
---
|
|
412
|
+
|
|
413
|
+
## Service Detection
|
|
414
|
+
|
|
415
|
+
Read `@trace.service` and `@trace.module` from the feature file header.
|
|
416
|
+
|
|
417
|
+
| Condition | Action |
|
|
418
|
+
|---|---|
|
|
419
|
+
| `@trace.module` present | Use as `active_module` |
|
|
420
|
+
| `@trace.module` absent | Use `tech_stack.module` from project-context.yaml |
|
|
421
|
+
| `@trace.service` present | Store as `active_service` |
|
|
422
|
+
| `@trace.service` absent | Use `{UC-ID}` domain as fallback |
|
|
423
|
+
|
|
424
|
+
**Platform type classification:**
|
|
425
|
+
|
|
426
|
+
| Platform | Modules |
|
|
427
|
+
|---|---|
|
|
428
|
+
| `backend` | `java-spring`, `golang`, `dotnet`, `php-laravel`, `context-engineering` |
|
|
429
|
+
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
|
|
430
|
+
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
431
|
+
|
|
432
|
+
---
|
|
433
|
+
|
|
434
|
+
## CHECKPOINT — Test Plan
|
|
435
|
+
|
|
436
|
+
Before generating, scan the feature file for scenarios and the implementation files for classes/functions. Display:
|
|
437
|
+
|
|
438
|
+
```
|
|
439
|
+
Test Plan — {UC-ID} ({active_module})
|
|
440
|
+
──────────────────────────────────────
|
|
441
|
+
Platform : {backend | web-frontend | mobile}
|
|
442
|
+
Scenarios : {N} scenarios from .feature file
|
|
443
|
+
Impl files : {list of files tagged @trace.implements={UC-ID}}
|
|
444
|
+
|
|
445
|
+
Tests to generate:
|
|
446
|
+
{platform-specific list — see templates below}
|
|
447
|
+
|
|
448
|
+
Proceed? (Y/N)
|
|
449
|
+
```
|
|
450
|
+
|
|
451
|
+
Wait for explicit "Y" before generating.
|
|
452
|
+
|
|
453
|
+
---
|
|
454
|
+
|
|
455
|
+
## Generate
|
|
456
|
+
|
|
457
|
+
### If `platform_type = backend`
|
|
458
|
+
|
|
459
|
+
#### java-spring
|
|
460
|
+
|
|
461
|
+
```java
|
|
462
|
+
// @trace.verifies={UC-ID}
|
|
463
|
+
// @trace.service={active_service}
|
|
464
|
+
// @trace.test_type=unit
|
|
465
|
+
class {Resource}ServiceImplTest {
|
|
466
|
+
@Mock {Repository} {repository};
|
|
467
|
+
@InjectMocks {Resource}ServiceImpl service;
|
|
468
|
+
|
|
469
|
+
// methodName_whenValid_shouldReturnExpected()
|
|
470
|
+
// Given — mock repository returns data
|
|
471
|
+
// When — call service method
|
|
472
|
+
// Then — assert result matches expected
|
|
473
|
+
|
|
474
|
+
// methodName_whenNotFound_shouldThrowException()
|
|
475
|
+
// Given — mock returns Optional.empty()
|
|
476
|
+
// When & Then — assertThrows({NotFoundException}.class, ...)
|
|
477
|
+
}
|
|
478
|
+
|
|
479
|
+
// @trace.verifies={UC-ID}
|
|
480
|
+
// @trace.service={active_service}
|
|
481
|
+
// @trace.test_type=integration
|
|
482
|
+
@WebMvcTest({Resource}Controller.class)
|
|
483
|
+
class {Resource}ControllerTest {
|
|
484
|
+
@MockBean {Facade | Service} facade;
|
|
485
|
+
|
|
486
|
+
// endpoint_shouldReturn200WhenValid()
|
|
487
|
+
// endpoint_shouldReturn400WhenInvalid()
|
|
488
|
+
// endpoint_shouldReturn404WhenNotFound()
|
|
489
|
+
// endpoint_shouldReturn401WhenUnauthenticated()
|
|
490
|
+
}
|
|
491
|
+
```
|
|
492
|
+
|
|
493
|
+
Rules:
|
|
494
|
+
- Unit tests: mock at Repository layer, test Service logic
|
|
495
|
+
- Integration tests: mock at Facade/Service layer, test HTTP contract only
|
|
496
|
+
- Never mock the class under test
|
|
497
|
+
- Follow naming: `methodName_whenCondition_shouldOutcome` (from CLAUDE.md §6)
|
|
498
|
+
|
|
499
|
+
#### golang
|
|
500
|
+
|
|
501
|
+
```go
|
|
502
|
+
// @trace.verifies={UC-ID}
|
|
503
|
+
// Unit: table-driven tests for service layer
|
|
504
|
+
func Test{Resource}Service_{Method}(t *testing.T) {
|
|
505
|
+
tests := []struct {
|
|
506
|
+
name string
|
|
507
|
+
input {InputType}
|
|
508
|
+
want {OutputType}
|
|
509
|
+
wantErr bool
|
|
510
|
+
}{
|
|
511
|
+
{"valid input", ..., ..., false},
|
|
512
|
+
{"not found", ..., nil, true},
|
|
513
|
+
}
|
|
514
|
+
for _, tt := range tests {
|
|
515
|
+
t.Run(tt.name, func(t *testing.T) { ... })
|
|
516
|
+
}
|
|
517
|
+
}
|
|
518
|
+
|
|
519
|
+
// @trace.verifies={UC-ID}
|
|
520
|
+
// Integration: HTTP handler tests using httptest
|
|
521
|
+
func Test{Resource}Handler_{Endpoint}(t *testing.T) {
|
|
522
|
+
// setup router, mock service, fire request
|
|
523
|
+
// assert status code and response body
|
|
524
|
+
}
|
|
525
|
+
```
|
|
526
|
+
|
|
527
|
+
#### dotnet
|
|
528
|
+
|
|
529
|
+
```csharp
|
|
530
|
+
// @trace.verifies={UC-ID}
|
|
531
|
+
// Unit: xUnit + Moq
|
|
532
|
+
public class {Resource}ServiceTests {
|
|
533
|
+
private readonly Mock<I{Repository}> _repoMock = new();
|
|
534
|
+
private readonly {Resource}Service _sut;
|
|
535
|
+
|
|
536
|
+
[Fact]
|
|
537
|
+
public async Task {Method}_WhenValid_Returns{Expected}() { }
|
|
538
|
+
|
|
539
|
+
[Fact]
|
|
540
|
+
public async Task {Method}_WhenNotFound_ThrowsNotFoundException() { }
|
|
541
|
+
}
|
|
542
|
+
|
|
543
|
+
// @trace.verifies={UC-ID}
|
|
544
|
+
// Integration: WebApplicationFactory
|
|
545
|
+
public class {Resource}ControllerTests : IClassFixture<WebApplicationFactory<Program>> {
|
|
546
|
+
[Fact]
|
|
547
|
+
public async Task {Endpoint}_Returns200_WhenValid() { }
|
|
548
|
+
|
|
549
|
+
[Fact]
|
|
550
|
+
public async Task {Endpoint}_Returns400_WhenInvalid() { }
|
|
551
|
+
}
|
|
552
|
+
```
|
|
553
|
+
|
|
554
|
+
#### php-laravel
|
|
555
|
+
|
|
556
|
+
```php
|
|
557
|
+
// @trace.verifies={UC-ID}
|
|
558
|
+
// Unit: PHPUnit
|
|
559
|
+
class {Resource}ServiceTest extends TestCase {
|
|
560
|
+
public function test_{method}_when_valid_should_return_expected(): void { }
|
|
561
|
+
public function test_{method}_when_not_found_should_throw(): void { }
|
|
562
|
+
}
|
|
563
|
+
|
|
564
|
+
// @trace.verifies={UC-ID}
|
|
565
|
+
// Feature: Laravel HTTP tests
|
|
566
|
+
class {Resource}ControllerTest extends TestCase {
|
|
567
|
+
use RefreshDatabase;
|
|
568
|
+
public function test_{endpoint}_returns_200_when_valid(): void {
|
|
569
|
+
$response = $this->getJson('/api/{resource}');
|
|
570
|
+
$response->assertStatus(200)->assertJsonStructure([...]);
|
|
571
|
+
}
|
|
572
|
+
}
|
|
573
|
+
```
|
|
574
|
+
|
|
575
|
+
#### context-engineering
|
|
576
|
+
|
|
577
|
+
Check `tech_stack.language` from project-context.yaml to select the correct test syntax:
|
|
578
|
+
|
|
579
|
+
**If language = Python** (default):
|
|
580
|
+
|
|
581
|
+
```python
|
|
582
|
+
# @trace.verifies={UC-ID}
|
|
583
|
+
# @trace.test_type=unit
|
|
584
|
+
# Unit: test prompt orchestration functions
|
|
585
|
+
|
|
586
|
+
import pytest
|
|
587
|
+
from unittest.mock import patch, MagicMock
|
|
588
|
+
|
|
589
|
+
class Test{Resource}Prompt:
|
|
590
|
+
# test_{function}_when_valid_input_should_return_expected_output()
|
|
591
|
+
# Given — mock LLM client returns controlled response
|
|
592
|
+
# When — call prompt function with valid input
|
|
593
|
+
# Then — assert output matches expected structure/content
|
|
594
|
+
|
|
595
|
+
# test_{function}_when_llm_unavailable_should_raise()
|
|
596
|
+
# Given — mock LLM client raises connection error
|
|
597
|
+
# When & Then — assert specific exception is raised
|
|
598
|
+
|
|
599
|
+
# test_{function}_trace_assertions()
|
|
600
|
+
# Given — run function with trace capture enabled
|
|
601
|
+
# Then — assert @trace.implements tag present in function definition
|
|
602
|
+
# assert output conforms to expected schema
|
|
603
|
+
|
|
604
|
+
def test_{function}_when_valid_should_return_expected(self, mock_llm):
|
|
605
|
+
# Arrange
|
|
606
|
+
mock_llm.complete.return_value = "{expected response}"
|
|
607
|
+
# Act
|
|
608
|
+
result = {function}(input={test_input})
|
|
609
|
+
# Assert
|
|
610
|
+
assert result == {expected_output}
|
|
611
|
+
mock_llm.complete.assert_called_once_with(...)
|
|
612
|
+
|
|
613
|
+
def test_{function}_when_invalid_input_should_raise(self):
|
|
614
|
+
with pytest.raises({ExpectedError}):
|
|
615
|
+
{function}(input=None)
|
|
616
|
+
```
|
|
617
|
+
|
|
618
|
+
**If language = TypeScript / JavaScript** (Node.js LangChain.js, etc.):
|
|
619
|
+
|
|
620
|
+
```typescript
|
|
621
|
+
// @trace.verifies={UC-ID}
|
|
622
|
+
// @trace.test_type=unit
|
|
623
|
+
import { jest } from '@jest/globals'
|
|
624
|
+
|
|
625
|
+
describe('{Resource}Prompt', () => {
|
|
626
|
+
const mockLlm = { complete: jest.fn() }
|
|
627
|
+
|
|
628
|
+
it('{scenario description}', async () => {
|
|
629
|
+
mockLlm.complete.mockResolvedValue('{expected response}')
|
|
630
|
+
const result = await {function}({ input: '{test_input}', llm: mockLlm })
|
|
631
|
+
expect(result).toEqual({expected_output})
|
|
632
|
+
expect(mockLlm.complete).toHaveBeenCalledWith(expect.objectContaining({ ... }))
|
|
633
|
+
})
|
|
634
|
+
|
|
635
|
+
it('throws when input is invalid', async () => {
|
|
636
|
+
await expect({function}({ input: null, llm: mockLlm })).rejects.toThrow('{ExpectedError}')
|
|
637
|
+
})
|
|
638
|
+
})
|
|
639
|
+
```
|
|
640
|
+
|
|
641
|
+
**If language = Java** (LangChain4j, etc.): use JUnit 5 + Mockito, same patterns as java-spring unit tests above — mock the `ChatLanguageModel` interface.
|
|
642
|
+
|
|
643
|
+
Rules:
|
|
644
|
+
- Mock the LLM client at the boundary — never call real LLM in unit tests
|
|
645
|
+
- Validate input schema and output schema separately
|
|
646
|
+
- Each scenario in `.feature` maps to one test function
|
|
647
|
+
- Use parameterized tests for multiple input variants
|
|
648
|
+
|
|
649
|
+
---
|
|
650
|
+
|
|
651
|
+
### If `platform_type = web-frontend`
|
|
652
|
+
|
|
653
|
+
#### react / nextjs / vue / nuxt / angular
|
|
654
|
+
|
|
655
|
+
```typescript
|
|
656
|
+
// @trace.verifies={UC-ID}
|
|
657
|
+
// @trace.service={active_service}
|
|
658
|
+
// @trace.test_type=component
|
|
659
|
+
|
|
660
|
+
// Component tests (Vitest + Testing Library)
|
|
661
|
+
describe('{ComponentName}', () => {
|
|
662
|
+
it('renders correctly when data is loaded', () => {
|
|
663
|
+
render(<{ComponentName} {...props} />)
|
|
664
|
+
expect(screen.getByText('...')).toBeInTheDocument()
|
|
665
|
+
})
|
|
666
|
+
|
|
667
|
+
it('shows loading state while fetching', () => { })
|
|
668
|
+
|
|
669
|
+
it('shows error message on API failure', () => { })
|
|
670
|
+
|
|
671
|
+
it('calls handler when user interacts', async () => {
|
|
672
|
+
await userEvent.click(screen.getByRole('button', { name: '...' }))
|
|
673
|
+
expect(mockHandler).toHaveBeenCalledWith(...)
|
|
674
|
+
})
|
|
675
|
+
})
|
|
676
|
+
|
|
677
|
+
// @trace.verifies={UC-ID}
|
|
678
|
+
// @trace.test_type=e2e
|
|
679
|
+
|
|
680
|
+
// E2E tests (Playwright or Cypress — use whichever is in project)
|
|
681
|
+
test('{scenario from .feature}', async ({ page }) => {
|
|
682
|
+
await page.goto('/{route}')
|
|
683
|
+
await page.getByRole('button', { name: '...' }).click()
|
|
684
|
+
await expect(page.getByText('...')).toBeVisible()
|
|
685
|
+
})
|
|
686
|
+
```
|
|
687
|
+
|
|
688
|
+
Rules:
|
|
689
|
+
- One component test file per component involved in the UC
|
|
690
|
+
- One E2E test file per UC covering happy path + key error scenarios
|
|
691
|
+
- Mock API calls at the network layer (MSW or cy.intercept), not at component props
|
|
692
|
+
- Use accessible queries (`getByRole`, `getByLabelText`) — avoid `getByTestId` unless necessary
|
|
693
|
+
- Each test maps to exactly one scenario in the `.feature` file
|
|
694
|
+
|
|
695
|
+
---
|
|
696
|
+
|
|
697
|
+
### If `platform_type = mobile`
|
|
698
|
+
|
|
699
|
+
#### flutter
|
|
700
|
+
|
|
701
|
+
```dart
|
|
702
|
+
// @trace.verifies={UC-ID}
|
|
703
|
+
// @trace.service={active_service}
|
|
704
|
+
// @trace.test_type=widget
|
|
705
|
+
|
|
706
|
+
// Widget tests
|
|
707
|
+
group('{FeatureName} widget tests', () {
|
|
708
|
+
testWidgets('renders correctly when state is loaded', (tester) async {
|
|
709
|
+
await tester.pumpWidget(MaterialApp(home: {Widget}()));
|
|
710
|
+
await tester.pumpAndSettle();
|
|
711
|
+
expect(find.text('...'), findsOneWidget);
|
|
712
|
+
});
|
|
713
|
+
|
|
714
|
+
testWidgets('shows loading indicator while fetching', (tester) async { });
|
|
715
|
+
testWidgets('shows error widget on failure', (tester) async { });
|
|
716
|
+
testWidgets('calls handler on tap', (tester) async {
|
|
717
|
+
await tester.tap(find.byType(ElevatedButton));
|
|
718
|
+
await tester.pumpAndSettle();
|
|
719
|
+
verify(() => mockBloc.add({Event}())).called(1);
|
|
720
|
+
});
|
|
721
|
+
});
|
|
722
|
+
|
|
723
|
+
// @trace.verifies={UC-ID}
|
|
724
|
+
// @trace.test_type=integration
|
|
725
|
+
// Integration test (flutter_test / integration_test package)
|
|
726
|
+
void main() {
|
|
727
|
+
IntegrationTestWidgetsFlutterBinding.ensureInitialized();
|
|
728
|
+
testWidgets('{scenario from .feature}', (tester) async {
|
|
729
|
+
app.main();
|
|
730
|
+
await tester.pumpAndSettle();
|
|
731
|
+
// Navigate, interact, assert
|
|
732
|
+
});
|
|
733
|
+
}
|
|
734
|
+
```
|
|
735
|
+
|
|
736
|
+
#### react-native
|
|
737
|
+
|
|
738
|
+
```typescript
|
|
739
|
+
// @trace.verifies={UC-ID}
|
|
740
|
+
// @trace.service={active_service}
|
|
741
|
+
// @trace.test_type=component
|
|
742
|
+
|
|
743
|
+
// Jest + React Native Testing Library
|
|
744
|
+
describe('{ComponentName}', () => {
|
|
745
|
+
it('{scenario description}', () => {
|
|
746
|
+
const { getByText, getByRole } = render(<{ComponentName} {...props} />)
|
|
747
|
+
expect(getByText('...')).toBeTruthy()
|
|
748
|
+
})
|
|
749
|
+
|
|
750
|
+
it('calls navigation on button press', () => {
|
|
751
|
+
const mockNavigate = jest.fn()
|
|
752
|
+
const { getByRole } = render(<{ComponentName} navigation={{ navigate: mockNavigate }} />)
|
|
753
|
+
fireEvent.press(getByRole('button'))
|
|
754
|
+
expect(mockNavigate).toHaveBeenCalledWith('...')
|
|
755
|
+
})
|
|
756
|
+
})
|
|
757
|
+
```
|
|
758
|
+
|
|
759
|
+
#### ios-swiftui
|
|
760
|
+
|
|
761
|
+
```swift
|
|
762
|
+
// @trace.verifies={UC-ID}
|
|
763
|
+
// @trace.service={active_service}
|
|
764
|
+
// @trace.test_type=unit
|
|
765
|
+
|
|
766
|
+
// XCTest — ViewModel unit tests
|
|
767
|
+
@MainActor
|
|
768
|
+
final class {Feature}ViewModelTests: XCTestCase {
|
|
769
|
+
var sut: {Feature}ViewModel!
|
|
770
|
+
var mockRepo: Mock{Repository}!
|
|
771
|
+
|
|
772
|
+
override func setUp() async throws {
|
|
773
|
+
mockRepo = Mock{Repository}()
|
|
774
|
+
sut = {Feature}ViewModel(repository: mockRepo)
|
|
775
|
+
}
|
|
776
|
+
|
|
777
|
+
func test_{method}_whenValid_shouldUpdate{State}() async throws {
|
|
778
|
+
// Given
|
|
779
|
+
mockRepo.stub{Method}Result = {expected}
|
|
780
|
+
// When
|
|
781
|
+
await sut.{method}()
|
|
782
|
+
// Then
|
|
783
|
+
XCTAssertEqual(sut.{state}, {expected})
|
|
784
|
+
}
|
|
785
|
+
|
|
786
|
+
func test_{method}_whenError_shouldSetErrorState() async throws { }
|
|
787
|
+
}
|
|
788
|
+
```
|
|
789
|
+
|
|
790
|
+
#### android-compose
|
|
791
|
+
|
|
792
|
+
```kotlin
|
|
793
|
+
// @trace.verifies={UC-ID}
|
|
794
|
+
// @trace.service={active_service}
|
|
795
|
+
// @trace.test_type=unit
|
|
796
|
+
|
|
797
|
+
// Unit test — ViewModel
|
|
798
|
+
class {Feature}ViewModelTest {
|
|
799
|
+
@get:Rule val mainDispatcherRule = MainDispatcherRule()
|
|
800
|
+
private val mockRepo: {Repository} = mockk()
|
|
801
|
+
private lateinit var sut: {Feature}ViewModel
|
|
802
|
+
|
|
803
|
+
@Before fun setup() { sut = {Feature}ViewModel(mockRepo) }
|
|
804
|
+
|
|
805
|
+
@Test fun `{method} when valid should emit success state`() = runTest {
|
|
806
|
+
coEvery { mockRepo.{method}(any()) } returns Result.success({data})
|
|
807
|
+
sut.{method}({input})
|
|
808
|
+
assertEquals(UiState.Success({data}), sut.uiState.value)
|
|
809
|
+
}
|
|
810
|
+
}
|
|
811
|
+
|
|
812
|
+
// @trace.verifies={UC-ID}
|
|
813
|
+
// @trace.test_type=ui
|
|
814
|
+
|
|
815
|
+
// UI test — Compose
|
|
816
|
+
@HiltAndroidTest
|
|
817
|
+
class {Feature}ScreenTest {
|
|
818
|
+
@get:Rule(order = 0) val hiltRule = HiltAndroidRule(this)
|
|
819
|
+
@get:Rule(order = 1) val composeRule = createAndroidComposeRule<MainActivity>()
|
|
820
|
+
|
|
821
|
+
@Test fun {scenario}_displaysExpectedUi() {
|
|
822
|
+
composeRule.onNodeWithText("...").assertIsDisplayed()
|
|
823
|
+
composeRule.onNodeWithContentDescription("...").performClick()
|
|
824
|
+
composeRule.onNodeWithText("...").assertIsDisplayed()
|
|
825
|
+
}
|
|
826
|
+
}
|
|
827
|
+
```
|
|
828
|
+
|
|
829
|
+
---
|
|
830
|
+
|
|
831
|
+
## Checklist
|
|
832
|
+
|
|
833
|
+
**All platforms:**
|
|
834
|
+
- [ ] `@trace.verifies` on every test class / test group
|
|
835
|
+
- [ ] `@trace.service` on every test class / test group
|
|
836
|
+
- [ ] Every scenario in `.feature` file has ≥ 1 corresponding test
|
|
837
|
+
- [ ] Happy path covered
|
|
838
|
+
- [ ] Key error / edge case scenarios covered
|
|
839
|
+
|
|
840
|
+
**Backend only:**
|
|
841
|
+
- [ ] Correct layer mocked (Repository in unit tests, Facade/Service in controller tests)
|
|
842
|
+
- [ ] No real DB calls in unit tests
|
|
843
|
+
- [ ] Test naming follows `methodName_whenCondition_shouldOutcome` (CLAUDE.md §6)
|
|
844
|
+
|
|
845
|
+
**Frontend / Mobile only:**
|
|
846
|
+
- [ ] No hardcoded delays (`sleep`, `setTimeout`) in tests — use `waitFor` / `pumpAndSettle`
|
|
847
|
+
- [ ] Accessible queries used (role, label) not implementation-specific selectors
|
|
848
|
+
- [ ] API calls mocked at network layer, not at component level
|
|
849
|
+
|
|
850
|
+
---
|
|
851
|
+
|
|
852
|
+
## Write Trace State
|
|
853
|
+
|
|
854
|
+
After generating all test files, update `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}.tsv` — for each scenario, find the existing row by `sc_id` and update:
|
|
855
|
+
|
|
856
|
+
| Column | Value |
|
|
857
|
+
|--------|-------|
|
|
858
|
+
| `test_count` | number of test methods covering this SC |
|
|
859
|
+
| `test_classes` | comma-separated test class / describe-block names |
|
|
860
|
+
| `dev_selftest` | `not_run` (tests now exist but have not been executed — `/dev-run-test` sets pass/fail) |
|
|
861
|
+
| `last_updated` | today `YYYY-MM-DD` |
|
|
862
|
+
|
|
863
|
+
Leave all other columns unchanged (including `dev_selftest_at`, which `/dev-run-test` owns, and `qc_status`/`qc_run_at`, which `/qc-run-test` owns).
|
|
864
|
+
|
|
865
|
+
---
|
|
866
|
+
|
|
867
|
+
## Refresh Panel Mirror
|
|
868
|
+
# Refresh Living Docs panel mirror *(local, umbrella mode)*
|
|
869
|
+
|
|
870
|
+
*Skip entirely in single-service mode (no `services` and no `setup.spec_source`) — there
|
|
871
|
+
the repo's own `.trace/` IS the panel location, so nothing to mirror.*
|
|
872
|
+
|
|
873
|
+
After updating the authoritative TSV(s) at `{paths.trace_dir}`:
|
|
874
|
+
|
|
875
|
+
**When `setup.spec_source` is set (consolidated trace — the common case):**
|
|
876
|
+
`{paths.trace_dir}` resolves to `{spec_source}/.trace` — the single authoritative location.
|
|
877
|
+
This command runs from `service_root`, so the write is **cross-repo into the spec submodule**;
|
|
878
|
+
commit/push the spec submodule for the trace update (same as `feedback/`).
|
|
879
|
+
1. Resolve `panel_mirror = ./.trace` at the **current workspace root**.
|
|
880
|
+
2. If `panel_mirror` resolves to a different path than `{paths.trace_dir}`, copy each
|
|
881
|
+
just-updated `{UC-ID}.tsv` → `{panel_mirror}/{UC-ID}.tsv` (create the dir; overwrite).
|
|
882
|
+
No per-service namespacing — there is one trace set; the owning service is carried in each
|
|
883
|
+
row's `@trace.service`.
|
|
884
|
+
|
|
885
|
+
**Legacy (no `spec_source` — per-service trace):**
|
|
886
|
+
Copy each just-updated `{UC-ID}.tsv` → `{panel_mirror}/{service-name}/{UC-ID}.tsv`
|
|
887
|
+
(namespaced by `active_service`).
|
|
888
|
+
|
|
889
|
+
This keeps the open workspace's Living Docs panel current **between syncs** — it is a
|
|
890
|
+
**local convenience mirror only**. The merged `trace-report.json` (canonical, in
|
|
891
|
+
`{spec_source}/.living-docs/`) is rebuilt by `/sync` or `/validate-traces`. For orchestrated
|
|
892
|
+
commands, do this once in the orchestrator after all sub-agents return — not inside each
|
|
893
|
+
sub-agent.
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
---
|
|
897
|
+
|
|
898
|
+
## Output
|
|
899
|
+
|
|
900
|
+
# Report Footer — Standard Command Output Format
|
|
901
|
+
|
|
902
|
+
Every command report must end with this standard footer section.
|
|
903
|
+
|
|
904
|
+
## Status Badge
|
|
905
|
+
|
|
906
|
+
Choose one based on outcome:
|
|
907
|
+
- `✅ Complete` — all steps succeeded, no issues found
|
|
908
|
+
- `❌ Failed` — command could not complete due to a blocking error
|
|
909
|
+
- `⚠️ Warnings` — completed with non-blocking issues that should be reviewed
|
|
910
|
+
|
|
911
|
+
## Output Artifacts
|
|
912
|
+
|
|
913
|
+
List every file created or modified by this command:
|
|
914
|
+
```
|
|
915
|
+
Output Artifacts:
|
|
916
|
+
{created|updated} {file-path} ({brief description})
|
|
917
|
+
{created|updated} {file-path} ({brief description})
|
|
918
|
+
```
|
|
919
|
+
|
|
920
|
+
If no files were written (e.g., review or analysis commands) → write `Output Artifacts: none (read-only)`.
|
|
921
|
+
|
|
922
|
+
## Pipeline Position
|
|
923
|
+
|
|
924
|
+
Print a one-line map of the pipeline with the CURRENT command's phase marked `◀ bạn ở đây`,
|
|
925
|
+
so the user always sees where this command sits in the end-to-end flow:
|
|
926
|
+
|
|
927
|
+
```
|
|
928
|
+
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
929
|
+
```
|
|
930
|
+
|
|
931
|
+
Find the current command in this phase legend and mark **its** phase in the map above:
|
|
932
|
+
|
|
933
|
+
| Phase | Commands |
|
|
934
|
+
|-------|----------|
|
|
935
|
+
| Discovery | `/define-product` |
|
|
936
|
+
| PRD | `/generate-prd` · `/refine-prd` · `/review-context` (PRD) |
|
|
937
|
+
| Design Spec | `/generate-design-spec` |
|
|
938
|
+
| BDD | `/generate-bdd` · `/review-context` (BDD) |
|
|
939
|
+
| Tech Design | `/generate-tech-docs` · `/map-testids` · `/review-tech-docs` |
|
|
940
|
+
| Code | `/generate-code` · `/review-code` |
|
|
941
|
+
| Dev Self-Check | `/dev-gen-test` · `/dev-run-test` · `/dev-smoke-test` |
|
|
942
|
+
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
943
|
+
| Trace Audit | `/validate-traces` |
|
|
944
|
+
|
|
945
|
+
For a **review command**, also append the 3-step review loop with the current step marked, e.g.:
|
|
946
|
+
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
947
|
+
|
|
948
|
+
**Cross-cutting commands** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
949
|
+
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) sit outside the linear pipeline —
|
|
950
|
+
**omit the Pipeline line entirely** for these (do not force-fit them onto the map).
|
|
951
|
+
|
|
952
|
+
## Next Command Suggestion
|
|
953
|
+
|
|
954
|
+
Suggest the logical next command based on workflow phase:
|
|
955
|
+
|
|
956
|
+
| Current command | Suggest next |
|
|
957
|
+
|-------------------------|-----------------------------------------------|
|
|
958
|
+
| /setup-ai-first | `/define-product` to start your first feature |
|
|
959
|
+
| /define-product | `/generate-prd {product-definition-file}` |
|
|
960
|
+
| /generate-prd | `/refine-prd {prd-file}` then `/review-context {prd-file}` |
|
|
961
|
+
| /refine-prd | Open Review Board → update PRD → `/review-context {prd-file}` |
|
|
962
|
+
| /review-context (PRD) | FE/App: `/generate-design-spec {prd-file}` (then BDD after sign-off); BE: `/generate-bdd {prd-file}` directly; fix PRD if NEEDS_FIX |
|
|
963
|
+
| /generate-design-spec | Designer review → Figma links confirmed → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
964
|
+
| /generate-bdd | `/review-context {feature-file}` to verify coverage |
|
|
965
|
+
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` if APPROVED; regenerate if NEEDS_FIX |
|
|
966
|
+
| /qc-analyze | `/qc-plan {UC-ID}` (resolve 🔴 blocker gaps first) |
|
|
967
|
+
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
968
|
+
| /qc-design-test | `/qc-review {UC-ID}` (test-case review) |
|
|
969
|
+
| /qc-review (test-case) | `/qc-run-test {UC-ID}` if APPROVED; fix TCs if NEEDS_FIX |
|
|
970
|
+
| /qc-run-test | `/qc-report {UC-ID}` then `/qc-review {UC-ID}` (script review) |
|
|
971
|
+
| /qc-review (script) | `/qc-report {UC-ID}` then create PR if APPROVED |
|
|
972
|
+
| /qc-report | `/validate-traces {UC-ID}` to refresh Living Docs (qc_status) |
|
|
973
|
+
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
974
|
+
| /review-tech-docs | `/generate-code {feature-file}` if APPROVED; fix doc if NEEDS_FIX |
|
|
975
|
+
| /generate-code | First gen → `/review-code {UC-ID}`; re-gen → `/dev-gen-test {UC-ID}` |
|
|
976
|
+
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
977
|
+
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
978
|
+
| /dev-run-test (failing) | `/fix-bug {ticket-id}` or `/debug {error}` |
|
|
979
|
+
| /review-code | `/dev-smoke-test {UC-ID}` or create PR |
|
|
980
|
+
| /dev-smoke-test | Create PR and link to ticket |
|
|
981
|
+
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`; all OK → create PR |
|
|
982
|
+
| /fix-bug | Create PR and link to ticket |
|
|
983
|
+
| /debug | `/fix-bug {ticket-id}` if fix needed |
|
|
984
|
+
| /report-bug | Send to dev (`/fix-bug {BUG-ID}`); if coverage gap → `/propose-scenario {UC-ID}` |
|
|
985
|
+
| /propose-scenario | Notify PO/Dev to review the proposal in `feedback/bdd-proposals/` |
|
|
986
|
+
| /learn | Continue working — lesson applies on next command |
|
|
987
|
+
| /sync | `/validate-traces` for full coverage; act on any `📥 tester feedback` surfaced |
|
|
988
|
+
| /update-framework | Review `git diff .agent/`, commit; `/sync` for project content |
|
|
989
|
+
|
|
990
|
+
Format the footer as:
|
|
991
|
+
```
|
|
992
|
+
---
|
|
993
|
+
Status : {badge}
|
|
994
|
+
{Output Artifacts block}
|
|
995
|
+
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
996
|
+
(review cmd) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
997
|
+
Next : {suggested command with example arguments}
|
|
998
|
+
```
|
|
999
|
+
*(Omit the `Pipeline` line for cross-cutting commands listed above.)*
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
```
|
|
1003
|
+
/dev-gen-test Complete — {UC-ID} ({active_module})
|
|
1004
|
+
✅ {TestClass1} ({N} tests)
|
|
1005
|
+
✅ {TestClass2} ({N} tests)
|
|
1006
|
+
Trace: {paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}.tsv updated
|
|
1007
|
+
Next: /dev-run-test {UC-ID}
|
|
1008
|
+
|
|
1009
|
+
📊 Living Docs: run /validate-traces (or /sync) to push this trace to the spec-module dashboard.
|
|
1010
|
+
```
|