@educa-corp/sdd-framework 0.3.0 → 0.4.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/commands/debug.md +66 -7
- package/commands/define-product.md +66 -7
- package/commands/dev-gen-test.md +66 -7
- package/commands/dev-run-test.md +66 -7
- package/commands/dev-smoke-test.md +66 -7
- package/commands/fix-bug.md +66 -7
- package/commands/generate-architecture.md +66 -7
- package/commands/generate-bdd.md +69 -9
- package/commands/generate-bdd.tmpl +3 -2
- package/commands/generate-code.md +66 -7
- package/commands/generate-design-spec.md +66 -7
- package/commands/generate-prd.md +66 -7
- package/commands/generate-spec-manifest.md +66 -7
- package/commands/generate-tech-docs.md +66 -7
- package/commands/learn.md +66 -7
- package/commands/map-testids.md +66 -7
- package/commands/propose-scenario.md +66 -7
- package/commands/qc-analyze.md +66 -7
- package/commands/qc-design-test.md +66 -7
- package/commands/qc-plan.md +66 -7
- package/commands/qc-report.md +66 -7
- package/commands/qc-review.md +66 -7
- package/commands/qc-run-test.md +66 -7
- package/commands/refine-prd.md +66 -7
- package/commands/report-bug.md +66 -7
- package/commands/review-code.md +66 -7
- package/commands/review-context.md +66 -7
- package/commands/review-tech-docs.md +66 -7
- package/commands/setup-ai-first.md +12 -2
- package/commands/setup-ai-first.tmpl +12 -2
- package/commands/sync.md +12 -2
- package/commands/sync.tmpl +12 -2
- package/commands/validate-traces.md +66 -7
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/commands/debug.md +66 -7
- package/core/commands/define-product.md +66 -7
- package/core/commands/dev-gen-test.md +66 -7
- package/core/commands/dev-run-test.md +66 -7
- package/core/commands/dev-smoke-test.md +66 -7
- package/core/commands/fix-bug.md +66 -7
- package/core/commands/generate-architecture.md +66 -7
- package/core/commands/generate-bdd.md +69 -9
- package/core/commands/generate-code.md +66 -7
- package/core/commands/generate-design-spec.md +66 -7
- package/core/commands/generate-prd.md +66 -7
- package/core/commands/generate-spec-manifest.md +66 -7
- package/core/commands/generate-tech-docs.md +66 -7
- package/core/commands/learn.md +66 -7
- package/core/commands/map-testids.md +66 -7
- package/core/commands/propose-scenario.md +66 -7
- package/core/commands/qc-analyze.md +66 -7
- package/core/commands/qc-design-test.md +66 -7
- package/core/commands/qc-plan.md +66 -7
- package/core/commands/qc-report.md +66 -7
- package/core/commands/qc-review.md +66 -7
- package/core/commands/qc-run-test.md +66 -7
- package/core/commands/refine-prd.md +66 -7
- package/core/commands/report-bug.md +66 -7
- package/core/commands/review-code.md +66 -7
- package/core/commands/review-context.md +66 -7
- package/core/commands/review-tech-docs.md +66 -7
- package/core/commands/setup-ai-first.md +12 -2
- package/core/commands/sync.md +12 -2
- package/core/commands/validate-traces.md +66 -7
- package/core/steps/context-loader.md +66 -7
- package/core/templates/project-context.yaml +23 -3
- package/package.json +1 -1
- package/steps/context-loader.md +66 -7
- package/templates/project-context.yaml +23 -3
package/steps/context-loader.md
CHANGED
|
@@ -90,23 +90,82 @@ Nếu có section `services`:
|
|
|
90
90
|
- Nếu target không mang `@trace.platform` (vd target là PRD `.md`), thử suy từ segment `bdd/{platform}/` trong path target.
|
|
91
91
|
- Nếu vẫn không xác định được → `active_platform = null`.
|
|
92
92
|
|
|
93
|
-
**2. Route tới service** — nếu active domain khớp một key trong `services`.
|
|
93
|
+
**2. Route tới service** — nếu active domain khớp một key trong `services`.
|
|
94
|
+
|
|
95
|
+
Hình dung việc này như **tra địa chỉ**: đi từ `domain`, có thể qua `platform`, có thể qua `prd_slug`, cho tới khi chỉ còn đúng một submodule.
|
|
96
|
+
|
|
97
|
+
Thứ trỏ tới đích gọi là một **service entry**. Nó chỉ có hai kiểu:
|
|
98
|
+
|
|
99
|
+
| Kiểu | Nhận ra bằng | Nghĩa |
|
|
100
|
+
|---|---|---|
|
|
101
|
+
| **Đã chốt** | có `path` | Xong — đây là submodule cần tìm |
|
|
102
|
+
| **Tra tiếp** | có `by_prd_slug` | Ô này còn nhiều submodule → tra thêm một nấc bằng `prd_slug` (2c) |
|
|
103
|
+
|
|
104
|
+
**Kiểm tra hợp lệ TRƯỚC khi dùng một entry** (làm ngay, đừng đợi tới 2a/2b/2c — sai ở đây mà đi tiếp là route nhầm repo mà không báo gì):
|
|
105
|
+
|
|
106
|
+
| Entry trông thế nào | Xử lý |
|
|
107
|
+
|---|---|
|
|
108
|
+
| có `path`, không có `by_prd_slug` | hợp lệ → dùng |
|
|
109
|
+
| có `by_prd_slug`, không có `path` | hợp lệ → tra tiếp (2c) |
|
|
110
|
+
| **có CẢ HAI** | ❌ lỗi cấu hình → `active_service = unresolved`. **KHÔNG** ưu tiên `path` rồi bỏ qua `by_prd_slug` — như vậy mọi feature sẽ âm thầm route về cùng một repo. Báo đúng key sai để người dùng sửa. |
|
|
111
|
+
| **không có cái nào** (và cũng không phải map platform) | ❌ lỗi cấu hình → `unresolved`, nêu rõ entry thiếu `path`/`by_prd_slug` |
|
|
112
|
+
| `by_prd_slug` chứa entry lại có `by_prd_slug` | ❌ lỗi cấu hình → `unresolved`. Chỉ tra đúng **một** nấc slug, không đệ quy |
|
|
113
|
+
|
|
114
|
+
Còn `services.{domain}` thì có thể là **một service entry** (chốt luôn ở cấp domain), hoặc **một map platform → service entry** (phải qua nấc platform trước). Nhận dạng theo đúng thứ tự này:
|
|
115
|
+
|
|
116
|
+
| Thấy gì trong `services.{domain}` | Đi nhánh |
|
|
117
|
+
|---|---|
|
|
118
|
+
| có `path` | **2a** — chốt luôn |
|
|
119
|
+
| có `by_prd_slug` | **2c** — tra bằng `prd_slug` |
|
|
120
|
+
| không có cả hai (chỉ có các sub-key `system`/`web`/`app`…) | **2b** — tra bằng `platform`, rồi lặp lại đúng bảng này cho entry con |
|
|
94
121
|
|
|
95
122
|
**2a. Dạng phẳng** — `services.{domain}` có **trực tiếp** `path`/`module` (một domain ↔ một service, mọi platform về cùng submodule). Route như cũ:
|
|
96
123
|
- Lưu `active_service` = `services.{domain}.path`
|
|
97
124
|
- Lưu `active_service_module` = `services.{domain}.module`
|
|
98
125
|
- Nếu service có `module` riêng → dùng nó làm `active_module` (override `tech_stack.module`)
|
|
99
126
|
|
|
100
|
-
**2b. Dạng map-theo-platform** — `services.{domain}` **KHÔNG** có `path` trực tiếp mà chứa các sub-key platform (`system` / `web` / `app`), mỗi cái là
|
|
101
|
-
- Nếu `active_platform` khớp một sub-key → `entry = services.{domain}.{active_platform}
|
|
102
|
-
- Nếu `active_platform = null` (chưa xác định platform, vd đang thao tác cấp PRD) → **KHÔNG** chốt một service; đặt `active_service = multi` và lưu `service_candidates =
|
|
127
|
+
**2b. Dạng map-theo-platform** — `services.{domain}` **KHÔNG** có `path` trực tiếp mà chứa các sub-key platform (`system` / `web` / `app`), mỗi cái là một **service entry** (một business-domain trải trên nhiều platform/submodule). Route theo `active_platform` (bước 1b):
|
|
128
|
+
- Nếu `active_platform` khớp một sub-key → `entry = services.{domain}.{active_platform}`. Nếu `entry` có `path` → lưu `active_service = entry.path`, `active_service_module = entry.module` (→ `active_module`, override `tech_stack.module`). Nếu `entry` có `by_prd_slug` → **đi tiếp sang 2c** với entry đó.
|
|
129
|
+
- Nếu `active_platform = null` (chưa xác định platform, vd đang thao tác cấp PRD) → **KHÔNG** chốt một service; đặt `active_service = multi`, `service_candidates_kind = platform`, và lưu `service_candidates` = map platform→`{path, module}`. **Làm phẳng luôn ở đây:** platform nào có entry `by_prd_slug` thì giải bằng `prd_slug` hiện tại (target cấp PRD vẫn nằm trong một feature-package nên `prd_slug` đã biết từ bước 1) → `service_candidates.{platform}` vẫn là `{path, module}` phẳng. Nếu `prd_slug` không khớp key nào, ghi platform đó là `unresolved` kèm lý do thay vì bỏ im. Nhờ vậy **mọi lệnh downstream chỉ cần biết một kiểu `service_candidates`**. Lệnh cần một service cụ thể (`/generate-code`, `/dev-*`, `/fix-bug`) luôn chạy trên target `.feature` có platform nên sẽ resolve được ở lần chạy đó; lệnh cấp PRD (`/generate-prd`, `/refine-prd`) không cần service cụ thể.
|
|
103
130
|
- Nếu `active_platform` xác định nhưng không có sub-key tương ứng → `active_service = unresolved` (xem Fallback) với lý do "domain `{domain}` chưa cấu hình platform `{active_platform}`".
|
|
104
131
|
|
|
105
|
-
|
|
132
|
+
**2c. Dạng map-theo-prd_slug** — một service entry chứa `by_prd_slug` thay cho `path`: **một ô của bảng định tuyến ứng với NHIỀU submodule**, mỗi feature-package một submodule. Dùng khi một platform (hoặc cả một domain) bị chia thành nhiều repo theo feature — ví dụ mỗi mini-game webview là một repo riêng.
|
|
133
|
+
|
|
134
|
+
Đến đây `prd_slug` đã được trích ở bước 1 (không cần detect thêm gì). Route:
|
|
135
|
+
|
|
136
|
+
- Nếu `prd_slug` khớp một key dưới `by_prd_slug` → `entry = {…}.by_prd_slug.{prd_slug}`; lưu `active_service = entry.path`, `active_service_module = entry.module` (→ `active_module`, override `tech_stack.module`).
|
|
137
|
+
**"Khớp" ở đây là khớp CHÍNH XÁC toàn chuỗi, phân biệt hoa/thường.** KHÔNG prefix, KHÔNG bỏ hậu tố, KHÔNG so gần đúng: `dap-chuot-v2` **không** khớp key `dap-chuot`; `Ban-Cung` **không** khớp `ban-cung`. Feature mới tách ra từ một feature cũ là một repo khác cho tới khi có người khai nó vào bảng.
|
|
138
|
+
- Nếu `prd_slug = null` (chưa xác định feature-package — chỉ xảy ra khi không có target file, vd `$ARGUMENTS` rỗng) → **KHÔNG** chốt một service; đặt `active_service = multi`, `service_candidates_kind = prd_slug`, và lưu `service_candidates` = toàn map `by_prd_slug` (slug → `{path, module}`).
|
|
139
|
+
⚠️ Đây là kiểu `service_candidates` **khác** với 2b — lệnh nào duyệt `service_candidates` theo platform (vd `/generate-bdd` sinh `bdd/{platform}/`) phải kiểm `service_candidates_kind = platform` trước; gặp `prd_slug` thì DỪNG và yêu cầu người dùng chỉ rõ target, đừng coi slug là platform.
|
|
140
|
+
- Nếu `prd_slug` xác định nhưng **không** có key tương ứng → `active_service = unresolved` với lý do rõ: "domain `{domain}`{, platform `{active_platform}`} chưa cấu hình prd_slug `{prd_slug}`". **KHÔNG** tự đoán submodule gần đúng theo tên.
|
|
141
|
+
|
|
142
|
+
Vị trí đặt `by_prd_slug` — hợp lệ ở **cả hai cấp**:
|
|
143
|
+
- **Dưới một platform** (lồng trong 2b): `services.{domain}.{platform}.by_prd_slug` — platform đó có nhiều repo, các platform khác vẫn `{path, module}` như thường.
|
|
144
|
+
- **Ngay dưới domain** (thay cho `path` của 2a): `services.{domain}.by_prd_slug` — domain không chia platform nhưng vẫn nhiều repo theo feature.
|
|
145
|
+
|
|
146
|
+
*(`by_prd_slug` lồng trong `by_prd_slug` là vô nghĩa — nếu gặp, coi là lỗi cấu hình: `active_service = unresolved`, nêu rõ để người dùng sửa file. Một entry vừa có `path` vừa có `by_prd_slug` cũng là lỗi cấu hình — báo lỗi, không âm thầm ưu tiên cái nào.)*
|
|
147
|
+
|
|
148
|
+
Ví dụ (một domain trải nhiều platform, riêng `webview` chia theo feature):
|
|
149
|
+
```yaml
|
|
150
|
+
services:
|
|
151
|
+
learning:
|
|
152
|
+
system: { path: "backend", module: "java-spring" }
|
|
153
|
+
web: { path: "web-app", module: "nextjs" }
|
|
154
|
+
webview:
|
|
155
|
+
by_prd_slug:
|
|
156
|
+
dap-chuot: { path: "games/whac-a-mole", module: "phaser-game" }
|
|
157
|
+
ban-cung: { path: "games/archery", module: "phaser-game" }
|
|
158
|
+
```
|
|
159
|
+
→ target `specs/learning/dap-chuot/bdd/webview/UC1.feature` cho `domain = learning`,
|
|
160
|
+
`active_platform = webview`, `prd_slug = dap-chuot` → `active_service = games/whac-a-mole`.
|
|
161
|
+
|
|
162
|
+
*(Cả 2a/2b/2c: override `paths.specs_dir`/`paths.tech_docs_dir` per-service CHỈ khi `setup.spec_source` KHÔNG được đặt. Khi `spec_source` ĐƯỢC đặt, MỌI BDD/tech-doc là artifact liên team → để bước 4 route sang spec repo; KHÔNG pin per-service ở đây.)*
|
|
106
163
|
|
|
107
164
|
**3. Fallback**:
|
|
108
165
|
- Không phát hiện được domain, hoặc domain không khớp key nào trong `services` → giữ path mặc định từ Bước 1, đặt `active_service = unresolved`.
|
|
109
166
|
- Domain khớp một map-theo-platform (2b) nhưng `active_platform` xác định mà thiếu sub-key tương ứng → `active_service = unresolved`, ghi lý do rõ để lệnh DỪNG báo lỗi cấu hình (không tự đoán platform).
|
|
167
|
+
- Entry là map-theo-prd_slug (2c) nhưng `prd_slug` xác định mà thiếu key tương ứng → `active_service = unresolved`, ghi lý do rõ (không tự đoán submodule).
|
|
168
|
+
- Entry sai cấu trúc (vừa có `path` vừa có `by_prd_slug`, hoặc `by_prd_slug` lồng nhau) → `active_service = unresolved`, nêu đúng key sai để người dùng sửa `project-context.yaml`.
|
|
110
169
|
|
|
111
170
|
**4. Tự động override theo spec source** — nếu `setup.spec_source` được đặt VÀ path tương ứng chưa được set tường minh trong `paths:`:
|
|
112
171
|
- Override `paths.specs_dir` → `{spec_source}/specs` — **luôn khi `spec_source` được đặt.** Mọi spec artifact (PRD, BDD, tech-docs, design-spec) nằm dưới gốc spec thống nhất trong spec repo dùng chung theo bố cục feature-package: `{spec_source}/specs/{domain}/{prd-slug}/`. Mọi umbrella (FE/App/BE) đều đọc từ đây. *(`specs/` theo service chỉ khi không có `spec_source`.)*
|
|
@@ -256,7 +315,7 @@ active_module = tech_stack.module (vd: "java-spring", "react", "flutter")
|
|
|
256
315
|
| `platform_type` | Modules |
|
|
257
316
|
|---|---|
|
|
258
317
|
| `backend` | `java-spring`, `golang`, `dotnet`, `php-laravel`, `context-engineering` |
|
|
259
|
-
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
|
|
318
|
+
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular`, `phaser-game` |
|
|
260
319
|
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
261
320
|
|
|
262
321
|
Nếu `tech_stack.module` rỗng hoặc không nhận diện được → set `platform_type = "unknown"` và gắn cờ ⚠️ trong recap Bước 7.
|
|
@@ -303,7 +362,7 @@ Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
|
303
362
|
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
304
363
|
Lessons : {loaded — N guardrails | chưa có}
|
|
305
364
|
Platform : {active_platform: system | web | app | — nếu chưa xác định}
|
|
306
|
-
Service : {active_service} ({active_service_module}) | multi (map-theo-platform, chốt khi target
|
|
365
|
+
Service : {active_service} ({active_service_module}) [← domain{/platform}{/prd_slug} nếu route qua by_prd_slug] | multi (map-theo-platform hoặc map-theo-prd_slug, chốt khi target đủ platform/prd_slug) | single-service
|
|
307
366
|
Svc Root : {service_root} — đã nạp conventions + trace_dir từ config service | —
|
|
308
367
|
Status : {FULL | PARTIAL — thiếu: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
309
368
|
```
|
|
@@ -139,8 +139,10 @@ domains:
|
|
|
139
139
|
#
|
|
140
140
|
# services: # domain → service submodule routing
|
|
141
141
|
# # Each domain key MUST match the PRD's `Domain` (Metadata row) / folder path segment.
|
|
142
|
-
# # A domain value has
|
|
143
|
-
# # `path`
|
|
142
|
+
# # A domain value has THREE forms — context-loader (Step 1.5) auto-detects in this order:
|
|
143
|
+
# # has `path` → FORM A (resolved)
|
|
144
|
+
# # has `by_prd_slug` → FORM C (look up one more level)
|
|
145
|
+
# # otherwise → FORM B (per-platform map)
|
|
144
146
|
# #
|
|
145
147
|
# # FORM A — FLAT (one domain ↔ one submodule, all platforms):
|
|
146
148
|
# {{DOMAIN_1}}:
|
|
@@ -157,6 +159,22 @@ domains:
|
|
|
157
159
|
# web: { path: "{{WEB_SUBMODULE_DIR}}", module: "nextjs" }
|
|
158
160
|
# app: { path: "{{APP_SUBMODULE_DIR}}", module: "flutter" }
|
|
159
161
|
# #
|
|
162
|
+
# # FORM C — PER-PRD_SLUG MAP (one routing cell ↔ MANY submodules, one per feature-package).
|
|
163
|
+
# # Use when a platform — or a whole domain — is split into one repo per feature,
|
|
164
|
+
# # e.g. each webview mini-game lives in its own repo. No `path`; instead a
|
|
165
|
+
# # `by_prd_slug` table keyed by the feature-package folder name. context-loader
|
|
166
|
+
# # already extracted prd_slug in Step 1, so no extra detection is needed.
|
|
167
|
+
# # Valid at BOTH levels: directly under the domain, or nested under a platform.
|
|
168
|
+
# {{DOMAIN_3}}:
|
|
169
|
+
# system: { path: "{{BE_SUBMODULE_DIR}}", module: "java-spring" } # normal entry
|
|
170
|
+
# webview: # this cell → many repos
|
|
171
|
+
# by_prd_slug:
|
|
172
|
+
# {{PRD_SLUG_1}}: { path: "games/{{GAME_1}}", module: "phaser-game" }
|
|
173
|
+
# {{PRD_SLUG_2}}: { path: "games/{{GAME_2}}", module: "phaser-game" }
|
|
174
|
+
# # A prd_slug with no entry → active_service = unresolved (the command STOPS rather than
|
|
175
|
+
# # guessing a lookalike repo). An entry with BOTH `path` and `by_prd_slug` is a config
|
|
176
|
+
# # error, as is nesting `by_prd_slug` inside `by_prd_slug`.
|
|
177
|
+
# #
|
|
160
178
|
# # NOTE: with spec_source set, BDD + tech-docs are cross-team and live in the spec repo —
|
|
161
179
|
# # do NOT pin per-service specs_dir / tech_docs_dir here (they would be ignored).
|
|
162
180
|
# # Per-service specs_dir / tech_docs_dir apply ONLY when there is no spec_source.
|
|
@@ -169,7 +187,9 @@ domains:
|
|
|
169
187
|
# root, so without a service CLAUDE.md, code generation falls back to umbrella defaults
|
|
170
188
|
# + the module stack-profile (a ⚠️ is flagged in the context recap). Generate one per
|
|
171
189
|
# service via /setup-ai-first inside each. For FORM B, add one CLAUDE.md per platform
|
|
172
|
-
# submodule ({system|web|app}.path/CLAUDE.md).
|
|
190
|
+
# submodule ({system|web|app}.path/CLAUDE.md). For FORM C, one per feature repo
|
|
191
|
+
# (by_prd_slug.{slug}.path/CLAUDE.md) — these repos usually share a stack, so the fastest
|
|
192
|
+
# route is to write one and copy it, adjusting the parts that actually differ.
|
|
173
193
|
|
|
174
194
|
# ----- Architecture -----
|
|
175
195
|
architecture:
|