@anhth2/spec-driven-dev-plugin 0.5.0

package/commands/validate-traces.md

@@ -0,0 +1,529 @@
+# /validate-traces — Traceability Coverage Matrix
+
+Read-only check of coverage between specs, code, and tests — including PRD version drift.
+
+## Gate
+# Gate — Universal Entry Procedure
+
+Every command must execute this gate before proceeding with its specific logic.
+
+## Step 0 — Sub-Agent Mode Check
+
+Before anything else, check if `$ARGUMENTS` is a JSON payload from an orchestrator:
+
+1. Attempt to parse `$ARGUMENTS` as JSON.
+2. If it parses successfully **and** contains `"_agent_mode": true`:
+   - **Skip Steps 1, 2, and 3 of this Gate entirely.**
+   - Set target file = `payload.target_file`
+   - Set loaded context = `payload.context` (do NOT run context-loader.md)
+   - Set UC scope = `payload.uc_id` (process only this UC)
+   - Set line range = `payload.uc_section` (read only that PRD section)
+   - Proceed directly to the command-specific logic.
+3. If `$ARGUMENTS` is not JSON or `_agent_mode` is absent → continue to Step 1 (normal mode).
+
+## Step 0-B — Model Check
+
+*Skip this step if `_agent_mode: true` (sub-agent — orchestrator already validated).*
+
+Complex generation and review commands require strong reasoning.
+Using a smaller model risks missed edge cases, incomplete spec analysis, and architecture violations.
+
+Display and wait for response:
+
+```
+⚙️  MODEL CHECK
+──────────────────────────────────────────────────────────────────
+  Recommended  : claude-opus-4-5 (or claude-opus-4)
+  Why needed   : Spec analysis, architecture review, code generation
+                 require deep reasoning. Smaller models miss edge cases.
+
+  To switch in Claude Code:
+    • Settings → Model → select "claude-opus"
+    • or: /model → choose claude-opus
+
+  Running on claude-opus?
+    Y — yes, on claude-opus → proceed
+    S — skip check (I accept lower quality risk with current model)
+──────────────────────────────────────────────────────────────────
+```
+
+- "Y" → proceed to Step 1.
+- "S" → proceed to Step 1 (user accepts risk, add ⚠️ to final report).
+- "N" or anything else → **STOP.** Output: "Please switch to claude-opus, then re-run this command."
+
+## Step 1 — Resolve Target File
+
+1. If `$ARGUMENTS` is provided and points to an existing file → use it directly as the target.
+2. If `$ARGUMENTS` is a UC-ID, ticket ID, or partial name → search for matching files in the relevant directory.
+3. If `$ARGUMENTS` is empty or no match found:
+   - List files in the relevant directory for this command (e.g., `specs/prd/**/*.md` for PRD commands, `specs/bdd/**/*.feature` for BDD commands).
+   - Present the list to the user and ask: "Which file do you want to work with? (Enter number or filename)"
+   - Wait for user selection before continuing.
+
+## Step 2 — Execute Context Loader
+
+Load all project context by following the procedure in `steps/context-loader.md`.
+Store all loaded context in memory for use throughout this command session.
+
+## Step 3 — CHECKPOINT
+
+After completing Steps 1 and 2, display a summary and wait for confirmation:
+
+```
+CHECKPOINT
+-----------
+Target     : {resolved file path}
+Project    : {project.name from project-context.yaml}
+Tech stack : {language} / {framework}
+Module     : {module if set, else "not configured"}
+Domains    : {comma-separated domain list}
+
+Proceed? (Y/N)
+```
+
+Wait for explicit "Y" or "N" from the user before continuing.
+- "Y" → proceed to the command-specific steps below.
+- "N" → stop and ask what the user wants to change.
+
+
+*Note: For this command, the target in Step 1 is a domain name or specific UC-ID from `$ARGUMENTS`. There is no single file to resolve — the command scans multiple directories.*
+
+## Context
+# Context Loader — Load All Project Context
+
+Execute these steps in order. Store everything in memory for the duration of the command session.
+
+**Priority guide (anti-lost-in-middle):**
+- Steps 1–2 are PROJECT-CONFIG — loaded first, resolve all paths and metadata.
+- Step 3 is CRITICAL — architecture + coding standards, the highest-priority facts for generation.
+- Step 4 is SAFETY — data protection rules, enforced silently for the entire session.
+- Steps 5–6 are DOMAIN KNOWLEDGE — terminology and entity definitions.
+- Step 7 is the WORKING MEMORY RECAP — locks critical facts into the top of working memory.
+
+---
+
+## Step 1 — [PROJECT-CONFIG] Load project-context.yaml
+
+Read `.agent/project-context.yaml`. Extract and store:
+
+**Tech Stack:**
+- `tech_stack.language` → active language (e.g., Java 17, TypeScript, C#, Go)
+- `tech_stack.framework` → active framework (e.g., Spring Boot 3.2, Angular 17, .NET 8)
+- `tech_stack.build_tool` → build tool (e.g., Maven, npm, dotnet, go)
+- `tech_stack.test_framework` → test framework (e.g., JUnit 5 + Mockito, Jest, xUnit)
+- `tech_stack.database` → database (e.g., PostgreSQL, MySQL, MongoDB)
+- `tech_stack.module` → active module profile (e.g., java-spring, angular, dotnet, golang, context-engineering)
+
+**Conventions:**
+- `conventions.build_command` → how to compile/build
+- `conventions.test_command` → how to run tests
+- `conventions.service_run` → how to start the service
+- `conventions.ticket_prefix` → ticket ID prefix (e.g., PROJ, FEAT, UC)
+
+**Domains:**
+- `domains` → list of active business domains
+
+**Paths (if present):**
+- `paths.specs_dir` → BDD specs root
+- `paths.prd_dir` → PRD documents root
+- `paths.refinement_dir` → findings/review output dir
+- `paths.product_definitions_dir` → product definitions root
+- `paths.domain_knowledge_dir` → domain knowledge root
+- `paths.business_dictionary` → path to business-dictionary.md
+- `paths.core_entities` → path to core-entities.md
+- `paths.tech_docs_dir` → technical documentation root
+- `paths.trace_dir` → trace state directory
+
+If `paths` section is absent, use these defaults:
+- `specs_dir` = `specs/bdd`
+- `prd_dir` = `specs/prd`
+- `refinement_dir` = `.agent/review`
+- `product_definitions_dir` = `specs/product-definition`
+- `domain_knowledge_dir` = `specs/domain-knowledge`
+- `business_dictionary` = `specs/domain-knowledge/business-dictionary.md`
+- `core_entities` = `specs/domain-knowledge/core-entities.md`
+- `tech_docs_dir` = `tech-docs`
+- `trace_dir` = `.trace`
+
+If `tech_stack.module` is set, also load `.agent/modules/{module}/stack-profile.yaml` if it exists.
+
+---
+
+## Step 2 — [PROJECT-CONFIG] Load module stack profile (conditional)
+
+If `tech_stack.module` is set, read `.agent/modules/{module}/stack-profile.yaml`.
+Merge framework-specific conventions (layer patterns, test patterns, naming rules) into the loaded context.
+If the file does not exist → skip silently.
+
+---
+
+## Step 3 — [CRITICAL] Load CLAUDE.md
+
+*This is the highest-priority context — it defines HOW to write code and documents for this project.*
+
+Read `CLAUDE.md`. Extract and store:
+
+- **§1 Project Overview** → project name, language, framework, build/test commands, domains
+- **§2 Architecture** → layer order (e.g., Controller → Facade → Service → Repository), architectural rules
+- **§3 Coding Standards** → naming conventions (classes, methods), response wrapper type, forbidden patterns
+- **§5 Error Handling** → exception types, HTTP status code mapping, not-found exception class name
+- **§7 Git Conventions** → branch naming pattern, commit message format
+
+If `CLAUDE.md` does not exist → note it as missing and continue with project-context.yaml data only.
+
+---
+
+## Step 4 — [SAFETY] Load Data Protection Rules
+
+Read `.agent/rules/data-protection.md` (or `rules/data-protection.md` from the framework installation).
+
+Store the sensitive file patterns — you must **never** read, write, display, or reference content from files matching those patterns for the entire session.
+
+If neither file exists → apply built-in defaults: never access `.env*`, `*.key`, `*.pem`, `*secret*`, `*password*`, `*credential*`.
+
+---
+
+## Step 5 — [DOMAIN] Load Business Dictionary (conditional)
+
+Check if the business dictionary file exists (use `paths.business_dictionary` resolved in Step 1).
+
+If it exists, read it and extract:
+- **Canonical Terms** → complete list of approved terms and their definitions
+- **Banned Terms** → complete list of banned terms and their canonical replacements
+- **Status / Enum Registry** → allowed enum values per entity
+
+Store the banned terms list for **active enforcement** throughout the command session:
+- When generating any text (PRD, BDD, code comments, tech docs), verify no banned terms appear
+- Replace banned terms with their canonical equivalents automatically
+
+If the file does not exist → skip silently. Do not warn or block.
+
+---
+
+## Step 6 — [DOMAIN] Load Core Entities (conditional)
+
+Check if the core entities file exists at `paths.core_entities` (resolved in Step 1).
+Default path: `specs/domain-knowledge/core-entities.md`.
+
+If it exists, read it and store:
+- **Entity catalog** → for each entity: its name, purpose, owner service, key fields (name + type), business invariants, and relationships
+- **Field name registry** → canonical field names to use in generated code and documents
+- **Relationship map** → how entities relate to each other (1:N, N:N, embedded, etc.)
+
+**How to use this catalog:**
+- When generating code: use the field names, types, and relationships defined here — do NOT infer from existing code
+- When generating PRD/BDD: reference entity names from this catalog for consistency
+- When generating tech-docs: use this catalog as the source-of-truth for entity definitions
+
+If the file does not exist → skip silently.
+
+---
+
+## Step 7 — [RECAP] Working Memory Recap (anti-lost-in-middle)
+
+After loading all context, synthesize and output a compact summary block.
+This recap ensures the most critical facts are stated at the END of context loading
+(recency effect — freshest in working memory when the task begins).
+
+Output exactly this block:
+```
+[CTX LOADED]
+Stack     : {language} / {framework} / {database}
+Layers    : {layer order from CLAUDE.md §2, e.g., Controller → Facade → Service → Repository}
+Ticket    : {ticket_prefix}-
+Dict      : {loaded — N canonical terms, M banned terms | missing}
+Entities  : {loaded — EntityA, EntityB, EntityC | missing}
+Status    : {FULL | PARTIAL — missing: CLAUDE.md / business-dict / core-entities | MINIMAL}
+```
+
+If any CRITICAL file is missing (CLAUDE.md), flag it clearly so the user can decide whether to proceed.
+
+---
+
+## Context Load Complete
+
+After completing all steps, you have loaded:
+- Project identity, tech stack, module conventions
+- Architecture rules and layer order  ← **[CRITICAL — hold in working memory]**
+- Coding standards and naming conventions  ← **[CRITICAL — hold in working memory]**
+- Data protection rules (sensitive file patterns to never access)
+- Terminology rules with banned-term list  ← **[DOMAIN — apply to every generated word]**
+- Entity catalog (field names, types, invariants)  ← **[DOMAIN — use for code generation]**
+- All configured paths
+
+Proceed to the next step of the calling command.
+
+
+---
+
+## Process
+
+### Step 1 — Load TSV data
+
+Read all `{paths.trace_dir}/{UC-ID}.tsv` files matching the target domain (or all domains if no domain filter).
+Each file gives the persisted trace state for that UC.
+
+### Step 2 — Reconcile with current `.feature` files
+
+For each `.tsv` row, read the corresponding `.feature` file and get the **current** `@trace.sc_version` for that SC.
+If the `.feature` SC version differs from the `.tsv` `spec_ver` → update `spec_ver` in memory (will be written back).
+
+Also detect SCs present in `.feature` but missing from `.tsv` → add as new rows with `status: UNTRACKED`.
+
+### Step 3 — Compute `status` per scenario
+
+Apply rules in priority order:
+
+| Rule | Status | Condition |
+|------|--------|-----------|
+| 1 | `UNTRACKED` | `implemented_by == —` (no code generated yet) |
+| 2 | `GAP` | `implemented_by != —` AND (`test_count == —` OR `test_count == 0`) |
+| 3 | `DRIFT` | `spec_ver != gen_ver` (scenario updated since last codegen) |
+| 4 | `OK` | all of: `spec_ver == gen_ver`, `implemented_by != —`, `test_count > 0` |
+
+### Step 4 — PRD version drift check
+
+For each UC, compare:
+- Current PRD `| **Version** |` from `{paths.prd_dir}/{domain}/{slug}.md`
+- `prd_version` stored in `.tsv` (version at time of BDD generation)
+- `@trace.prd_version` in the code files implementing that UC
+
+If any layer is behind current PRD version → flag `PRD_DRIFT` and extract changelog entries since that version.
+
+### Step 5 — Tech-doc revision drift check
+
+For each UC that has a tech-doc, compare:
+- Current `@trace.revision` in `{paths.tech_docs_dir}/{domain}/{UC-ID}-tech-design.md`
+- `tech_doc_revision` stored in `.tsv` (revision at time of codegen)
+
+If code was generated from an older revision → flag `TECHDOC_DRIFT`.
+
+### Step 6 — Write status back to TSV
+
+For each `.tsv` file processed: write updated `spec_ver`, `status`, `last_updated` back to disk.
+
+### Step 7 — Compute dashboard aggregates
+
+```
+total_prds       = count distinct PRD files in {paths.prd_dir}/{domain}/
+approved_prds    = PRDs with | Status | approved
+total_ucs        = count distinct UC-IDs across all .tsv files
+approved_ucs     = UCs with uc_status == approved
+total_scs        = total rows across all .tsv files
+code_coverage    = rows where implemented_by != — / total_scs
+test_coverage    = rows where test_count > 0 / total_scs
+drift_count      = rows where status == DRIFT
+untracked_count  = rows where status == UNTRACKED
+gap_count        = rows where status == GAP
+tech_docs_count  = count .md files in {paths.tech_docs_dir}/{domain}/
+```
+
+### Step 8 — Write JSON report
+
+Write `.trace/trace-report.json` (overwrite if exists). This file is the single source of truth for web dashboards — it contains the full snapshot at the time `/validate-traces` was last run.
+
+Schema:
+
+```json
+{
+  "generated_at": "<ISO-8601 timestamp>",
+  "domain": "<domain argument, or 'all' if no filter>",
+  "summary": {
+    "total_prds": 0,
+    "approved_prds": 0,
+    "total_ucs": 0,
+    "approved_ucs": 0,
+    "draft_ucs": 0,
+    "total_scs": 0,
+    "coded_scs": 0,
+    "tested_scs": 0,
+    "code_coverage_pct": 0,
+    "test_coverage_pct": 0,
+    "drift_count": 0,
+    "gap_count": 0,
+    "untracked_count": 0,
+    "tech_docs_count": 0
+  },
+  "prds": [
+    {
+      "prd_id": "<e.g. PAY>",
+      "prd_status": "approved | draft | other",
+      "total_scs": 0,
+      "coded_scs": 0,
+      "tested_scs": 0,
+      "drift_count": 0,
+      "gap_count": 0,
+      "untracked_count": 0,
+      "ucs": [
+        {
+          "uc_id": "<e.g. PAY-UC01>",
+          "uc_status": "approved | draft | other",
+          "scenarios": [
+            {
+              "sc_id": "<e.g. PAY-UC01-SC1>",
+              "sc_title": "<title>",
+              "spec_ver": "<current version from .feature>",
+              "gen_ver": "<version at codegen time>",
+              "implemented_by": "<ClassName.method or null>",
+              "test_count": 0,
+              "test_classes": ["<TestClass1>", "<TestClass2>"],
+              "prd_version": "<prd version when BDD was generated>",
+              "bdd_version": "<bdd version when code was generated>",
+              "tech_doc_revision": 0,
+              "status": "OK | DRIFT | GAP | UNTRACKED",
+              "last_updated": "<YYYY-MM-DD>"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "issues": {
+    "drift": [
+      {
+        "sc_id": "<SC-ID>",
+        "sc_title": "<title>",
+        "spec_ver": "<current>",
+        "gen_ver": "<at codegen>",
+        "fix": "/generate-code <UC-ID>"
+      }
+    ],
+    "gap": [
+      {
+        "sc_id": "<SC-ID>",
+        "sc_title": "<title>",
+        "implemented_by": "<method>",
+        "fix": "/generate-tests <UC-ID>"
+      }
+    ],
+    "untracked": [
+      {
+        "sc_id": "<SC-ID>",
+        "sc_title": "<title>",
+        "fix": "/generate-code <UC-ID>"
+      }
+    ],
+    "prd_version_drift": [
+      {
+        "uc_id": "<UC-ID>",
+        "code_prd_version": "<version in code tag>",
+        "current_prd_version": "<version in PRD file>",
+        "changelog_since": ["<v1.1: ...>", "<v1.2: ...>"],
+        "fix": "/generate-bdd <prd-file> then /generate-code <UC-ID>"
+      }
+    ],
+    "techdoc_drift": [
+      {
+        "uc_id": "<UC-ID>",
+        "code_revision": 0,
+        "current_revision": 0,
+        "fix": "/generate-code <UC-ID>"
+      }
+    ]
+  }
+}
+```
+
+**Rules:**
+- `implemented_by`: use `null` (not `"—"`) in JSON when no value
+- `test_count`: use integer `0` (not `"—"`) when no tests
+- `test_classes`: use `[]` (not `"—"`) when no test classes
+- `tech_doc_revision`: use integer; `0` if not yet generated
+- `code_coverage_pct` / `test_coverage_pct`: round to nearest integer (0–100)
+- Always write to `.trace/trace-report.json` regardless of domain filter — if a domain filter was applied, include only those PRDs in `prds[]` but note the domain in the `domain` field
+
+## Output
+
+# Report Footer — Standard Command Output Format
+
+Every command report must end with this standard footer section.
+
+## Status Badge
+
+Choose one based on outcome:
+- `✅ Complete` — all steps succeeded, no issues found
+- `❌ Failed` — command could not complete due to a blocking error
+- `⚠️ Warnings` — completed with non-blocking issues that should be reviewed
+
+## Output Artifacts
+
+List every file created or modified by this command:
+```
+Output Artifacts:
+  {created|updated} {file-path} ({brief description})
+  {created|updated} {file-path} ({brief description})
+```
+
+If no files were written (e.g., review or analysis commands) → write `Output Artifacts: none (read-only)`.
+
+## Next Command Suggestion
+
+Suggest the logical next command based on workflow phase:
+
+| Current command         | Suggest next                                  |
+|-------------------------|-----------------------------------------------|
+| /define-product         | `/generate-prd {product-definition-file}`     |
+| /generate-prd           | `/refine-prd {prd-file}` then `/review-context {prd-file}` |
+| /refine-prd             | Open Review Board → update PRD → `/review-context {prd-file}` |
+| /review-context (PRD)   | `/generate-bdd {prd-file}` if APPROVED; fix PRD if NEEDS_FIX |
+| /generate-bdd           | `/review-context {feature-file}` to verify coverage |
+| /review-context (BDD)   | `/generate-tech-docs {UC-ID}` if APPROVED; regenerate if NEEDS_FIX |
+| /generate-tech-docs     | `/review-tech-docs {tech-design-file}`        |
+| /review-tech-docs       | `/generate-code {feature-file}` if APPROVED; fix doc if NEEDS_FIX |
+| /generate-code          | `/generate-tests {UC-ID}`                     |
+| /generate-tests         | `/run-tests {UC-ID}`                          |
+| /run-tests (passing)    | `/review-code {UC-ID}`                        |
+| /run-tests (failing)    | `/fix-bug {ticket-id}` or `/debug {error}`    |
+| /review-code            | `/smoke-test {UC-ID}` or create PR            |
+| /smoke-test             | Create PR and link to ticket                  |
+| /validate-traces        | `/generate-code {UC-ID}` for gaps             |
+| /fix-bug                | Create PR and link to ticket                  |
+| /debug                  | `/fix-bug {ticket-id}` if fix needed          |
+
+Format the footer as:
+```
+---
+Status : {badge}
+{Output Artifacts block}
+Next   : {suggested command with example arguments}
+```
+
+
+```
+/validate-traces — {domain}
+
+📄 .trace/trace-report.json  ← updated
+
+┌─────────────────────────────────────────────────────────────────────────────────────┐
+│  PRDs      Use Cases     Scenarios   Code Cov.  Test Cov.  Drift  Untracked  Gap   │
+│  {N}       {N}           {N}         {N}%       {N}%       {N}    {N}        {N}   │
+│  {A} appr  {A} appr                 {X}/{T} SCs {X}/{T} SCs                        │
+└─────────────────────────────────────────────────────────────────────────────────────┘
+
+| UC-ID       | SC   | Title (truncated)            | Spec  | Gen   | Code                 | Tests          | Status   |
+|-------------|------|------------------------------|-------|-------|----------------------|----------------|----------|
+| {UC}-UC1    | SC1  | {title...}                   | v1.0  | v1.0  | ✅ {Controller.fn}   | ✅ 10 tests    | OK       |
+| {UC}-UC1    | SC2  | {title...}                   | v1.1  | v1.0  | ✅ {Controller.fn}   | ✅ 3 tests     | DRIFT    |
+| {UC}-UC1    | SC6  | {title...}                   | v1.0  | —     | —                    | —              | UNTRACKED|
+| {UC}-UC2    | SC1  | {title...}                   | v1.0  | v1.0  | ✅ {Controller.fn}   | —              | GAP      |
+
+Drift Detail:
+  {UC}-UC1-SC2 — spec v1.1 but code generated from v1.0
+    → Re-run: /generate-code {UC-ID}
+
+PRD Version Drift:
+  {UC}-UC2 — code at PRD v1.0, PRD now at v1.2
+    Changes since v1.0:
+      v1.1: {changelog entry}
+      v1.2: {changelog entry}
+    → /generate-bdd {prd-file} then /generate-code {UC-ID}
+
+Tech-Doc Revision Drift:
+  {UC}-UC3 — code generated from tech-doc revision 2, now at revision 4
+    → Review tech-doc changes then /generate-code {UC-ID}
+
+Recommendations:
+  - /generate-code {UC-ID}      for DRIFT and UNTRACKED scenarios
+  - /generate-tests {UC-ID}     for GAP (missing tests)
+  - /generate-bdd {prd-file}    for PRD version drift
+```