@educa-corp/sdd-framework 0.4.0 → 0.4.2
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 +9 -0
- package/bin/index.js +115 -4
- package/bin/self-check.js +236 -0
- package/bin/trace-schema.json +692 -0
- package/commands/debug.md +16 -10
- package/commands/define-product.md +16 -10
- package/commands/dev-gen-test.md +16 -10
- package/commands/dev-run-test.md +18 -11
- package/commands/dev-run-test.tmpl +2 -1
- package/commands/dev-smoke-test.md +16 -10
- package/commands/fix-bug.md +71 -13
- package/commands/fix-bug.tmpl +29 -3
- package/commands/generate-architecture.md +16 -10
- package/commands/generate-bdd.md +118 -35
- package/commands/generate-bdd.tmpl +89 -15
- package/commands/generate-code.md +49 -13
- package/commands/generate-code.tmpl +33 -3
- package/commands/generate-design-spec.md +16 -10
- package/commands/generate-prd.md +16 -10
- package/commands/generate-spec-manifest.md +16 -10
- package/commands/generate-tech-docs.md +19 -13
- package/commands/generate-tech-docs.tmpl +2 -2
- package/commands/learn.md +16 -10
- package/commands/map-testids.md +16 -10
- package/commands/propose-scenario.md +36 -12
- package/commands/propose-scenario.tmpl +20 -2
- package/commands/qc-analyze.md +16 -10
- package/commands/qc-design-test.md +16 -10
- package/commands/qc-plan.md +16 -10
- package/commands/qc-report.md +16 -10
- package/commands/qc-review.md +16 -10
- package/commands/qc-run-test.md +38 -12
- package/commands/qc-run-test.tmpl +22 -2
- package/commands/refine-prd.md +16 -10
- package/commands/report-bug.md +16 -10
- package/commands/review-code.md +56 -12
- package/commands/review-code.tmpl +40 -2
- package/commands/review-context.md +58 -14
- package/commands/review-context.tmpl +42 -4
- package/commands/review-tech-docs.md +47 -12
- package/commands/review-tech-docs.tmpl +31 -2
- package/commands/setup-ai-first.md +23 -14
- package/commands/setup-ai-first.tmpl +7 -4
- package/commands/sync.md +3 -2
- package/commands/update-framework.md +40 -2
- package/commands/update-framework.tmpl +37 -0
- package/commands/validate-traces.md +165 -18
- package/commands/validate-traces.tmpl +149 -8
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/README.md +56 -0
- package/core/commands/debug.md +16 -10
- package/core/commands/define-product.md +16 -10
- package/core/commands/dev-gen-test.md +16 -10
- package/core/commands/dev-run-test.md +18 -11
- package/core/commands/dev-smoke-test.md +16 -10
- package/core/commands/fix-bug.md +71 -13
- package/core/commands/generate-architecture.md +16 -10
- package/core/commands/generate-bdd.md +118 -35
- package/core/commands/generate-code.md +49 -13
- package/core/commands/generate-design-spec.md +16 -10
- package/core/commands/generate-prd.md +16 -10
- package/core/commands/generate-spec-manifest.md +16 -10
- package/core/commands/generate-tech-docs.md +19 -13
- package/core/commands/learn.md +16 -10
- package/core/commands/map-testids.md +16 -10
- package/core/commands/propose-scenario.md +36 -12
- package/core/commands/qc-analyze.md +16 -10
- package/core/commands/qc-design-test.md +16 -10
- package/core/commands/qc-plan.md +16 -10
- package/core/commands/qc-report.md +16 -10
- package/core/commands/qc-review.md +16 -10
- package/core/commands/qc-run-test.md +38 -12
- package/core/commands/refine-prd.md +16 -10
- package/core/commands/report-bug.md +16 -10
- package/core/commands/review-code.md +56 -12
- package/core/commands/review-context.md +58 -14
- package/core/commands/review-tech-docs.md +47 -12
- package/core/commands/setup-ai-first.md +23 -14
- package/core/commands/sync.md +3 -2
- package/core/commands/update-framework.md +40 -2
- package/core/commands/validate-traces.md +165 -18
- package/core/modules/android-compose/stack-profile.yaml +1 -1
- package/core/modules/flutter/stack-profile.yaml +1 -1
- package/core/modules/ios-swiftui/stack-profile.yaml +1 -1
- package/core/modules/java-spring/stack-profile.yaml +1 -1
- package/core/modules/nextjs/stack-profile.yaml +1 -1
- package/core/modules/nuxt/stack-profile.yaml +1 -1
- package/core/modules/phaser-game/stack-profile.yaml +1 -1
- package/core/modules/php-laravel/stack-profile.yaml +1 -1
- package/core/modules/qc-playwright/stack-profile.yaml +1 -1
- package/core/modules/react/stack-profile.yaml +1 -1
- package/core/modules/react-native/stack-profile.yaml +1 -1
- package/core/modules/vue/stack-profile.yaml +1 -1
- package/core/rules/workflow.md +11 -0
- package/core/steps/gate.md +13 -8
- package/core/steps/report-footer.md +3 -2
- package/core/templates/README.md +47 -0
- package/core/templates/feature.template +13 -10
- package/core/templates/project-context.yaml +26 -14
- package/core/templates/tech-design.template.md +1 -1
- package/docs/02-concepts/traceability.md +29 -6
- package/docs/04-reference/trace-schema.md +128 -37
- package/modules/android-compose/stack-profile.yaml +1 -1
- package/modules/flutter/stack-profile.yaml +1 -1
- package/modules/ios-swiftui/stack-profile.yaml +1 -1
- package/modules/java-spring/stack-profile.yaml +1 -1
- package/modules/nextjs/stack-profile.yaml +1 -1
- package/modules/nuxt/stack-profile.yaml +1 -1
- package/modules/phaser-game/stack-profile.yaml +1 -1
- package/modules/php-laravel/stack-profile.yaml +1 -1
- package/modules/qc-playwright/stack-profile.yaml +1 -1
- package/modules/react/stack-profile.yaml +1 -1
- package/modules/react-native/stack-profile.yaml +1 -1
- package/modules/vue/stack-profile.yaml +1 -1
- package/package.json +50 -49
- package/rules/workflow.md +11 -0
- package/scripts/migrate-bdd-platform.js +286 -0
- package/steps/gate.md +13 -8
- package/steps/report-footer.md +3 -2
- package/templates/README.md +47 -0
- package/templates/feature.template +13 -10
- package/templates/project-context.yaml +26 -14
- package/templates/tech-design.template.md +1 -1
|
@@ -85,6 +85,6 @@ testing:
|
|
|
85
85
|
|
|
86
86
|
trace_tags:
|
|
87
87
|
implements: "// @trace.implements={UC-ID}-SC{N}"
|
|
88
|
-
source: "// @trace.source=specs/{domain}/{prd-slug}/bdd/{UC-ID}.feature"
|
|
88
|
+
source: "// @trace.source=specs/{domain}/{prd-slug}/bdd/{platform}/{UC-ID}-{slug}.feature"
|
|
89
89
|
verifies: "// @trace.verifies={UC-ID}"
|
|
90
90
|
test_type: "// @trace.test_type=unit|integration"
|
|
@@ -51,6 +51,6 @@ testing:
|
|
|
51
51
|
|
|
52
52
|
trace_tags:
|
|
53
53
|
implements: "// @trace.implements={UC-ID}-SC{N}"
|
|
54
|
-
source: "// @trace.source=specs/{domain}/{prd-slug}/bdd/{UC-ID}.feature"
|
|
54
|
+
source: "// @trace.source=specs/{domain}/{prd-slug}/bdd/{platform}/{UC-ID}-{slug}.feature"
|
|
55
55
|
verifies: "// @trace.verifies={UC-ID}"
|
|
56
56
|
test_type: "// @trace.test_type=unit|feature"
|
|
@@ -59,7 +59,7 @@ testing:
|
|
|
59
59
|
trace_tags:
|
|
60
60
|
# QC tests map back to the framework's scenarios — drives qc_status in the trace TSV.
|
|
61
61
|
verifies: "# @trace.verifies={UC-ID}-SC{N}"
|
|
62
|
-
source: "# @trace.source
|
|
62
|
+
source: "# @trace.source=specs/{domain}/{prd-slug}/bdd/{platform}/{UC-ID}-{slug}.feature"
|
|
63
63
|
test_type: "# @trace.test_type=functional|integration|e2e|non-functional"
|
|
64
64
|
|
|
65
65
|
# qc_status: /qc-run-test writes pass|fail|skip|not_run + qc_run_at into {trace_dir}/{UC-ID}.tsv
|
|
@@ -58,6 +58,6 @@ testing:
|
|
|
58
58
|
|
|
59
59
|
trace_tags:
|
|
60
60
|
implements: "// @trace.implements={UC-ID}-SC{N}"
|
|
61
|
-
source: "// @trace.source=specs/{domain}/{prd-slug}/bdd/{UC-ID}.feature"
|
|
61
|
+
source: "// @trace.source=specs/{domain}/{prd-slug}/bdd/{platform}/{UC-ID}-{slug}.feature"
|
|
62
62
|
verifies: "// @trace.verifies={UC-ID}"
|
|
63
63
|
test_type: "// @trace.test_type=unit|integration"
|
|
@@ -60,6 +60,6 @@ testing:
|
|
|
60
60
|
|
|
61
61
|
trace_tags:
|
|
62
62
|
implements: "// @trace.implements={UC-ID}-SC{N}"
|
|
63
|
-
source: "// @trace.source=specs/{domain}/{prd-slug}/bdd/{UC-ID}.feature"
|
|
63
|
+
source: "// @trace.source=specs/{domain}/{prd-slug}/bdd/{platform}/{UC-ID}-{slug}.feature"
|
|
64
64
|
verifies: "// @trace.verifies={UC-ID}"
|
|
65
65
|
test_type: "// @trace.test_type=unit|integration"
|
package/package.json
CHANGED
|
@@ -1,49 +1,50 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@educa-corp/sdd-framework",
|
|
3
|
-
"version": "0.4.
|
|
4
|
-
"description": "Spec Driven Development workflow framework for Claude Code",
|
|
5
|
-
"bin": {
|
|
6
|
-
"sdd-framework": "./bin/index.js"
|
|
7
|
-
},
|
|
8
|
-
"scripts": {
|
|
9
|
-
"build": "node bin/build.js",
|
|
10
|
-
"prepublishOnly": "node bin/build.js",
|
|
11
|
-
"pub": "npm publish --access=public",
|
|
12
|
-
"dev": "node bin/build.js && node bin/index.js --init",
|
|
13
|
-
"prepack": "node -e \"const fs=require('fs'); ['README.md','PUBLISHING.md','SETUP_GUIDE.md'].forEach(f=>{ if(fs.existsSync(f)) fs.renameSync(f,'__'+f); });\"",
|
|
14
|
-
"postpack": "node -e \"const fs=require('fs'); ['README.md','PUBLISHING.md','SETUP_GUIDE.md'].forEach(f=>{ if(fs.existsSync('__'+f)) fs.renameSync('__'+f,f); });\""
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
"
|
|
19
|
-
"
|
|
20
|
-
"
|
|
21
|
-
"
|
|
22
|
-
"
|
|
23
|
-
"
|
|
24
|
-
"
|
|
25
|
-
"
|
|
26
|
-
"
|
|
27
|
-
"
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
"
|
|
32
|
-
"
|
|
33
|
-
"
|
|
34
|
-
"
|
|
35
|
-
"
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
"
|
|
39
|
-
"
|
|
40
|
-
|
|
41
|
-
"
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@educa-corp/sdd-framework",
|
|
3
|
+
"version": "0.4.2",
|
|
4
|
+
"description": "Spec Driven Development workflow framework for Claude Code",
|
|
5
|
+
"bin": {
|
|
6
|
+
"sdd-framework": "./bin/index.js"
|
|
7
|
+
},
|
|
8
|
+
"scripts": {
|
|
9
|
+
"build": "node bin/build.js && node bin/self-check.js",
|
|
10
|
+
"prepublishOnly": "node bin/build.js && node bin/self-check.js",
|
|
11
|
+
"pub": "npm publish --access=public",
|
|
12
|
+
"dev": "node bin/build.js && node bin/index.js --init",
|
|
13
|
+
"prepack": "node -e \"const fs=require('fs'); ['README.md','PUBLISHING.md','SETUP_GUIDE.md'].forEach(f=>{ if(fs.existsSync(f)) fs.renameSync(f,'__'+f); });\"",
|
|
14
|
+
"postpack": "node -e \"const fs=require('fs'); ['README.md','PUBLISHING.md','SETUP_GUIDE.md'].forEach(f=>{ if(fs.existsSync('__'+f)) fs.renameSync('__'+f,f); });\"",
|
|
15
|
+
"self-check": "node bin/self-check.js"
|
|
16
|
+
},
|
|
17
|
+
"files": [
|
|
18
|
+
"bin/",
|
|
19
|
+
"commands/",
|
|
20
|
+
"core/",
|
|
21
|
+
"hooks/",
|
|
22
|
+
"modules/",
|
|
23
|
+
"rules/",
|
|
24
|
+
"scripts/",
|
|
25
|
+
"skills/",
|
|
26
|
+
"steps/",
|
|
27
|
+
"templates/",
|
|
28
|
+
"docs/"
|
|
29
|
+
],
|
|
30
|
+
"keywords": [
|
|
31
|
+
"claude-code",
|
|
32
|
+
"spec-driven",
|
|
33
|
+
"ai-first",
|
|
34
|
+
"bdd",
|
|
35
|
+
"traceability",
|
|
36
|
+
"workflow"
|
|
37
|
+
],
|
|
38
|
+
"author": "duclm2 <duclm2@edupia.com.vn>",
|
|
39
|
+
"license": "MIT",
|
|
40
|
+
"repository": {
|
|
41
|
+
"type": "git",
|
|
42
|
+
"url": "https://github.com/duclm2/sdd-framework"
|
|
43
|
+
},
|
|
44
|
+
"engines": {
|
|
45
|
+
"node": ">=14"
|
|
46
|
+
},
|
|
47
|
+
"publishConfig": {
|
|
48
|
+
"access": "public"
|
|
49
|
+
}
|
|
50
|
+
}
|
package/rules/workflow.md
CHANGED
|
@@ -18,6 +18,17 @@
|
|
|
18
18
|
- Do NOT create files outside the directories specified in `project-context.yaml → paths`.
|
|
19
19
|
- If new scope is discovered mid-command, STOP and ask: "I found additional scope [{description}]. Should I include it? (Y/N)"
|
|
20
20
|
|
|
21
|
+
## Trace Contract
|
|
22
|
+
|
|
23
|
+
- Contract trace (field `@trace.*`, cột `.tsv`, path pattern, giá trị enum) có **một
|
|
24
|
+
nguồn-sự-thật máy đọc**: `bin/trace-schema.json`. Bản cho người đọc:
|
|
25
|
+
`docs/04-reference/trace-schema.md` — giữ hai file đồng bộ.
|
|
26
|
+
- Đổi contract (thêm/bỏ/đổi nghĩa một field, path, hay giá trị enum) → **sửa
|
|
27
|
+
`bin/trace-schema.json` TRƯỚC**, rồi mới sửa lệnh. `npm run build` chạy
|
|
28
|
+
`bin/self-check.js` và **fail** nếu lệnh lệch schema.
|
|
29
|
+
- Field có consumer mà **không có producer** là lỗi chặn build — đó chính là hình dạng
|
|
30
|
+
của G1 (`@trace.sc_version`: 3 consumer, 0 producer, DRIFT chết mà không ai báo).
|
|
31
|
+
|
|
21
32
|
## Code Generation
|
|
22
33
|
|
|
23
34
|
- Never generate code for files not backed by a `.feature` spec (unless `/fix-bug` or `/debug`).
|
|
@@ -0,0 +1,286 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
/**
|
|
3
|
+
* migrate-bdd-platform — move flat BDD files into the per-platform layout.
|
|
4
|
+
*
|
|
5
|
+
* specs/{domain}/{prd-slug}/bdd/{FILE}.feature
|
|
6
|
+
* → specs/{domain}/{prd-slug}/bdd/{platform}/{FILE}.feature
|
|
7
|
+
*
|
|
8
|
+
* The flat layout was produced by the umbrella-mode branch of /generate-bdd before
|
|
9
|
+
* v0.4.1 (see GAPS.md G3). It breaks five consumers — most importantly `web` and
|
|
10
|
+
* `system` features of the same UC collide on one filename and overwrite each other.
|
|
11
|
+
*
|
|
12
|
+
* The {platform} for each file is resolved in this order:
|
|
13
|
+
* 1. `# @trace.platform:` in the file header (authoritative)
|
|
14
|
+
* 2. `# @trace.module:` mapped through MODULE_PLATFORM (umbrella files carry it)
|
|
15
|
+
* 3. Gherkin step vocabulary ("clicks"→web, "taps"→app, "calls the API"→system)
|
|
16
|
+
* Files that cannot be resolved are LEFT IN PLACE and listed — never moved to a guess.
|
|
17
|
+
*
|
|
18
|
+
* After moving, `@trace.platform` is INSERTED into the header if it was missing
|
|
19
|
+
* (it is mandatory in every mode), and internal path references to the moved files
|
|
20
|
+
* are rewritten across specs/ and .trace/.
|
|
21
|
+
*
|
|
22
|
+
* Also reports (does NOT fix) two conditions that need a human:
|
|
23
|
+
* - OCCUPIED : the target path already holds a file (mixed/partial layout) — moving
|
|
24
|
+
* would overwrite it, so the flat file is left in place instead
|
|
25
|
+
* - LOST SPEC : a UC has N trace books ({UC}-{platform}.tsv) but fewer flat files
|
|
26
|
+
* than N → a previous run likely overwrote a platform's .feature
|
|
27
|
+
*
|
|
28
|
+
* DRY-RUN by default (prints the plan, changes nothing). Pass --apply to execute.
|
|
29
|
+
* Tracked files move with `git mv` to preserve history; the rest with fs.rename.
|
|
30
|
+
*
|
|
31
|
+
* Usage (from the consumer project root):
|
|
32
|
+
* node scripts/migrate-bdd-platform.js # dry-run, prints plan
|
|
33
|
+
* node scripts/migrate-bdd-platform.js --apply # execute
|
|
34
|
+
* node scripts/migrate-bdd-platform.js --specs specs --trace .trace --root .
|
|
35
|
+
*/
|
|
36
|
+
|
|
37
|
+
const fs = require('fs');
|
|
38
|
+
const path = require('path');
|
|
39
|
+
const { execSync } = require('child_process');
|
|
40
|
+
|
|
41
|
+
// ── args ──────────────────────────────────────────────────────────────────────
|
|
42
|
+
const argv = process.argv.slice(2);
|
|
43
|
+
const has = f => argv.includes(f);
|
|
44
|
+
const flag = (f, d) => { const i = argv.indexOf(f); return i !== -1 ? argv[i + 1] : d; };
|
|
45
|
+
|
|
46
|
+
const APPLY = has('--apply');
|
|
47
|
+
const ROOT = path.resolve(flag('--root', '.'));
|
|
48
|
+
const SPECS = flag('--specs', 'specs');
|
|
49
|
+
const TRACE = flag('--trace', '.trace');
|
|
50
|
+
|
|
51
|
+
const specsAbs = path.join(ROOT, SPECS);
|
|
52
|
+
const traceAbs = path.join(ROOT, TRACE);
|
|
53
|
+
|
|
54
|
+
const PLATFORMS = ['web', 'app', 'system'];
|
|
55
|
+
|
|
56
|
+
// module → platform (same table as /generate-bdd §Service Detection)
|
|
57
|
+
const MODULE_PLATFORM = {
|
|
58
|
+
react: 'web', nextjs: 'web', vue: 'web', nuxt: 'web', angular: 'web',
|
|
59
|
+
flutter: 'app', 'react-native': 'app', 'ios-swiftui': 'app', 'android-compose': 'app',
|
|
60
|
+
'java-spring': 'system', golang: 'system', dotnet: 'system', 'php-laravel': 'system',
|
|
61
|
+
'context-engineering': 'system', 'phaser-game': 'web',
|
|
62
|
+
};
|
|
63
|
+
|
|
64
|
+
// ── git tracked set (for `git mv`) ────────────────────────────────────────────
|
|
65
|
+
let tracked = null;
|
|
66
|
+
try {
|
|
67
|
+
const out = execSync('git ls-files', { cwd: ROOT, encoding: 'utf8', stdio: ['ignore', 'pipe', 'ignore'] });
|
|
68
|
+
tracked = new Set(out.split('\n').filter(Boolean).map(p => p.replace(/\\/g, '/')));
|
|
69
|
+
} catch { tracked = null; }
|
|
70
|
+
|
|
71
|
+
const rel = abs => path.relative(ROOT, abs).replace(/\\/g, '/');
|
|
72
|
+
const isTracked = abs => !!(tracked && tracked.has(rel(abs)));
|
|
73
|
+
|
|
74
|
+
// ── helpers ───────────────────────────────────────────────────────────────────
|
|
75
|
+
function walk(dir) {
|
|
76
|
+
const out = [];
|
|
77
|
+
if (!fs.existsSync(dir)) return out;
|
|
78
|
+
for (const e of fs.readdirSync(dir, { withFileTypes: true })) {
|
|
79
|
+
const p = path.join(dir, e.name);
|
|
80
|
+
if (e.isDirectory()) out.push(...walk(p));
|
|
81
|
+
else out.push(p);
|
|
82
|
+
}
|
|
83
|
+
return out;
|
|
84
|
+
}
|
|
85
|
+
const read = file => { try { return fs.readFileSync(file, 'utf8'); } catch { return ''; } };
|
|
86
|
+
|
|
87
|
+
const rePlatform = /^#\s*@trace\.platform\s*:\s*([A-Za-z-]+)\s*$/m;
|
|
88
|
+
const reModule = /^#\s*@trace\.module\s*:\s*([A-Za-z0-9-]+)\s*$/m;
|
|
89
|
+
const reUcId = /^#\s*@trace\.id\s*:\s*([A-Za-z0-9_-]+)\s*$/m;
|
|
90
|
+
|
|
91
|
+
/** Resolve platform for one flat .feature file. Returns {platform, via} or null. */
|
|
92
|
+
function resolvePlatform(body) {
|
|
93
|
+
const tagged = (body.match(rePlatform) || [])[1];
|
|
94
|
+
if (tagged && PLATFORMS.includes(tagged)) return { platform: tagged, via: '@trace.platform' };
|
|
95
|
+
|
|
96
|
+
const mod = (body.match(reModule) || [])[1];
|
|
97
|
+
if (mod && MODULE_PLATFORM[mod]) return { platform: MODULE_PLATFORM[mod], via: `@trace.module=${mod}` };
|
|
98
|
+
|
|
99
|
+
// last resort: step vocabulary (see the per-platform table in /generate-bdd)
|
|
100
|
+
const steps = body.toLowerCase();
|
|
101
|
+
const web = /\b(clicks|types into|the page shows)\b/.test(steps);
|
|
102
|
+
const app = /\b(taps|the screen shows)\b/.test(steps);
|
|
103
|
+
const sys = /\b(calls the api|submits a request|the system returns|receives response)\b/.test(steps);
|
|
104
|
+
const hits = [web && 'web', app && 'app', sys && 'system'].filter(Boolean);
|
|
105
|
+
if (hits.length === 1) return { platform: hits[0], via: 'step vocabulary' };
|
|
106
|
+
|
|
107
|
+
return null;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
/** Trace books present for a UC, e.g. {UC}-web.tsv → ['web'] */
|
|
111
|
+
function tracePlatformsFor(ucId) {
|
|
112
|
+
const found = new Set();
|
|
113
|
+
for (const f of walk(traceAbs).filter(f => f.endsWith('.tsv'))) {
|
|
114
|
+
const m = path.basename(f).match(/^(.+)-(web|app|system)\.tsv$/);
|
|
115
|
+
if (m && m[1] === ucId) found.add(m[2]);
|
|
116
|
+
}
|
|
117
|
+
return [...found];
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
// ── plan ──────────────────────────────────────────────────────────────────────
|
|
121
|
+
const moves = []; // { from, to, platform, via, needsTag }
|
|
122
|
+
const unresolved = []; // { file, reason }
|
|
123
|
+
const occupied = []; // { from, to } — target already exists (mixed layout)
|
|
124
|
+
const lostSpecs = []; // { ucId, flat, traceBooks[] }
|
|
125
|
+
|
|
126
|
+
const bddDirs = new Set();
|
|
127
|
+
for (const f of walk(specsAbs).filter(f => f.endsWith('.feature'))) {
|
|
128
|
+
const parts = rel(f).split('/');
|
|
129
|
+
const i = parts.lastIndexOf('bdd');
|
|
130
|
+
if (i === -1) continue;
|
|
131
|
+
// flat == the file sits DIRECTLY under bdd/ (no platform subfolder)
|
|
132
|
+
if (parts.length !== i + 2) continue;
|
|
133
|
+
bddDirs.add(parts.slice(0, i + 1).join('/'));
|
|
134
|
+
|
|
135
|
+
const body = read(f);
|
|
136
|
+
const res = resolvePlatform(body);
|
|
137
|
+
if (!res) {
|
|
138
|
+
unresolved.push({
|
|
139
|
+
file: rel(f),
|
|
140
|
+
reason: 'no @trace.platform, no recognizable @trace.module, and step vocabulary is ambiguous ' +
|
|
141
|
+
'→ add `# @trace.platform: web|app|system` to the header, then re-run',
|
|
142
|
+
});
|
|
143
|
+
continue;
|
|
144
|
+
}
|
|
145
|
+
const dir = path.dirname(f);
|
|
146
|
+
const target = path.join(dir, res.platform, path.basename(f));
|
|
147
|
+
|
|
148
|
+
// Mixed layout: some platforms already migrated, this one left flat. Moving onto an
|
|
149
|
+
// existing file would silently overwrite a real spec — leave it and let a human look.
|
|
150
|
+
if (fs.existsSync(target)) { occupied.push({ from: f, to: target }); continue; }
|
|
151
|
+
|
|
152
|
+
moves.push({
|
|
153
|
+
from: f,
|
|
154
|
+
to: target,
|
|
155
|
+
platform: res.platform,
|
|
156
|
+
via: res.via,
|
|
157
|
+
needsTag: res.via !== '@trace.platform',
|
|
158
|
+
});
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
// lost-spec detection: UC has more trace books than flat files
|
|
162
|
+
const flatByUc = new Map();
|
|
163
|
+
for (const m of moves) {
|
|
164
|
+
const uc = (read(m.from).match(reUcId) || [])[1] || path.basename(m.from).replace(/\.feature$/, '');
|
|
165
|
+
flatByUc.set(uc, [...(flatByUc.get(uc) || []), m]);
|
|
166
|
+
}
|
|
167
|
+
for (const [ucId, list] of flatByUc) {
|
|
168
|
+
const books = tracePlatformsFor(ucId);
|
|
169
|
+
if (books.length > list.length) {
|
|
170
|
+
lostSpecs.push({ ucId, flat: list.map(m => m.platform), traceBooks: books });
|
|
171
|
+
}
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
const refMap = new Map();
|
|
175
|
+
for (const m of moves) refMap.set(rel(m.from), rel(m.to));
|
|
176
|
+
|
|
177
|
+
// ── report ────────────────────────────────────────────────────────────────────
|
|
178
|
+
console.log('');
|
|
179
|
+
console.log('╔════════════════════════════════════════════════╗');
|
|
180
|
+
console.log(`║ migrate-bdd-platform — ${APPLY ? 'APPLY' : 'DRY RUN'}${' '.repeat(APPLY ? 16 : 14)}║`);
|
|
181
|
+
console.log('╚════════════════════════════════════════════════╝');
|
|
182
|
+
console.log(`Root : ${ROOT}`);
|
|
183
|
+
console.log(`Specs : ${SPECS}/ Trace: ${TRACE}/ Git: ${tracked ? 'yes (git mv)' : 'no (fs move)'}`);
|
|
184
|
+
console.log('');
|
|
185
|
+
|
|
186
|
+
if (!moves.length && !unresolved.length && !occupied.length) {
|
|
187
|
+
console.log(`Nothing to migrate — no .feature file sits directly under a bdd/ folder.`);
|
|
188
|
+
console.log(`(Scanned ${bddDirs.size} bdd/ folder(s) under ${SPECS}/.)`);
|
|
189
|
+
process.exit(0);
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
const byPlatform = moves.reduce((a, m) => ((a[m.platform] = (a[m.platform] || 0) + 1), a), {});
|
|
193
|
+
console.log(`Planned moves: ${moves.length} (${Object.entries(byPlatform).map(([k, v]) => `${k}:${v}`).join(' ')})`);
|
|
194
|
+
console.log('');
|
|
195
|
+
for (const m of moves) {
|
|
196
|
+
console.log(` ${rel(m.from)}`);
|
|
197
|
+
console.log(` → ${rel(m.to)} [platform via ${m.via}${m.needsTag ? ' · will INSERT @trace.platform' : ''}]`);
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
if (occupied.length) {
|
|
201
|
+
console.log('');
|
|
202
|
+
console.log(`🔴 OCCUPIED — ${occupied.length} target path already holds a file (mixed/partial layout).`);
|
|
203
|
+
console.log(` NOT moved — that would overwrite a real spec.`);
|
|
204
|
+
for (const o of occupied) console.log(` ${rel(o.from)}\n target exists: ${rel(o.to)}`);
|
|
205
|
+
console.log(` → Diff the two files. Keep the right one, delete the other, then re-run.`);
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
if (lostSpecs.length) {
|
|
209
|
+
console.log('');
|
|
210
|
+
console.log(`🔴 LOST SPEC — a UC has more trace books than flat .feature files.`);
|
|
211
|
+
console.log(` A previous flat-layout run very likely OVERWROTE one platform's .feature.`);
|
|
212
|
+
console.log(` Migration cannot recover it — restore from git history, or re-run /generate-bdd`);
|
|
213
|
+
console.log(` for the missing platform AFTER this migration.`);
|
|
214
|
+
for (const l of lostSpecs) {
|
|
215
|
+
console.log(` ${l.ucId}: flat file(s) resolve to [${l.flat.join(', ')}] but trace books exist for [${l.traceBooks.join(', ')}]`);
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
if (unresolved.length) {
|
|
220
|
+
console.log('');
|
|
221
|
+
console.log(`⚠️ Unresolved (LEFT IN PLACE):`);
|
|
222
|
+
for (const u of unresolved) console.log(` ${u.file}\n ${u.reason}`);
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
console.log('');
|
|
226
|
+
if (!APPLY) {
|
|
227
|
+
console.log('DRY RUN — nothing changed. Re-run with --apply to execute.');
|
|
228
|
+
process.exit(0);
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
// ── apply ─────────────────────────────────────────────────────────────────────
|
|
232
|
+
function mv(from, to) {
|
|
233
|
+
fs.mkdirSync(path.dirname(to), { recursive: true });
|
|
234
|
+
if (isTracked(from)) execSync(`git mv -k "${rel(from)}" "${rel(to)}"`, { cwd: ROOT, stdio: ['ignore', 'ignore', 'pipe'] });
|
|
235
|
+
else fs.renameSync(from, to);
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
/** Insert `# @trace.platform:` right after `# @trace.domain:` (or after @trace.id). */
|
|
239
|
+
function insertPlatformTag(absFile, platform) {
|
|
240
|
+
const txt = read(absFile);
|
|
241
|
+
if (rePlatform.test(txt)) return false;
|
|
242
|
+
const lines = txt.split('\n');
|
|
243
|
+
let at = lines.findIndex(l => /^#\s*@trace\.domain\s*:/.test(l));
|
|
244
|
+
if (at === -1) at = lines.findIndex(l => /^#\s*@trace\.id\s*:/.test(l));
|
|
245
|
+
if (at === -1) return false;
|
|
246
|
+
lines.splice(at + 1, 0, `# @trace.platform: ${platform}`);
|
|
247
|
+
fs.writeFileSync(absFile, lines.join('\n'), 'utf8');
|
|
248
|
+
return true;
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
function rewriteRefs(absFile) {
|
|
252
|
+
if (!/\.(md|feature|tsv|ya?ml|json)$/.test(absFile)) return 0;
|
|
253
|
+
let txt = read(absFile);
|
|
254
|
+
if (!txt) return 0;
|
|
255
|
+
let n = 0, out = txt;
|
|
256
|
+
for (const [oldRef, newRef] of refMap) {
|
|
257
|
+
if (out.includes(oldRef)) { out = out.split(oldRef).join(newRef); n++; }
|
|
258
|
+
}
|
|
259
|
+
if (n) fs.writeFileSync(absFile, out, 'utf8');
|
|
260
|
+
return n;
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
let moved = 0, tagged = 0, skipped = 0;
|
|
264
|
+
for (const m of moves) {
|
|
265
|
+
try {
|
|
266
|
+
mv(m.from, m.to);
|
|
267
|
+
moved++;
|
|
268
|
+
if (m.needsTag && insertPlatformTag(m.to, m.platform)) tagged++;
|
|
269
|
+
} catch (err) {
|
|
270
|
+
console.log(` ❌ ${rel(m.from)} — ${err.message.split('\n')[0]}`);
|
|
271
|
+
skipped++;
|
|
272
|
+
}
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
let rewritten = 0;
|
|
276
|
+
for (const f of [...walk(specsAbs), ...walk(traceAbs)]) rewritten += rewriteRefs(f) ? 1 : 0;
|
|
277
|
+
|
|
278
|
+
console.log(`✅ Moved ${moved} file(s)${skipped ? `, skipped ${skipped}` : ''}.`);
|
|
279
|
+
console.log(`✅ Inserted @trace.platform into ${tagged} header(s).`);
|
|
280
|
+
console.log(`✅ Rewrote path references in ${rewritten} file(s).`);
|
|
281
|
+
console.log('');
|
|
282
|
+
console.log('Next:');
|
|
283
|
+
console.log(' 1. git diff — review the moves + inserted headers');
|
|
284
|
+
console.log(' 2. /validate-traces — reconcile trace books against the new layout');
|
|
285
|
+
console.log(' 3. Commit (spec repo, if specs live in a submodule)');
|
|
286
|
+
console.log('');
|
package/steps/gate.md
CHANGED
|
@@ -29,23 +29,23 @@ Hiển thị và chờ phản hồi:
|
|
|
29
29
|
```
|
|
30
30
|
⚙️ MODEL CHECK
|
|
31
31
|
──────────────────────────────────────────────────────────────────
|
|
32
|
-
Recommended :
|
|
32
|
+
Recommended : model Opus mới nhất
|
|
33
33
|
Why needed : Phân tích spec, review kiến trúc, sinh code đòi hỏi
|
|
34
|
-
suy luận sâu. Model nhỏ hơn dễ bỏ sót edge case.
|
|
34
|
+
suy luận sâu. Model nhỏ hơn (Haiku/Sonnet) dễ bỏ sót edge case.
|
|
35
35
|
|
|
36
36
|
Cách đổi trong Claude Code:
|
|
37
|
-
•
|
|
38
|
-
• hoặc:
|
|
37
|
+
• /model → chọn model Opus
|
|
38
|
+
• hoặc: Settings → Model
|
|
39
39
|
|
|
40
|
-
Đang chạy
|
|
41
|
-
Y — đúng
|
|
40
|
+
Đang chạy một model Opus?
|
|
41
|
+
Y — đúng → tiếp tục
|
|
42
42
|
S — bỏ qua kiểm tra (tôi chấp nhận rủi ro chất lượng thấp hơn với model hiện tại)
|
|
43
43
|
──────────────────────────────────────────────────────────────────
|
|
44
44
|
```
|
|
45
45
|
|
|
46
46
|
- "Y" → tiếp tục sang Bước 1.
|
|
47
47
|
- "S" → tiếp tục sang Bước 1 (người dùng chấp nhận rủi ro, thêm ⚠️ vào report cuối).
|
|
48
|
-
- "N" hoặc bất kỳ giá trị nào khác → **DỪNG.** Xuất: "Vui lòng chuyển sang
|
|
48
|
+
- "N" hoặc bất kỳ giá trị nào khác → **DỪNG.** Xuất: "Vui lòng chuyển sang một model Opus (`/model`) rồi chạy lại lệnh này."
|
|
49
49
|
|
|
50
50
|
## Bước 1 — Xác định Target File
|
|
51
51
|
|
|
@@ -54,7 +54,12 @@ Hiển thị và chờ phản hồi:
|
|
|
54
54
|
2. Nếu `$ARGUMENTS` là một **UC-ID / ticket ID / tên rút gọn** (không có path) → phân giải thành file bằng cách glob theo bố cục feature-package. `{prd-slug}` lúc này **chưa biết**, nên dùng wildcard `*` cho segment đó, và `**` đệ quy dưới `bdd/` để phủ hết các thư mục con theo platform (`bdd/web/`, `bdd/app/`, `bdd/system/`):
|
|
55
55
|
- **Lệnh BDD** (target là `.feature`): `{specs_dir}/{domain}/*/bdd/**/{UC-ID}*.feature` — hoặc `{specs_dir}/*/*/bdd/**/{UC-ID}*.feature` nếu domain cũng chưa biết. Nếu lệnh ngụ ý một platform/scope cụ thể (vd: system tech-doc cần BDD `system/`), ưu tiên kết quả trong thư mục con platform đó.
|
|
56
56
|
- **Lệnh PRD** (target là file PRD `{TICKET-ID}-{prd-slug}.md` — file `.md` duy nhất ở gốc feature folder, cạnh `bdd/`): `{specs_dir}/{domain}/*/{TICKET-ID}*.md` nếu biết TICKET-ID; nếu không, `{specs_dir}/{domain}/*/*.md` (khớp feature folder có id tương ứng), hoặc `{specs_dir}/*/*/*.md` nếu domain cũng chưa biết. *(Glob `*/*.md` ở cấp gốc folder chỉ khớp PRD — tech-docs/design-spec `.md` nằm sâu hơn trong thư mục con.)*
|
|
57
|
-
- **Lệnh tech-docs
|
|
57
|
+
- **Lệnh tech-docs** — target là tech-doc **gộp cấp PRD** `{TICKET-ID}-tech-design.md` (MỘT doc phủ nhiều UC; danh sách UC nằm ở `@trace.ucs`). Vì tên file mang `{TICKET-ID}` chứ **không** mang `{UC-ID}`, phải tách trước khi glob:
|
|
58
|
+
- `$ARGUMENTS` là **UC-ID** (`{TICKET-ID}-UC{N}`) → lấy `{TICKET-ID}` = phần **trước** `-UC`, rồi glob `{specs_dir}/{domain}/*/tech-docs/{TICKET-ID}-tech-design.md`.
|
|
59
|
+
- `$ARGUMENTS` là **TICKET-ID** → glob trực tiếp như trên.
|
|
60
|
+
- Chưa biết domain → `{specs_dir}/*/*/tech-docs/{TICKET-ID}-tech-design.md`.
|
|
61
|
+
- Vẫn không khớp → glob rộng `{specs_dir}/*/*/tech-docs/*tech-design*.md` rồi liệt kê để người dùng chọn.
|
|
62
|
+
*(Đừng glob `{UC-ID}*-tech-design*.md` — nó nở thành `FT-001-UC1*-tech-design*.md` và **không bao giờ** khớp `FT-001-tech-design.md`.)*
|
|
58
63
|
- **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
59
64
|
|
|
60
65
|
Khi một file khớp: đặt nó làm target **và** ghi lại `domain` + `prd_slug` từ path của nó (theo quy tắc trích xuất trong `context-loader.md` Bước 1 — `prd_slug` = segment đầu tiên sau `{specs_dir}/{domain}/`). Mọi path mà lệnh đọc/ghi về sau (BDD/tech-docs/design-spec/trace cùng cấp) đều dùng **`prd_slug` đã phân giải đó**, nên tất cả artifact nằm chung một feature package. Nếu nhiều file khớp (vd: nhiều platform), chọn theo platform/scope của lệnh hoặc liệt kê ra và hỏi.
|
package/steps/report-footer.md
CHANGED
|
@@ -71,6 +71,7 @@ Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
|
71
71
|
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
72
72
|
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
73
73
|
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
74
|
+
| /map-testids | `/qc-design-test {UC-ID}` (QC dựng Page Object từ contract §4.5.6 vừa ghi) |
|
|
74
75
|
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
75
76
|
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
76
77
|
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
@@ -79,8 +80,8 @@ Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
|
79
80
|
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
80
81
|
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
81
82
|
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
82
|
-
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}
|
|
83
|
-
| /fix-bug |
|
|
83
|
+
| /validate-traces | **Cờ 🔴 trước (chặn PR):** SEAM_UNWIRED → nối binding sang class thật, xoá/thay stub · STUB_UNRESOLVED → `/generate-code {owner_uc}` (lấp logic tại chỗ + xoá hàm song song) · ORPHANED/TRACE_ORPHAN → quyết định thủ công (xoá code+test, đưa scenario trở lại `.feature`, hoặc sửa `sc_id` của tag). **Rồi:** DRIFT/UNTRACKED → `/generate-code {UC-ID}` · BDD_DRIFT → `/generate-code {feature-file}` · tech-doc lỗi thời vs BDD → `/generate-tech-docs` → `/review-tech-docs` · PRD drift → `/generate-bdd {prd-file}` · GAP → `/dev-gen-test {UC-ID}`. **Chỉ tạo PR khi mọi cờ 🔴 = 0** |
|
|
84
|
+
| /fix-bug | `/dev-run-test {UC-ID}` (dev_selftest vừa reset về not_run) → tạo PR; nếu fix một `{BUG-ID}` → QC chạy `/qc-run-test {UC-ID}` để verify + đóng bug |
|
|
84
85
|
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
85
86
|
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
86
87
|
| /propose-scenario | Báo PO/Dev review proposal trong `feedback/bdd-proposals/` |
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# templates/ — build-time skeletons
|
|
2
|
+
|
|
3
|
+
> **Nếu bạn đang mở thư mục này ở `.agent/templates/` trong một project: sửa file ở đây KHÔNG có tác dụng.**
|
|
4
|
+
|
|
5
|
+
## Vì sao
|
|
6
|
+
|
|
7
|
+
Các skeleton trong thư mục này được `{{include}}` **nướng cứng vào file lệnh lúc `npm run build`**:
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
templates/feature.template
|
|
11
|
+
↓ {{include:templates/feature.template}} ← bin/build.js, thay thế văn bản lúc build
|
|
12
|
+
commands/generate-bdd.md
|
|
13
|
+
↓ copy vào core/ → mirror sang .agent/
|
|
14
|
+
.agent/commands/generate-bdd.md ← LỆNH THẬT SỰ CHẠY (đã chứa sẵn skeleton)
|
|
15
|
+
.agent/templates/feature.template ← bản tham khảo, KHÔNG lệnh nào đọc
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Không lệnh nào đọc một path template lúc chạy. `paths.feature_template` / `paths.prd_template` từng tồn tại trong `project-context.yaml` nhưng chưa bao giờ có tác dụng — đã được gỡ bỏ (xem `GAPS.md` G9).
|
|
19
|
+
|
|
20
|
+
**Thêm nữa:** `.agent/` là vùng bị ghi đè. `/update-framework` chạy `npx … --init`, và `--init` copy `core/` → `.agent/` **vô điều kiện** (`bin/index.js` → `copyDirRecursive`, không có existence check, không backup). File duy nhất được giữ lại là `.agent/project-context.yaml`. Nên mọi chỉnh sửa ở `.agent/templates/` sẽ **biến mất im lặng** ở lần nâng cấp kế tiếp.
|
|
21
|
+
|
|
22
|
+
## Muốn đổi cấu trúc artifact sinh ra thì làm gì
|
|
23
|
+
|
|
24
|
+
Sửa file trong **repo framework** rồi build lại:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
# trong repo sdd-framework
|
|
28
|
+
vim templates/feature.template # hoặc prd.template.md, tech-design.template.md, …
|
|
29
|
+
npm run build # inline lại vào commands/*.md + core/ + .agent/
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Rồi phát hành version mới; project chạy `/update-framework` để nhận.
|
|
33
|
+
|
|
34
|
+
## File nào ở đây đi vào đâu
|
|
35
|
+
|
|
36
|
+
| Template | Được include vào | Trở thành |
|
|
37
|
+
|---|---|---|
|
|
38
|
+
| `feature.template` | `commands/generate-bdd.tmpl` | mỗi file `.feature` |
|
|
39
|
+
| `prd.template.md` | `commands/generate-prd.tmpl` | mỗi PRD |
|
|
40
|
+
| `tech-design.template.md` | `commands/generate-tech-docs.tmpl` | tech-doc gộp / PRD |
|
|
41
|
+
| `design-spec.template.md` | `commands/generate-design-spec.tmpl` | design-spec / platform |
|
|
42
|
+
| `architecture.template.md` | `commands/generate-architecture.tmpl` | tài liệu kiến trúc |
|
|
43
|
+
| `product-definition.template.md` | `commands/define-product.tmpl` | product definition |
|
|
44
|
+
| `platform-guide.template.md` | (tham khảo) | — |
|
|
45
|
+
| `project-context.yaml` | **không** include — được copy thẳng làm file config khởi tạo | `.agent/project-context.yaml` |
|
|
46
|
+
|
|
47
|
+
> Lưu ý `project-context.yaml` là ngoại lệ duy nhất: nó **được** copy ra làm file thật của project, và **được bảo vệ** khỏi ghi đè khi nâng cấp (chỉ tạo nếu chưa tồn tại).
|