xwang 0.0.9 → 0.0.10
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.
|
@@ -343,6 +343,26 @@ branch_status_handled() {
|
|
|
343
343
|
[ "$status" = "handled" ]
|
|
344
344
|
}
|
|
345
345
|
|
|
346
|
+
grilled_completed() {
|
|
347
|
+
local val
|
|
348
|
+
val=$(yaml_field_value "grilled" 2>/dev/null || true)
|
|
349
|
+
if [ "$val" = "true" ]; then
|
|
350
|
+
return 0
|
|
351
|
+
fi
|
|
352
|
+
echo "grilled must be true before leaving design; run grill-with-docs and then:"
|
|
353
|
+
echo " \"\$XWANG_BASH\" \"\$XWANG_STATE\" set $CHANGE grilled true" >&2
|
|
354
|
+
return 1
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
domain_glossary_exists() {
|
|
358
|
+
if [ -f "$PROJECT_ROOT/CONTEXT.md" ] || [ -f "$PROJECT_ROOT/docs/glossary.md" ] || [ -f "$PROJECT_ROOT/glossary.md" ]; then
|
|
359
|
+
return 0
|
|
360
|
+
fi
|
|
361
|
+
echo "No domain glossary found (expected CONTEXT.md or docs/glossary.md)." >&2
|
|
362
|
+
echo "If this change introduces domain terms, create/update the glossary before leaving design." >&2
|
|
363
|
+
return 1
|
|
364
|
+
}
|
|
365
|
+
|
|
346
366
|
design_doc_recorded() {
|
|
347
367
|
local design_doc
|
|
348
368
|
design_doc=$(yaml_field_value "design_doc" 2>/dev/null || true)
|
|
@@ -450,6 +470,8 @@ guard_design() {
|
|
|
450
470
|
check "design.md exists and non-empty" file_nonempty "$CHANGE_DIR/design.md"
|
|
451
471
|
check "tasks.md exists and non-empty" file_nonempty "$CHANGE_DIR/tasks.md"
|
|
452
472
|
check "tasks.md has at least one task" tasks_has_any
|
|
473
|
+
check "grilling completed" grilled_completed
|
|
474
|
+
check "domain glossary exists" domain_glossary_exists
|
|
453
475
|
check "OpenSpec artifacts language consistency" openspec_artifacts_language_consistent
|
|
454
476
|
|
|
455
477
|
if [ "$workflow" = "full" ]; then
|
|
@@ -256,6 +256,7 @@ build_pause: null
|
|
|
256
256
|
tdd_mode: $tdd_mode
|
|
257
257
|
subagent_dispatch: null
|
|
258
258
|
direct_override: false
|
|
259
|
+
grilled: false
|
|
259
260
|
verify_mode: null
|
|
260
261
|
verify_result: pending
|
|
261
262
|
verification_report: null
|
|
@@ -303,12 +304,12 @@ cmd_set() {
|
|
|
303
304
|
fi
|
|
304
305
|
|
|
305
306
|
case "$field" in
|
|
306
|
-
workflow|phase|design_doc|plan|base_ref|isolation|build_mode|build_pause|tdd_mode|subagent_dispatch|direct_override|verify_mode|verify_result|verification_report|branch_status|archived|created_at|updated_at|build_command|verify_command)
|
|
307
|
+
workflow|phase|design_doc|plan|base_ref|isolation|build_mode|build_pause|tdd_mode|subagent_dispatch|direct_override|verify_mode|verify_result|verification_report|branch_status|archived|created_at|updated_at|build_command|verify_command|grilled)
|
|
307
308
|
# Valid field
|
|
308
309
|
;;
|
|
309
310
|
*)
|
|
310
311
|
red "ERROR: Unknown field: '$field'" >&2
|
|
311
|
-
red "Valid fields: workflow, phase, design_doc, plan, base_ref, isolation, build_mode, build_pause, tdd_mode, subagent_dispatch, direct_override, verify_mode, verify_result, verification_report, branch_status, archived, created_at, updated_at, build_command, verify_command" >&2
|
|
312
|
+
red "Valid fields: workflow, phase, design_doc, plan, base_ref, isolation, build_mode, build_pause, tdd_mode, subagent_dispatch, direct_override, verify_mode, verify_result, verification_report, branch_status, archived, created_at, updated_at, build_command, verify_command, grilled" >&2
|
|
312
313
|
exit 1
|
|
313
314
|
;;
|
|
314
315
|
esac
|
|
@@ -335,7 +336,7 @@ cmd_set() {
|
|
|
335
336
|
subagent_dispatch)
|
|
336
337
|
validate_enum "$value" "null" "confirmed"
|
|
337
338
|
;;
|
|
338
|
-
direct_override|archived)
|
|
339
|
+
direct_override|archived|grilled)
|
|
339
340
|
validate_enum "$value" "true" "false"
|
|
340
341
|
;;
|
|
341
342
|
verify_mode)
|
|
@@ -9,18 +9,19 @@ description: 启动 xwang 项目阶段2:深度设计,明确需求并同步
|
|
|
9
9
|
|
|
10
10
|
当用户触发 xwang 阶段2时:
|
|
11
11
|
|
|
12
|
-
1.
|
|
12
|
+
1. **必须调用 `/grill-with-docs`** 围绕需求目标、范围、用户、约束、验收标准等逐层追问,同时对照现有领域模型和文档(CONTEXT.md、ADRs)挑战术语、澄清冲突,直到达成共识。**不得跳过 grilling;若用户试图跳过,必须拒绝并说明这是 design 阶段的强制入口。**
|
|
13
13
|
2. **强制进行 PRD 拆分预检(阻塞点)**:`/grill-with-docs` 确认需求完成后,**必须**输出一份 `PRD 拆分预检报告`,基于已澄清信息评估是否需要拆分为多个 change。**无论是否需要拆分,都必须停下来向用户展示报告并等待明确选择**;未确认前不得生成 PRD 或创建 OpenSpec change。
|
|
14
14
|
3. grilling 结束后,根据需求内容自己总结一个简洁的中文需求名称 `<name>`,用于生成 `docs/mattpocock/<name>-prd.md`。
|
|
15
15
|
4. 创建 `docs/mattpocock/` 目录(如不存在)。
|
|
16
|
-
5.
|
|
17
|
-
6.
|
|
18
|
-
7.
|
|
19
|
-
8.
|
|
20
|
-
9.
|
|
21
|
-
10.
|
|
22
|
-
11.
|
|
23
|
-
12.
|
|
16
|
+
5. **需求澄清完成确认(强制阻塞点)**:向用户输出一份结构化的需求摘要(目标、范围、用户、核心行为、边界情况、非功能性需求、依赖与限制、新增/更新术语),并确认专业术语已写入 `CONTEXT.md` 或 `docs/glossary.md`;等待用户明确确认或提出修改,未确认前不得生成 PRD。
|
|
17
|
+
6. grilling 完成后,运行 `"$XWANG_STATE" set <name> grilled true` 记录 grilling 已完成。
|
|
18
|
+
7. 用户确认后,调用 `/to-prd` 基于对话上下文合成 PRD。
|
|
19
|
+
8. 将生成的 PRD 内容写入 `docs/mattpocock/<name>-prd.md`。
|
|
20
|
+
9. 直接调用 `/openspec-new-change`:以 `<name>` 作为 change 名称,将 PRD 的中文内容作为 change 文档/上下文创建 change,过程中无需用户确认;若 `/openspec-new-change` 流程中出现任何确认提示(如“是否继续创建 proposal.md?”),直接代为确认并继续,不得将确认问题抛给用户;**要求 `/openspec-new-change` 生成的所有文档/artifact 必须使用中文表述,包括但不限于 `proposal.md`、`design.md`、`tasks.md` 以及 `specs/*/spec.md`**。
|
|
21
|
+
10. **初始化 xwang 状态**:调用 `"$XWANG_STATE" init <name> full`,在 `openspec/changes/<name>/.xwang.yaml` 创建状态文件(起始 phase 为 `design`)。
|
|
22
|
+
11. **记录 design 文件**:调用 `"$XWANG_STATE" set <name> design_doc docs/mattpocock/<name>-prd.md`,将 PRD 路径写入状态。
|
|
23
|
+
12. **阶段出口守护(design → build)**:调用 `"$XWANG_GUARD" <name> design --apply` 校验 design 阶段退出条件,通过后会自动将 `.xwang.yaml` 的 `phase` 推进到 `build`。
|
|
24
|
+
13. **自动进入 build 阶段(full 模式)**:向用户简要汇报 PRD 保存路径、change 名称、状态文件路径后,直接调用 `/xwang-build` 继续阶段3,无需等待用户确认。
|
|
24
25
|
|
|
25
26
|
汇报示例:
|
|
26
27
|
|
|
@@ -45,11 +46,12 @@ fi
|
|
|
45
46
|
. "$XWANG_ENV"
|
|
46
47
|
```
|
|
47
48
|
|
|
48
|
-
### Step 1
|
|
49
|
+
### Step 1:需求澄清(强制)
|
|
49
50
|
|
|
50
51
|
- [ ] 确认用户要启动 xwang 阶段2(关键词:xwang-design、xwang 阶段2、开始 xwang)。
|
|
51
|
-
- [ ]
|
|
52
|
+
- [ ] **必须调用 `/grill-with-docs`**,从用户视角深挖:目标用户、核心问题、预期行为、边界情况、非功能性需求、依赖与限制;并对照现有 CONTEXT.md/ADRs 挑战术语、澄清冲突,必要时实时更新文档。**如果 `/grill-with-docs` 没有执行或没有完成,不得进入后续步骤。**
|
|
52
53
|
- [ ] grilling 过程中持续追问,直到形成清晰的需求理解。
|
|
54
|
+
- [ ] grilling 完成后,**必须记录 grilling 已完成**:运行 `"$XWANG_STATE" set <name> grilled true`。
|
|
53
55
|
- [ ] `/grill-with-docs` 完成需求确认后,**不得立即生成 PRD**,必须先进入 Step 1a 的强制拆分预检。
|
|
54
56
|
|
|
55
57
|
### Step 1a:PRD 拆分预检(强制阻塞点)
|
|
@@ -99,7 +101,11 @@ grilling 确认完成后、生成 PRD 前,**必须**执行 PRD 拆分预检并
|
|
|
99
101
|
|
|
100
102
|
- [ ] grilling 结束后,根据需求核心内容自己生成一个简洁的中文名称(如 `会议周视图 UI 增强`)作为 `<name>`,直接使用无需确认。
|
|
101
103
|
- [ ] 使用 `mkdir -p docs/mattpocock` 确保目录存在。
|
|
102
|
-
- [ ]
|
|
104
|
+
- [ ] **领域术语守护**:梳理本次需求涉及的专业术语(尤其是新引入的、或有歧义的术语):
|
|
105
|
+
- 若项目已有 `CONTEXT.md` 或 `docs/glossary.md`,检查这些术语是否已定义;未定义的**必须**补充进去。
|
|
106
|
+
- 若项目没有术语文件,但本次需求出现了值得固化的专业术语,**必须**创建 `CONTEXT.md` 或 `docs/glossary.md` 并写入定义。
|
|
107
|
+
- 在最终的需求确认摘要中显式列出「新增/更新术语」。
|
|
108
|
+
- [ ] 向用户输出结构化的**需求确认摘要**(建议包含:目标、范围、目标用户、核心行为、边界情况、非功能性需求、依赖与限制、新增/更新术语)。
|
|
103
109
|
- [ ] **必须使用当前平台可用的用户输入/确认机制暂停并等待用户确认需求澄清完成**。若用户提出修改,根据反馈调整摘要并再次确认,直到达成共识。
|
|
104
110
|
- [ ] **未确认前不得调用 `/to-prd`,不得生成 PRD,不得创建 OpenSpec change**。
|
|
105
111
|
|