sdd-flow-kit 1.0.4 → 1.0.6
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/README.md +1 -0
- package/dist/cli.js +1 -1
- package/dist/steps/setupProject.js +39 -0
- package/dist/steps/startFlow.js +8 -2
- package/package.json +1 -1
- package/src/templates/artifacts/02-/351/234/200/346/261/202/345/210/206/346/236/220/346/217/220/347/244/272/350/257/215.template.md +9 -0
- package/src/templates/artifacts/05-openspec-/346/217/220/346/241/210/350/215/211/347/250/277.template.md +5 -0
- package/src/templates/prompts/02-sdd-loop-prompt.md +6 -0
- package/src/templates/skills/confluence-doc.py.template +24 -0
- package/src/templates/skills/doc-skill.SKILL.md.template +1 -0
package/README.md
CHANGED
|
@@ -21,6 +21,7 @@
|
|
|
21
21
|
3. 安装流程(安装即用,默认 `claude-code`):`npx sdd-flow-kit install`
|
|
22
22
|
- 会自动安装对应 AI 环境并写入项目级触发 Skill(仅在“开发 <产品> <版本> 需求/版本/PRD”场景触发)
|
|
23
23
|
- 会在项目根目录生成 `docs/<项目>-doc-skill/`(用于 PRD 下载脚本与说明),可通过 `--project` 选择:`OMS` / `ADI` / `欢盟` / `AD Tools`(默认 `OMS`)
|
|
24
|
+
- 会自动注入 `.opsx/config.json`(按所选工具写入 editor/skillsDir/commandsDir)
|
|
24
25
|
4. (可选)预演安装:`npx sdd-flow-kit install --dry-run --plan-json`
|
|
25
26
|
5. (可选)环境健检:`npx sdd-flow-kit doctor --agent claude-code`
|
|
26
27
|
6. 完成后,直接在 Cursor / Claude Code / Codex / OpenClaw 中用自然语言发起需求,例如:`开发 ADI 2.3.2 需求`
|
package/dist/cli.js
CHANGED
|
@@ -122,7 +122,7 @@ async function main() {
|
|
|
122
122
|
projectKind: projectKind,
|
|
123
123
|
});
|
|
124
124
|
// eslint-disable-next-line no-console
|
|
125
|
-
console.log(`setup 完成:agent=${result.agent}, project=${result.projectKind}, branch=${result.branch}, setupExecuted=${result.setupExecuted}, skillInstalled=${result.skillInstalled}, docsSkillInstalled=${result.docsSkillInstalled}, dryRun=${dryRun}`);
|
|
125
|
+
console.log(`setup 完成:agent=${result.agent}, project=${result.projectKind}, branch=${result.branch}, setupExecuted=${result.setupExecuted}, skillInstalled=${result.skillInstalled}, docsSkillInstalled=${result.docsSkillInstalled}, opsxConfigInstalled=${result.opsxConfigInstalled}, dryRun=${dryRun}`);
|
|
126
126
|
if (result.plannedActions.length > 0) {
|
|
127
127
|
// eslint-disable-next-line no-console
|
|
128
128
|
console.log(`planned: ${result.plannedActions.join(" | ")}`);
|
|
@@ -220,6 +220,39 @@ async function installDocsSkill(projectRoot, kind) {
|
|
|
220
220
|
await (0, fs_1.writeTextFileEnsuredDir)(node_path_1.default.join(docsDir, "confluence-doc.py"), py);
|
|
221
221
|
return { dirPath: docsDir };
|
|
222
222
|
}
|
|
223
|
+
function getOpsxPathsByAgent(agent) {
|
|
224
|
+
switch (agent) {
|
|
225
|
+
case "cursor":
|
|
226
|
+
return { editor: "cursor", skillsDir: ".cursor/skills", commandsDir: ".cursor/commands" };
|
|
227
|
+
case "claude-code":
|
|
228
|
+
return { editor: "claude-code", skillsDir: ".claude/skills", commandsDir: ".claude/commands" };
|
|
229
|
+
case "codex":
|
|
230
|
+
return { editor: "codex", skillsDir: ".codex/skills", commandsDir: ".codex/commands" };
|
|
231
|
+
case "openclaw":
|
|
232
|
+
return { editor: "openclaw", skillsDir: ".openclaw/skills", commandsDir: ".openclaw/commands" };
|
|
233
|
+
default:
|
|
234
|
+
return { editor: "custom", skillsDir: ".sdd-flow-kit/skills", commandsDir: ".sdd-flow-kit/commands" };
|
|
235
|
+
}
|
|
236
|
+
}
|
|
237
|
+
async function installOpsxConfig(projectRoot, agent) {
|
|
238
|
+
const target = node_path_1.default.join(projectRoot, ".opsx", "config.json");
|
|
239
|
+
const paths = getOpsxPathsByAgent(agent);
|
|
240
|
+
const config = {
|
|
241
|
+
version: 1,
|
|
242
|
+
editor: paths.editor,
|
|
243
|
+
skillsDir: paths.skillsDir,
|
|
244
|
+
commandsDir: paths.commandsDir,
|
|
245
|
+
deliveryPipeline: {
|
|
246
|
+
skillName: "opsx-dev-delivery-pipeline",
|
|
247
|
+
packageManager: "pnpm",
|
|
248
|
+
unitScript: "unit",
|
|
249
|
+
playwrightCommand: "exec playwright test",
|
|
250
|
+
devServerUrl: "http://localhost:5173",
|
|
251
|
+
playwrightPicDir: "playwright-pic",
|
|
252
|
+
},
|
|
253
|
+
};
|
|
254
|
+
await (0, fs_1.writeTextFileEnsuredDir)(target, JSON.stringify(config, null, 2));
|
|
255
|
+
}
|
|
223
256
|
async function setupProject(options) {
|
|
224
257
|
const defaultAgent = options.agent ?? "claude-code";
|
|
225
258
|
const selectedAgent = options.yes ? defaultAgent : await askAgent(defaultAgent);
|
|
@@ -242,6 +275,7 @@ async function setupProject(options) {
|
|
|
242
275
|
let setupExecuted = false;
|
|
243
276
|
let skillInstalled = false;
|
|
244
277
|
let docsSkillInstalled = false;
|
|
278
|
+
let opsxConfigInstalled = false;
|
|
245
279
|
if (!environmentReady) {
|
|
246
280
|
const { cmd, args } = buildSetupCommand(options.projectRoot, selectedAgent);
|
|
247
281
|
if (options.dryRun) {
|
|
@@ -269,12 +303,15 @@ async function setupProject(options) {
|
|
|
269
303
|
}
|
|
270
304
|
const { dir } = docSkillDirName(selectedKind);
|
|
271
305
|
plannedActions.push(`would install docs skill: ${node_path_1.default.join(options.projectRoot, "docs", dir)}`);
|
|
306
|
+
plannedActions.push(`would install opsx config: ${node_path_1.default.join(options.projectRoot, ".opsx", "config.json")}`);
|
|
272
307
|
}
|
|
273
308
|
else {
|
|
274
309
|
await installAgentSkill(options.projectRoot);
|
|
275
310
|
skillInstalled = true;
|
|
276
311
|
await installDocsSkill(options.projectRoot, selectedKind);
|
|
277
312
|
docsSkillInstalled = true;
|
|
313
|
+
await installOpsxConfig(options.projectRoot, selectedAgent);
|
|
314
|
+
opsxConfigInstalled = true;
|
|
278
315
|
}
|
|
279
316
|
const summary = [
|
|
280
317
|
"# SETUP-SUMMARY",
|
|
@@ -287,6 +324,7 @@ async function setupProject(options) {
|
|
|
287
324
|
`setupExecuted: ${setupExecuted}`,
|
|
288
325
|
`skillInstalled: ${skillInstalled}`,
|
|
289
326
|
`docsSkillInstalled: ${docsSkillInstalled}`,
|
|
327
|
+
`opsxConfigInstalled: ${opsxConfigInstalled}`,
|
|
290
328
|
`dryRun: ${Boolean(options.dryRun)}`,
|
|
291
329
|
"",
|
|
292
330
|
"plannedActions:",
|
|
@@ -304,5 +342,6 @@ async function setupProject(options) {
|
|
|
304
342
|
plannedActions,
|
|
305
343
|
skillInstalled,
|
|
306
344
|
docsSkillInstalled,
|
|
345
|
+
opsxConfigInstalled,
|
|
307
346
|
};
|
|
308
347
|
}
|
package/dist/steps/startFlow.js
CHANGED
|
@@ -79,11 +79,13 @@ async function startFlowScaffold(options) {
|
|
|
79
79
|
"",
|
|
80
80
|
`本次 runId: \`${runId}\``,
|
|
81
81
|
"",
|
|
82
|
-
"## Step 1:获取需求文档(
|
|
82
|
+
"## Step 1:获取需求文档(docs/<project>-doc-skill)",
|
|
83
83
|
"请打开 `01-获取需求文档指引.md`,并使用你的 AI 工具执行相应动作,把 PRD/接口文档回填到 `source/`。",
|
|
84
|
+
"门禁:`source/PRD.md` 若仍是占位文本,禁止进入 Step2。",
|
|
84
85
|
"",
|
|
85
86
|
"## Step 2:执行 SDD 循环并生成 01/02/03 文件",
|
|
86
|
-
"请打开 `02-需求分析提示词.md`,在 Cursor/Claude Code/Codex/OpenClaw
|
|
87
|
+
"请打开 `02-需求分析提示词.md`,在 Cursor/Claude Code/Codex/OpenClaw 中执行。",
|
|
88
|
+
"门禁:提问模式仅允许更新 `03-待确认问题清单.md`;闭环后才允许输出最终版 `01/02`。",
|
|
87
89
|
"",
|
|
88
90
|
"## Step 3:人工核验待确认问题",
|
|
89
91
|
"将 `03-待确认问题清单.md` 收敛为闭环(必要时调整 01/02)。",
|
|
@@ -93,6 +95,10 @@ async function startFlowScaffold(options) {
|
|
|
93
95
|
"",
|
|
94
96
|
"## Step 5:触发 openspec + superpowers 提案",
|
|
95
97
|
"使用 `05-openspec-提案草稿.md` 作为 openspec 的提案输入入口。",
|
|
98
|
+
"",
|
|
99
|
+
"## Step 6:执行 /opsx-apply",
|
|
100
|
+
"必须在当前仓库的本地 OPSX skills/config 下执行,不允许跨仓 fallback 到其它目录。",
|
|
101
|
+
"门禁:delivery-pipeline 未成功(exit 0)前,禁止宣称 apply 完成。",
|
|
96
102
|
].join("\n"));
|
|
97
103
|
return {
|
|
98
104
|
runId,
|
package/package.json
CHANGED
|
@@ -8,6 +8,11 @@
|
|
|
8
8
|
|
|
9
9
|
--- 你将要运行的提示词结束 ---
|
|
10
10
|
|
|
11
|
+
## 执行门禁(必须遵守,和手动流程一致)
|
|
12
|
+
- `source/PRD.md` 若仍是占位文本(没有真实 PRD 内容),**禁止**继续 Step2,先返回“Step1 未完成”并停止。
|
|
13
|
+
- 当处于“提问模式”时,**只允许更新** `03-待确认问题清单.md`;**禁止**产出最终版 `01-需求分析报告.md` / `02-改动点清单.md`。
|
|
14
|
+
- 只有当用户明确确认“矛盾点池已闭合”后,才可进入“交付模式”并输出最终版 `01` / `02`。
|
|
15
|
+
|
|
11
16
|
## 输入注入(建议做法)
|
|
12
17
|
- 将 `source/PRD.md` 的内容作为 `{{PRD_MARKDOWN}}` 注入
|
|
13
18
|
- 将 `source/接口文档.md` 的内容作为 `{{INTERFACE_DOC_MARKDOWN}}` 注入(没有则忽略)
|
|
@@ -18,3 +23,7 @@
|
|
|
18
23
|
- `02-改动点清单.md`
|
|
19
24
|
- `03-待确认问题清单.md`
|
|
20
25
|
|
|
26
|
+
## 输出话术(建议固定)
|
|
27
|
+
- 提问模式:`SDD 模式:提问模式;矛盾点池状态:未闭合;仅更新 03,等待人工确认。`
|
|
28
|
+
- 交付模式:`SDD 模式:交付模式;矛盾点池状态:已闭合;已输出最终版 01/02/03。`
|
|
29
|
+
|
|
@@ -8,6 +8,11 @@
|
|
|
8
8
|
3. 将本文件中的内容复制给 openspec + superpowers 的“提案输入”
|
|
9
9
|
4. 进入生成 UI 图 + 任务拆解 + 开发阶段
|
|
10
10
|
|
|
11
|
+
## 门禁(与手动流程一致)
|
|
12
|
+
- 仅当 `03-待确认问题清单.md` 已明确“矛盾点池状态:已闭合”时,才可进入提案阶段。
|
|
13
|
+
- 若 `03` 未闭合,禁止进入提案,先回到 Step3 完成确认。
|
|
14
|
+
- 提案完成后进入 `/opsx-apply`,必须在当前仓库本地 OPSX 配置中执行。
|
|
15
|
+
|
|
11
16
|
## 输入摘要
|
|
12
17
|
- `01-需求分析报告.md`:已完成
|
|
13
18
|
- `02-改动点清单.md`:已完成(仅代码文件改动)
|
|
@@ -57,6 +57,10 @@
|
|
|
57
57
|
|
|
58
58
|
请根据当前状态选择执行路径:
|
|
59
59
|
|
|
60
|
+
### 0) 前置门禁(必须先检查)
|
|
61
|
+
- 若 `source/PRD.md` 未回填真实 PRD(仍为占位),立即停止并返回:`Step1 未完成:请先完成 PRD 回填`。
|
|
62
|
+
- 不得在 PRD 缺失时产出 `01/02/03` 的“最终版”内容。
|
|
63
|
+
|
|
60
64
|
#### 路径 A:提问模式 (当前存在矛盾点)
|
|
61
65
|
> **触发条件**:当你发现 PRD 与现有代码库不一致,或代码逻辑存在盲区时。
|
|
62
66
|
|
|
@@ -64,6 +68,7 @@
|
|
|
64
68
|
1. **不要强行编写解决方案。**
|
|
65
69
|
2. 列出所有 **断点**、**起点缺失** 和 **推测缺口**。
|
|
66
70
|
3. 输出 `03-待确认问题清单.md`,并暂停生成最终报告,等待人工输入。
|
|
71
|
+
4. 明确标注:`矛盾点池状态:未闭合`。
|
|
67
72
|
|
|
68
73
|
---
|
|
69
74
|
|
|
@@ -74,6 +79,7 @@
|
|
|
74
79
|
1. 生成最终版 `01-需求分析报告.md` 和 `02-改动点清单.md`。
|
|
75
80
|
2. 在报告中明确标注“**矛盾点池状态:已闭合**”。
|
|
76
81
|
3. 确认 `02-改动点清单.md` 中仅包含代码文件改动,不涉及 `openspec/spec/` 内容。
|
|
82
|
+
4. 输出时附带一句:`可进入 Step4 技术文档与 Step5 提案阶段`。
|
|
77
83
|
|
|
78
84
|
---
|
|
79
85
|
|
|
@@ -39,6 +39,25 @@ def env(name: str, default: str | None = None) -> str:
|
|
|
39
39
|
return str(v)
|
|
40
40
|
|
|
41
41
|
|
|
42
|
+
def load_env_file(file_path: Path) -> None:
|
|
43
|
+
"""轻量加载 .env 文件(不依赖 python-dotenv)。"""
|
|
44
|
+
if not file_path.exists() or not file_path.is_file():
|
|
45
|
+
return
|
|
46
|
+
try:
|
|
47
|
+
for raw in file_path.read_text(encoding="utf-8").splitlines():
|
|
48
|
+
line = raw.strip()
|
|
49
|
+
if not line or line.startswith("#") or "=" not in line:
|
|
50
|
+
continue
|
|
51
|
+
key, value = line.split("=", 1)
|
|
52
|
+
key = key.strip()
|
|
53
|
+
value = value.strip().strip('"').strip("'")
|
|
54
|
+
if key and key not in os.environ:
|
|
55
|
+
os.environ[key] = value
|
|
56
|
+
except Exception:
|
|
57
|
+
# 失败不阻断,继续走显式环境变量
|
|
58
|
+
pass
|
|
59
|
+
|
|
60
|
+
|
|
42
61
|
def normalize_version(raw: str) -> str:
|
|
43
62
|
"""将 1.2.3 / V1.2.3 / XXX-V1.2.3 / XXX_V1.2.3 统一为 1.2.3"""
|
|
44
63
|
v = raw.strip()
|
|
@@ -171,6 +190,11 @@ def main():
|
|
|
171
190
|
print(" 用法: python3 confluence-doc.py <版本号>")
|
|
172
191
|
sys.exit(1)
|
|
173
192
|
|
|
193
|
+
# 自动尝试从项目常见 env 文件加载配置,降低手工配置成本
|
|
194
|
+
repo_root = Path(__file__).resolve().parents[2]
|
|
195
|
+
for env_name in [".env.pre", ".env", ".env.local", ".env.development", ".env.test"]:
|
|
196
|
+
load_env_file(repo_root / env_name)
|
|
197
|
+
|
|
174
198
|
base_url = env("CONFLUENCE_BASE_URL")
|
|
175
199
|
search_url = env("CONFLUENCE_SEARCH_URL", base_url.rstrip("/") + "/dosearchsite.action?includeArchivedSpaces=false")
|
|
176
200
|
username = env("CONFLUENCE_USERNAME")
|
|
@@ -52,4 +52,5 @@ python3 confluence-doc.py {{PRODUCT_PREFIX}}_V1.2.3
|
|
|
52
52
|
- 依赖 Playwright:`pip install playwright && playwright install chromium`
|
|
53
53
|
- 脚本:`docs/{{SKILL_DIR}}/confluence-doc.py`
|
|
54
54
|
- 为安全起见,脚本不包含默认账号密码,请用环境变量注入
|
|
55
|
+
- 脚本会自动尝试读取仓库根目录的 `.env.pre` / `.env` / `.env.local`(若其中存在 `CONFLUENCE_*` 配置可直接复用)
|
|
55
56
|
|