@tea-agent/loop-agent 0.13.0 → 0.15.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.
Files changed (272) hide show
  1. package/AGENTS.md +157 -157
  2. package/CHANGELOG.md +116 -305
  3. package/README.md +357 -334
  4. package/bin/agent-worker.js +22 -22
  5. package/bin/loop-agent.js +21 -21
  6. package/dist/commands/cursor-prompt.js +6 -6
  7. package/dist/commands/init.js +505 -505
  8. package/dist/commands/loop-benchmark.js +11 -11
  9. package/dist/commands/pi-reuse-benchmark.js +16 -16
  10. package/dist/executors/pi-event-serializer.js +33 -11
  11. package/dist/sidecars/cursor-prompt/executor.js +1 -1
  12. package/dist/task/runtime.js +27 -27
  13. package/dist/worker/observe/spec-evidence.js +19 -10
  14. package/dist/worker/observe/static/api.js +46 -46
  15. package/dist/worker/observe/static/app.js +151 -150
  16. package/dist/worker/observe/static/constants.js +156 -148
  17. package/dist/worker/observe/static/copy.js +67 -67
  18. package/dist/worker/observe/static/dag-helpers.js +201 -172
  19. package/dist/worker/observe/static/dag-layout.d.ts +31 -31
  20. package/dist/worker/observe/static/dag-layout.js +83 -83
  21. package/dist/worker/observe/static/dag-model.js +72 -72
  22. package/dist/worker/observe/static/dom.js +122 -122
  23. package/dist/worker/observe/static/format-pool.d.ts +71 -0
  24. package/dist/worker/observe/static/format-pool.js +134 -67
  25. package/dist/worker/observe/static/format.js +317 -292
  26. package/dist/worker/observe/static/index.html +350 -308
  27. package/dist/worker/observe/static/kpi.js +100 -94
  28. package/dist/worker/observe/static/markdown-render.js +124 -0
  29. package/dist/worker/observe/static/relations.js +133 -133
  30. package/dist/worker/observe/static/router.js +93 -93
  31. package/dist/worker/observe/static/run-processing.js +148 -148
  32. package/dist/worker/observe/static/shell-chrome.js +74 -68
  33. package/dist/worker/observe/static/state.js +273 -267
  34. package/dist/worker/observe/static/styles.css +2504 -1902
  35. package/dist/worker/observe/static/views/batch.js +227 -227
  36. package/dist/worker/observe/static/views/dag-graph.js +172 -172
  37. package/dist/worker/observe/static/views/dag-inspector.js +530 -627
  38. package/dist/worker/observe/static/views/dag.js +371 -371
  39. package/dist/worker/observe/static/views/dashboard.js +86 -100
  40. package/dist/worker/observe/static/views/failures.js +143 -143
  41. package/dist/worker/observe/static/views/feature.js +492 -492
  42. package/dist/worker/observe/static/views/pool.js +708 -350
  43. package/dist/worker/observe/static/views/run.js +453 -453
  44. package/dist/worker/observe/static/views/session-timeline.js +771 -219
  45. package/dist/worker/observe/static/views/shell.js +7 -7
  46. package/dist/worker/observe/static/views/task.js +314 -314
  47. package/dist/worker/observe/static/views/timeline.js +163 -163
  48. package/dist/workflows/dag/canvas-observer.js +275 -275
  49. package/dist/workflows/dag/init-hybrid.js +27 -11
  50. package/docs/README.md +106 -104
  51. package/docs/architecture/README.md +26 -26
  52. package/docs/architecture/dag-execution.md +140 -140
  53. package/docs/architecture/evolution.md +54 -54
  54. package/docs/architecture/facts-and-state.md +71 -71
  55. package/docs/architecture/runtime-boundaries.md +191 -191
  56. package/docs/architecture/system-overview.md +93 -93
  57. package/docs/architecture/worker-and-feature.md +85 -85
  58. package/docs/harness-methodology-debugging.md +153 -153
  59. package/docs/harness-methodology-tdd.md +130 -130
  60. package/docs/harness-methodology-verification.md +27 -27
  61. package/docs/init-surface.manifest.json +304 -307
  62. package/docs/skills/README.md +7 -7
  63. package/docs/skills/vetted-skill-registry.md +29 -29
  64. package/docs/templates/adr.md +60 -60
  65. package/docs/templates/agent-dag-authority-surface-audit.prompt.md +94 -94
  66. package/docs/templates/agent-dag-decision-envelope.schema.json +213 -213
  67. package/docs/templates/agent-dag-decision-gate-dogfood-report.md +117 -117
  68. package/docs/templates/agent-dag-decision-gate.prompt.md +246 -246
  69. package/docs/templates/agent-dag-process-supervisor.prompt.md +98 -98
  70. package/docs/templates/agent-dag-report.schema.json +473 -473
  71. package/docs/templates/agent-dag-review-verdict.prompt.md +68 -68
  72. package/docs/templates/agent-dag.base.json +190 -190
  73. package/docs/templates/agent-dag.final-verification.json +185 -185
  74. package/docs/templates/agent-dag.schema.json +411 -411
  75. package/docs/templates/agent-dag.supervised-implementation.json +620 -620
  76. package/docs/templates/backend-test-analysis.schema.json +44 -44
  77. package/docs/templates/backend-test-case-manifest.schema.json +190 -190
  78. package/docs/templates/backend-test-dag.classify.prompt.md +75 -75
  79. package/docs/templates/backend-test-dag.generate-pytest.prompt.md +204 -204
  80. package/docs/templates/backend-test-dag.json +559 -559
  81. package/docs/templates/backend-test-dag.retrospect.prompt.md +139 -139
  82. package/docs/templates/backend-test-dag.review-cases.prompt.md +83 -83
  83. package/docs/templates/backend-test-execution.schema.json +133 -133
  84. package/docs/templates/backend-test-result.schema.json +99 -99
  85. package/docs/templates/branch-merge-report.md +0 -1
  86. package/docs/templates/exec-plan.md +64 -64
  87. package/docs/templates/feature-spec.md +53 -53
  88. package/docs/templates/frontend-design-contract.md +42 -42
  89. package/docs/templates/frontend-eval/fixtures/failures/01-type-build-error.md +17 -17
  90. package/docs/templates/frontend-eval/fixtures/failures/02-unit-component-test-fail.md +16 -16
  91. package/docs/templates/frontend-eval/fixtures/failures/03-fixture-schema-drift.md +16 -16
  92. package/docs/templates/frontend-eval/fixtures/failures/04-missing-loading-empty-error-state.md +16 -16
  93. package/docs/templates/frontend-eval/fixtures/failures/05-forbidden-write-writeset-expansion.md +16 -16
  94. package/docs/templates/frontend-eval/fixtures/failures/06-unapproved-dependency-add.md +16 -16
  95. package/docs/templates/frontend-eval/fixtures/failures/07-mock-production-on.md +21 -21
  96. package/docs/templates/frontend-eval/fixtures/functional/01-simple-component-style.md +29 -29
  97. package/docs/templates/frontend-eval/fixtures/functional/02-form-validation.md +28 -28
  98. package/docs/templates/frontend-eval/fixtures/functional/03-list-detail-page.md +28 -28
  99. package/docs/templates/frontend-eval/fixtures/functional/04-api-mock.md +29 -29
  100. package/docs/templates/frontend-eval/fixtures/functional/05-permission-auth-gated-ui.md +27 -27
  101. package/docs/templates/frontend-eval/fixtures/functional/06-ssr-server-client-boundary.md +28 -28
  102. package/docs/templates/frontend-eval/fixtures/functional/07-shared-public-component-api.md +28 -28
  103. package/docs/templates/frontend-eval/fixtures/functional/08-pure-local-no-remote.md +27 -27
  104. package/docs/templates/frontend-eval/metrics.md +138 -138
  105. package/docs/templates/frontend-eval/smoke-targets.md +53 -53
  106. package/docs/templates/frontend-implementation-contract.schema.json +27 -27
  107. package/docs/templates/frontend-task-constraints.md +35 -35
  108. package/docs/templates/frontend-task-requirement.md +70 -70
  109. package/docs/templates/frontend-test-dag.generate-cases.prompt.md +5 -5
  110. package/docs/templates/frontend-test-dag.json +23 -23
  111. package/docs/templates/frontend-test-dag.retrieve-context.prompt.md +3 -3
  112. package/docs/templates/frontend-test-dag.retrospect.prompt.md +3 -3
  113. package/docs/templates/frontend-test-dag.review-cases.prompt.md +3 -3
  114. package/docs/templates/frontend-test-dag.review-execution.prompt.md +3 -3
  115. package/docs/templates/harness.schema.json +221 -221
  116. package/docs/templates/hybrid-dag.json +188 -188
  117. package/docs/templates/init-evolution-review.md +35 -35
  118. package/docs/templates/interactive-ui-round2-experiment.md +66 -66
  119. package/docs/templates/knowledge-graph-bootstrap-dag.json +118 -118
  120. package/docs/templates/knowledge-sync-dag.json +178 -178
  121. package/docs/templates/knowledge-sync-draft.schema.json +71 -71
  122. package/docs/templates/product-line/AGENTS.md +8 -8
  123. package/docs/templates/product-line/README.md +9 -9
  124. package/docs/templates/product-line/acceptance.yaml +14 -14
  125. package/docs/templates/product-line/closeout.yaml +9 -9
  126. package/docs/templates/product-line/design.md +13 -13
  127. package/docs/templates/product-line/links.md +10 -10
  128. package/docs/templates/product-line/requirement.md +17 -17
  129. package/docs/templates/product-line/task-graph.yaml +15 -15
  130. package/docs/templates/product-line/task.yaml +64 -64
  131. package/docs/templates/product-line/test-plan.md +7 -7
  132. package/docs/templates/production-readiness-checklist.md +57 -57
  133. package/docs/templates/progress-log.md +17 -17
  134. package/docs/templates/project-start-checklist.md +9 -9
  135. package/docs/templates/qa-report.md +48 -48
  136. package/docs/templates/sprint-contract.md +29 -29
  137. package/docs/templates/worker-dogfood-evidence.md +80 -80
  138. package/docs/templates/worker-dogfood-setup.md +68 -68
  139. package/examples/decision-gate-agent-dag.json +173 -173
  140. package/examples/example-dag.json +46 -46
  141. package/examples/hybrid-loop-agent-dag.json +188 -188
  142. package/harness.json +66 -66
  143. package/package.json +78 -52
  144. package/scripts/kb-bootstrap-init-skeleton.sh +240 -240
  145. package/scripts/kb-graph-incremental-prepare.mjs +386 -386
  146. package/scripts/kb-graph-materialize.mjs +105 -105
  147. package/scripts/kb-graph-promote.mjs +164 -164
  148. package/scripts/kb-query.mjs +554 -554
  149. package/skills/agent-worker/SKILL.md +39 -39
  150. package/skills/agent-worker/references/agent-worker-operator.md +60 -60
  151. package/skills/ai-engineering-context/SKILL.md +48 -48
  152. package/skills/analyze-product-dependencies/SKILL.md +67 -67
  153. package/skills/analyze-product-dependencies/agents/openai.yaml +4 -4
  154. package/skills/analyze-product-dependencies/references/api-documentation-schema.md +30 -30
  155. package/skills/analyze-product-dependencies/references/dependency-analysis-schema.md +28 -28
  156. package/skills/analyze-product-dependencies/references/example.md +76 -76
  157. package/skills/analyze-product-dependencies/references/forward-test-cases.md +35 -35
  158. package/skills/analyze-product-dependencies/references/input-contract.md +11 -11
  159. package/skills/analyze-product-dependencies/references/scouting-rules.md +61 -61
  160. package/skills/analyze-product-dependencies/scripts/test-validators.mjs +267 -267
  161. package/skills/analyze-product-dependencies/scripts/validate-api-documentation.mjs +101 -101
  162. package/skills/analyze-product-dependencies/scripts/validate-dependency-analysis.mjs +142 -142
  163. package/skills/analyze-product-dependencies/scripts/validate-product-requirement-input.mjs +76 -76
  164. package/skills/analyze-product-dependencies/scripts/validation-helpers.mjs +146 -146
  165. package/skills/analyze-product-requirements/SKILL.md +90 -90
  166. package/skills/analyze-product-requirements/agents/openai.yaml +4 -4
  167. package/skills/analyze-product-requirements/references/acceptance-criteria.md +91 -91
  168. package/skills/analyze-product-requirements/references/clarification-and-knowledge.md +56 -56
  169. package/skills/analyze-product-requirements/references/example.md +86 -86
  170. package/skills/analyze-product-requirements/references/forward-test-cases.md +66 -66
  171. package/skills/analyze-product-requirements/references/product-analysis-schema.md +32 -32
  172. package/skills/analyze-product-requirements/references/product-requirement-schema.md +33 -33
  173. package/skills/analyze-product-requirements/references/requirement-clarification-schema.md +35 -35
  174. package/skills/analyze-product-requirements/scripts/test-validators.mjs +193 -193
  175. package/skills/analyze-product-requirements/scripts/validate-product-analysis.mjs +69 -69
  176. package/skills/analyze-product-requirements/scripts/validate-product-requirement.mjs +97 -97
  177. package/skills/analyze-product-requirements/scripts/validate-requirement-clarification.mjs +98 -98
  178. package/skills/analyze-product-requirements/scripts/validation-helpers.mjs +156 -156
  179. package/skills/browser-tools/SKILL.md +196 -196
  180. package/skills/browser-tools/browser-content.js +103 -103
  181. package/skills/browser-tools/browser-cookies.js +35 -35
  182. package/skills/browser-tools/browser-eval.js +53 -53
  183. package/skills/browser-tools/browser-hn-scraper.js +108 -108
  184. package/skills/browser-tools/browser-nav.js +44 -44
  185. package/skills/browser-tools/browser-pick.js +162 -162
  186. package/skills/browser-tools/browser-screenshot.js +34 -34
  187. package/skills/browser-tools/browser-start.js +86 -86
  188. package/skills/browser-tools/package-lock.json +2556 -2556
  189. package/skills/browser-tools/package.json +19 -19
  190. package/skills/code-review-core/SKILL.md +20 -20
  191. package/skills/codebase-scout/SKILL.md +19 -19
  192. package/skills/frontend-design-review/SKILL.md +66 -66
  193. package/skills/frontend-design-review/references/review-checklist.md +40 -58
  194. package/skills/frontend-implementation/SKILL.md +49 -49
  195. package/skills/frontend-implementation/references/code-standards.md +32 -32
  196. package/skills/frontend-implementation/references/design-spec.md +46 -46
  197. package/skills/frontend-implementation/references/node-contracts.md +27 -27
  198. package/skills/frontend-review/SKILL.md +61 -59
  199. package/skills/frontend-review/references/review-findings.md +48 -47
  200. package/skills/frontend-verification/SKILL.md +55 -53
  201. package/skills/frontend-verification/references/verification-checklist.md +59 -68
  202. package/skills/grill-me/SKILL.md +10 -10
  203. package/skills/grill-with-docs/SKILL.md +88 -88
  204. package/skills/grill-with-docs/adr-format.md +47 -47
  205. package/skills/grill-with-docs/context-format.md +60 -60
  206. package/skills/init-capability-evolution/SKILL.md +70 -70
  207. package/skills/loop-agent/SKILL.md +151 -151
  208. package/skills/loop-agent/references/README.md +67 -67
  209. package/skills/loop-agent/references/command-reference.md +527 -527
  210. package/skills/loop-agent/references/docs-converge.md +126 -126
  211. package/skills/loop-agent/references/harness-policy.md +263 -263
  212. package/skills/loop-agent/references/hybrid-dag.md +243 -243
  213. package/skills/loop-agent/references/learned/README.md +21 -21
  214. package/skills/loop-agent/references/long-running-loop.md +57 -57
  215. package/skills/loop-agent/references/model-routing.md +36 -36
  216. package/skills/loop-agent/references/multi-worktree.md +54 -54
  217. package/skills/loop-agent/references/one-shot-runs.md +85 -85
  218. package/skills/loop-agent/references/orchestrator-and-interventions.md +169 -169
  219. package/skills/loop-agent/references/pi-prompt.md +23 -23
  220. package/skills/loop-agent/references/pi-subagent-assisted-mode.md +84 -84
  221. package/skills/loop-agent/references/post-implementation-and-patterns.md +44 -44
  222. package/skills/loop-agent/references/task-workflow.md +89 -89
  223. package/skills/loop-agent/references/verification-and-failure-handling.md +141 -141
  224. package/skills/playwright-cli/SKILL.md +420 -420
  225. package/skills/playwright-cli/references/element-attributes.md +23 -23
  226. package/skills/playwright-cli/references/playwright-tests.md +39 -39
  227. package/skills/playwright-cli/references/request-mocking.md +87 -87
  228. package/skills/playwright-cli/references/running-code.md +241 -241
  229. package/skills/playwright-cli/references/session-management.md +225 -225
  230. package/skills/playwright-cli/references/storage-state.md +275 -275
  231. package/skills/playwright-cli/references/test-generation.md +433 -433
  232. package/skills/playwright-cli/references/tracing.md +139 -139
  233. package/skills/playwright-cli/references/video-recording.md +143 -143
  234. package/skills/playwright-cli-case-generator/SKILL.md +74 -74
  235. package/skills/requesting-code-review/SKILL.md +101 -101
  236. package/skills/requesting-code-review/code-reviewer.md +168 -168
  237. package/skills/systematic-debugging/CREATION-LOG.md +119 -119
  238. package/skills/systematic-debugging/SKILL.md +296 -296
  239. package/skills/systematic-debugging/condition-based-waiting-example.ts +158 -158
  240. package/skills/systematic-debugging/condition-based-waiting.md +115 -115
  241. package/skills/systematic-debugging/defense-in-depth.md +122 -122
  242. package/skills/systematic-debugging/find-polluter.sh +63 -63
  243. package/skills/systematic-debugging/root-cause-tracing.md +169 -169
  244. package/skills/systematic-debugging/test-academic.md +14 -14
  245. package/skills/systematic-debugging/test-pressure-1.md +58 -58
  246. package/skills/systematic-debugging/test-pressure-2.md +68 -68
  247. package/skills/systematic-debugging/test-pressure-3.md +69 -69
  248. package/skills/test-driven-development/SKILL.md +20 -20
  249. package/skills/using-git-worktrees/SKILL.md +215 -215
  250. package/skills/verification-before-completion/SKILL.md +154 -154
  251. package/skills/webapp-testing/SKILL.md +19 -19
  252. package/docs/agent-dag-recovery-playbook.md +0 -195
  253. package/docs/agent-dag-runner.md +0 -67
  254. package/docs/cursor-prompt-sidecar.md +0 -36
  255. package/docs/decisions/README.md +0 -18
  256. package/docs/design/README.md +0 -167
  257. package/docs/development-principles.md +0 -73
  258. package/docs/exec-plans/README.md +0 -6
  259. package/docs/exec-plans/active/README.md +0 -12
  260. package/docs/exec-plans/completed/README.md +0 -107
  261. package/docs/feature-workflow.md +0 -414
  262. package/docs/loop-agent-harness.md +0 -142
  263. package/docs/production-readiness.md +0 -96
  264. package/docs/progress/README.md +0 -80
  265. package/docs/reports/README.md +0 -159
  266. package/docs/verification-matrix.md +0 -70
  267. package/scripts/check-product-line-docs.sh +0 -29
  268. package/scripts/check-task-pool-root.sh +0 -32
  269. package/scripts/kb-graph-incremental-prepare.sh +0 -5
  270. package/scripts/kb-graph-materialize.sh +0 -4
  271. package/scripts/kb-graph-promote.sh +0 -4
  272. package/scripts/kb-query.sh +0 -5
@@ -1,101 +1,101 @@
1
- #!/usr/bin/env node
2
-
3
- import { existsSync, statSync } from "node:fs";
4
- import { dirname, resolve } from "node:path";
5
- import { apiBlocks, assertHeadings, field, headings, load, metadata, print, scopeIncludes, section, storyBlocks, tableValue, validateArtifactLocation } from "./validation-helpers.mjs";
6
-
7
- const args = process.argv.slice(2);
8
- const targetIndex = args.indexOf("--target");
9
- const expectedTarget = targetIndex >= 0 ? args[targetIndex + 1] : undefined;
10
- const positional = args.filter((_, index) => targetIndex < 0 || (index !== targetIndex && index !== targetIndex + 1));
11
- if (positional.length < 2) {
12
- console.error("Usage: node validate-api-documentation.mjs <product-requirement.md> <api-documentation.md> [--target backend|both]");
13
- process.exit(2);
14
- }
15
- let requirement, api;
16
- try { requirement = load(positional[0], "Product Requirement"); api = load(positional[1], "API Documentation"); }
17
- catch (error) { console.error(error.message); process.exit(2); }
18
-
19
- const errors = [];
20
- validateArtifactLocation(api, errors, "api-documentation.md");
21
- const scope = metadata(api.text, "analysis_scope");
22
- const upstreamScope = metadata(requirement.text, "analysis_scope");
23
- if (metadata(api.text, "artifact_version") !== "3.0") errors.push("artifact_version must be 3.0.");
24
- if (metadata(api.text, "artifact_type") !== "api-documentation") errors.push("artifact_type must be api-documentation.");
25
- if (metadata(api.text, "api_status") !== "complete") errors.push("api_status must be complete.");
26
- if (!["backend", "both"].includes(scope)) errors.push("analysis_scope must be backend or both for API Documentation.");
27
- if (targetIndex >= 0 && !["backend", "both"].includes(expectedTarget)) errors.push("--target must be backend or both for API Documentation.");
28
- else if (expectedTarget && scope !== expectedTarget) errors.push(`analysis_scope ${scope} does not match requested target ${expectedTarget}.`);
29
- if (!scopeIncludes(upstreamScope, scope)) errors.push("analysis_scope must be included in Product Requirement scope.");
30
- if (metadata(api.text, "requirement_id") !== metadata(requirement.text, "requirement_id")) errors.push("requirement_id must match Product Requirement.");
31
- const source = metadata(api.text, "source_product_requirement");
32
- if (!source || resolve(dirname(api.path), source) !== requirement.path) errors.push("source_product_requirement must reference the supplied Product Requirement.");
33
- if (dirname(requirement.path) !== dirname(api.path)) errors.push("API Documentation and Product Requirement must be in the same requirement directory.");
34
- const repo = metadata(api.text, "repository_root");
35
- const repoPath = repo ? resolve(dirname(api.path), repo) : "";
36
- if (!repoPath || !existsSync(repoPath) || !statSync(repoPath).isDirectory()) errors.push("repository_root must be an existing readable directory.");
37
- const projectRoot = resolve(dirname(api.path), metadata(api.text, "project_root") ?? "");
38
- if (repoPath && projectRoot && repoPath !== projectRoot) errors.push("repository_root must resolve to project_root.");
39
-
40
- assertHeadings(api.text, 2, ["通用约定", "API 索引", "API 详情", "数据模型", "错误码"], errors, "API Documentation");
41
- const conventions = section(api.text, 2, "通用约定") ?? "";
42
- assertHeadings(conventions, 3, ["Base URL", "统一响应结构", "错误响应结构", "分页约定", "时间和标识符规范"], errors, "通用约定");
43
- if (/(?:认证方式|认证要求|鉴权方式|鉴权要求|权限要求|权限规则|访问控制要求|Authorization|Bearer|X-API-Key|access[_-]?token|id[_-]?token|业务规则|业务逻辑|实现逻辑|处理逻辑|分支逻辑|数据读写逻辑|实现算法)/i.test(api.text)) errors.push("API Documentation must not contain authentication, permission, business-rule, or implementation-logic content.");
44
- if (/(?:复用检查|通用定义复用)/.test(api.text)) errors.push("API Documentation must not contain reuse-check sections or search evidence.");
45
- const index = section(api.text, 2, "API 索引") ?? "";
46
- const blocks = apiBlocks(api.text);
47
- if (!blocks.length) errors.push("API Documentation must contain at least one API-* detail.");
48
- const ids = new Set();
49
- const operations = new Set();
50
- for (const block of blocks) {
51
- if (ids.has(block.id)) errors.push(`Duplicate API ID: ${block.id}.`);
52
- ids.add(block.id);
53
- const operation = tableValue(block.text, "Operation ID");
54
- if (!operation) errors.push(`${block.id} is missing Operation ID.`);
55
- else if (operations.has(operation)) errors.push(`Duplicate Operation ID: ${operation}.`);
56
- else operations.add(operation);
57
- for (const name of ["Operation ID", "变更类型", "幂等性"]) if (!tableValue(block.text, name)) errors.push(`${block.id} is missing basic information field ${name}.`);
58
- if (tableValue(block.text, "API ID")) errors.push(`${block.id} basic information must not repeat API ID.`);
59
- if (tableValue(block.text, "变更类型") && !["新增", "修改", "复用"].includes(tableValue(block.text, "变更类型"))) errors.push(`${block.id} 变更类型 is invalid.`);
60
- const signature = block.text.match(/^>\s*`(GET|POST|PUT|PATCH|DELETE)\s+(\/[^`]+)`/m);
61
- if (!signature) errors.push(`${block.id} is missing a Swagger-style method and path signature.`);
62
- for (const title of ["基本信息", "成功响应", "错误响应"]) if (!headings(block.text, 4).some((item) => item.title.trim() === title)) errors.push(`${block.id} is missing section ${title}.`);
63
- const query = section(block.text, 4, "Query 参数") ?? "";
64
- if (/\b(?:pageSize|page_size|limit|cursor|page)\b/i.test(query)) {
65
- const pageSizeRow = query.split(/\r?\n/).find((line) => /^\|\s*(?:pageSize|page_size|limit)\s*\|/i.test(line));
66
- if (!pageSizeRow) errors.push(`${block.id} paginated API must define an optional page-size parameter.`);
67
- else {
68
- if (!/^\|\s*(?:pageSize|page_size|limit)\s*\|\s*[^|]+\|\s*(?:否|可选)\s*\|/i.test(pageSizeRow)) errors.push(`${block.id} page-size parameter must be optional.`);
69
- const values = [...new Set(pageSizeRow.match(/\b\d+\b/g) ?? [])].sort((a, b) => Number(a) - Number(b));
70
- if (values.join(",") !== "10,20,50,100") errors.push(`${block.id} page-size values must be exactly 10, 20, 50, and 100.`);
71
- }
72
- }
73
- if (signature) {
74
- const parameters = signature[2].match(/\{([^}]+)\}/g) ?? [];
75
- const pathSection = section(block.text, 4, "Path 参数") ?? "";
76
- if (parameters.length && !pathSection) errors.push(`${block.id} path template requires Path 参数.`);
77
- for (const parameter of parameters) {
78
- const name = parameter.slice(1, -1);
79
- if (!new RegExp(`^\\|\\s*${name}\\s*\\|`, "m").test(pathSection)) errors.push(`${block.id} path parameter ${name} is not documented.`);
80
- }
81
- }
82
- const success = section(block.text, 4, "成功响应") ?? "";
83
- const error = section(block.text, 4, "错误响应") ?? "";
84
- if (!/HTTP(?: 状态码)?[::]\s*2\d\d/.test(success)) errors.push(`${block.id} must define a 2xx success response.`);
85
- if (!/^\|\s*[45]\d\d\s*\|/m.test(error)) errors.push(`${block.id} must define at least one 4xx or 5xx error response.`);
86
- for (const [content, label] of [[success, "success"], [error, "error"]]) {
87
- const example = content.match(/```json\s*([\s\S]*?)```/)?.[1];
88
- if (!example) errors.push(`${block.id} must include a JSON ${label} example.`);
89
- else try { JSON.parse(example); } catch { errors.push(`${block.id} ${label} example must be valid JSON.`); }
90
- }
91
- if (!index.includes(block.id)) errors.push(`${block.id} is missing from API index.`);
92
- if (operation && !index.includes(operation)) errors.push(`${block.id} Operation ID is missing from API index.`);
93
- if (signature && !index.includes(`${signature[1]} ${signature[2]}`)) errors.push(`${block.id} method and path are missing from API index.`);
94
- }
95
-
96
- const requiredApiStories = storyBlocks(section(requirement.text, 2, "后端用户故事"), "BE-US").filter((story) => /\bAPI\b/i.test(field(story.text, "触发方式") ?? ""));
97
- for (const story of requiredApiStories) {
98
- if (!index.includes(story.id)) errors.push(`API index does not cover API-triggered story ${story.id}.`);
99
- for (const ac of field(story.text, "验收标准")?.match(/AC-BE-\d{3,}/g) ?? []) if (!index.includes(ac)) errors.push(`API index does not trace ${ac}.`);
100
- }
101
- print("API Documentation", api.path, errors);
1
+ #!/usr/bin/env node
2
+
3
+ import { existsSync, statSync } from "node:fs";
4
+ import { dirname, resolve } from "node:path";
5
+ import { apiBlocks, assertHeadings, field, headings, load, metadata, print, scopeIncludes, section, storyBlocks, tableValue, validateArtifactLocation } from "./validation-helpers.mjs";
6
+
7
+ const args = process.argv.slice(2);
8
+ const targetIndex = args.indexOf("--target");
9
+ const expectedTarget = targetIndex >= 0 ? args[targetIndex + 1] : undefined;
10
+ const positional = args.filter((_, index) => targetIndex < 0 || (index !== targetIndex && index !== targetIndex + 1));
11
+ if (positional.length < 2) {
12
+ console.error("Usage: node validate-api-documentation.mjs <product-requirement.md> <api-documentation.md> [--target backend|both]");
13
+ process.exit(2);
14
+ }
15
+ let requirement, api;
16
+ try { requirement = load(positional[0], "Product Requirement"); api = load(positional[1], "API Documentation"); }
17
+ catch (error) { console.error(error.message); process.exit(2); }
18
+
19
+ const errors = [];
20
+ validateArtifactLocation(api, errors, "api-documentation.md");
21
+ const scope = metadata(api.text, "analysis_scope");
22
+ const upstreamScope = metadata(requirement.text, "analysis_scope");
23
+ if (metadata(api.text, "artifact_version") !== "3.0") errors.push("artifact_version must be 3.0.");
24
+ if (metadata(api.text, "artifact_type") !== "api-documentation") errors.push("artifact_type must be api-documentation.");
25
+ if (metadata(api.text, "api_status") !== "complete") errors.push("api_status must be complete.");
26
+ if (!["backend", "both"].includes(scope)) errors.push("analysis_scope must be backend or both for API Documentation.");
27
+ if (targetIndex >= 0 && !["backend", "both"].includes(expectedTarget)) errors.push("--target must be backend or both for API Documentation.");
28
+ else if (expectedTarget && scope !== expectedTarget) errors.push(`analysis_scope ${scope} does not match requested target ${expectedTarget}.`);
29
+ if (!scopeIncludes(upstreamScope, scope)) errors.push("analysis_scope must be included in Product Requirement scope.");
30
+ if (metadata(api.text, "requirement_id") !== metadata(requirement.text, "requirement_id")) errors.push("requirement_id must match Product Requirement.");
31
+ const source = metadata(api.text, "source_product_requirement");
32
+ if (!source || resolve(dirname(api.path), source) !== requirement.path) errors.push("source_product_requirement must reference the supplied Product Requirement.");
33
+ if (dirname(requirement.path) !== dirname(api.path)) errors.push("API Documentation and Product Requirement must be in the same requirement directory.");
34
+ const repo = metadata(api.text, "repository_root");
35
+ const repoPath = repo ? resolve(dirname(api.path), repo) : "";
36
+ if (!repoPath || !existsSync(repoPath) || !statSync(repoPath).isDirectory()) errors.push("repository_root must be an existing readable directory.");
37
+ const projectRoot = resolve(dirname(api.path), metadata(api.text, "project_root") ?? "");
38
+ if (repoPath && projectRoot && repoPath !== projectRoot) errors.push("repository_root must resolve to project_root.");
39
+
40
+ assertHeadings(api.text, 2, ["通用约定", "API 索引", "API 详情", "数据模型", "错误码"], errors, "API Documentation");
41
+ const conventions = section(api.text, 2, "通用约定") ?? "";
42
+ assertHeadings(conventions, 3, ["Base URL", "统一响应结构", "错误响应结构", "分页约定", "时间和标识符规范"], errors, "通用约定");
43
+ if (/(?:认证方式|认证要求|鉴权方式|鉴权要求|权限要求|权限规则|访问控制要求|Authorization|Bearer|X-API-Key|access[_-]?token|id[_-]?token|业务规则|业务逻辑|实现逻辑|处理逻辑|分支逻辑|数据读写逻辑|实现算法)/i.test(api.text)) errors.push("API Documentation must not contain authentication, permission, business-rule, or implementation-logic content.");
44
+ if (/(?:复用检查|通用定义复用)/.test(api.text)) errors.push("API Documentation must not contain reuse-check sections or search evidence.");
45
+ const index = section(api.text, 2, "API 索引") ?? "";
46
+ const blocks = apiBlocks(api.text);
47
+ if (!blocks.length) errors.push("API Documentation must contain at least one API-* detail.");
48
+ const ids = new Set();
49
+ const operations = new Set();
50
+ for (const block of blocks) {
51
+ if (ids.has(block.id)) errors.push(`Duplicate API ID: ${block.id}.`);
52
+ ids.add(block.id);
53
+ const operation = tableValue(block.text, "Operation ID");
54
+ if (!operation) errors.push(`${block.id} is missing Operation ID.`);
55
+ else if (operations.has(operation)) errors.push(`Duplicate Operation ID: ${operation}.`);
56
+ else operations.add(operation);
57
+ for (const name of ["Operation ID", "变更类型", "幂等性"]) if (!tableValue(block.text, name)) errors.push(`${block.id} is missing basic information field ${name}.`);
58
+ if (tableValue(block.text, "API ID")) errors.push(`${block.id} basic information must not repeat API ID.`);
59
+ if (tableValue(block.text, "变更类型") && !["新增", "修改", "复用"].includes(tableValue(block.text, "变更类型"))) errors.push(`${block.id} 变更类型 is invalid.`);
60
+ const signature = block.text.match(/^>\s*`(GET|POST|PUT|PATCH|DELETE)\s+(\/[^`]+)`/m);
61
+ if (!signature) errors.push(`${block.id} is missing a Swagger-style method and path signature.`);
62
+ for (const title of ["基本信息", "成功响应", "错误响应"]) if (!headings(block.text, 4).some((item) => item.title.trim() === title)) errors.push(`${block.id} is missing section ${title}.`);
63
+ const query = section(block.text, 4, "Query 参数") ?? "";
64
+ if (/\b(?:pageSize|page_size|limit|cursor|page)\b/i.test(query)) {
65
+ const pageSizeRow = query.split(/\r?\n/).find((line) => /^\|\s*(?:pageSize|page_size|limit)\s*\|/i.test(line));
66
+ if (!pageSizeRow) errors.push(`${block.id} paginated API must define an optional page-size parameter.`);
67
+ else {
68
+ if (!/^\|\s*(?:pageSize|page_size|limit)\s*\|\s*[^|]+\|\s*(?:否|可选)\s*\|/i.test(pageSizeRow)) errors.push(`${block.id} page-size parameter must be optional.`);
69
+ const values = [...new Set(pageSizeRow.match(/\b\d+\b/g) ?? [])].sort((a, b) => Number(a) - Number(b));
70
+ if (values.join(",") !== "10,20,50,100") errors.push(`${block.id} page-size values must be exactly 10, 20, 50, and 100.`);
71
+ }
72
+ }
73
+ if (signature) {
74
+ const parameters = signature[2].match(/\{([^}]+)\}/g) ?? [];
75
+ const pathSection = section(block.text, 4, "Path 参数") ?? "";
76
+ if (parameters.length && !pathSection) errors.push(`${block.id} path template requires Path 参数.`);
77
+ for (const parameter of parameters) {
78
+ const name = parameter.slice(1, -1);
79
+ if (!new RegExp(`^\\|\\s*${name}\\s*\\|`, "m").test(pathSection)) errors.push(`${block.id} path parameter ${name} is not documented.`);
80
+ }
81
+ }
82
+ const success = section(block.text, 4, "成功响应") ?? "";
83
+ const error = section(block.text, 4, "错误响应") ?? "";
84
+ if (!/HTTP(?: 状态码)?[::]\s*2\d\d/.test(success)) errors.push(`${block.id} must define a 2xx success response.`);
85
+ if (!/^\|\s*[45]\d\d\s*\|/m.test(error)) errors.push(`${block.id} must define at least one 4xx or 5xx error response.`);
86
+ for (const [content, label] of [[success, "success"], [error, "error"]]) {
87
+ const example = content.match(/```json\s*([\s\S]*?)```/)?.[1];
88
+ if (!example) errors.push(`${block.id} must include a JSON ${label} example.`);
89
+ else try { JSON.parse(example); } catch { errors.push(`${block.id} ${label} example must be valid JSON.`); }
90
+ }
91
+ if (!index.includes(block.id)) errors.push(`${block.id} is missing from API index.`);
92
+ if (operation && !index.includes(operation)) errors.push(`${block.id} Operation ID is missing from API index.`);
93
+ if (signature && !index.includes(`${signature[1]} ${signature[2]}`)) errors.push(`${block.id} method and path are missing from API index.`);
94
+ }
95
+
96
+ const requiredApiStories = storyBlocks(section(requirement.text, 2, "后端用户故事"), "BE-US").filter((story) => /\bAPI\b/i.test(field(story.text, "触发方式") ?? ""));
97
+ for (const story of requiredApiStories) {
98
+ if (!index.includes(story.id)) errors.push(`API index does not cover API-triggered story ${story.id}.`);
99
+ for (const ac of field(story.text, "验收标准")?.match(/AC-BE-\d{3,}/g) ?? []) if (!index.includes(ac)) errors.push(`API index does not trace ${ac}.`);
100
+ }
101
+ print("API Documentation", api.path, errors);
@@ -1,142 +1,142 @@
1
- #!/usr/bin/env node
2
-
3
- import { existsSync, statSync } from "node:fs";
4
- import { basename, dirname, resolve } from "node:path";
5
- import { apiBlocks, assertHeadings, canonical, field, fieldBlock, headings, load, metadata, print, scopeIncludes, section, storyBlocks, tableValue, validateArtifactLocation } from "./validation-helpers.mjs";
6
-
7
- const args = process.argv.slice(2);
8
- const targetIndex = args.indexOf("--target");
9
- const expectedTarget = targetIndex >= 0 ? args[targetIndex + 1] : undefined;
10
- const positional = args.filter((_, index) => targetIndex < 0 || (index !== targetIndex && index !== targetIndex + 1));
11
- const [requirementArg, dependencyArg, apiArg] = positional;
12
- if (!requirementArg || !dependencyArg) {
13
- console.error("Usage: node validate-dependency-analysis.mjs <product-requirement.md|none> <dependency-analysis.md> [api-documentation.md] [--target frontend|backend|both]");
14
- process.exit(2);
15
- }
16
- let requirement, dependency, api;
17
- try {
18
- if (requirementArg !== "none") requirement = load(requirementArg, "Product Requirement");
19
- dependency = load(dependencyArg, "Dependency Analysis");
20
- if (apiArg) api = load(apiArg, "API Documentation");
21
- } catch (error) { console.error(error.message); process.exit(2); }
22
-
23
- const errors = [];
24
- validateArtifactLocation(dependency, errors, "dependency-analysis.md");
25
- const scope = metadata(dependency.text, "analysis_scope");
26
- const status = metadata(dependency.text, "analysis_status");
27
- const blockedOn = metadata(dependency.text, "blocked_on") ?? "";
28
- const blockedReasons = blockedOn.split(/[\s,,]+/).filter(Boolean);
29
- const source = metadata(dependency.text, "source_product_requirement");
30
- const sourceApi = metadata(dependency.text, "source_api_documentation");
31
- const repo = metadata(dependency.text, "repository_root");
32
- const repoPath = repo && repo !== "none" ? resolve(dirname(dependency.path), repo) : "";
33
- const repoExists = Boolean(repoPath && existsSync(repoPath) && statSync(repoPath).isDirectory());
34
- const projectRoot = resolve(dirname(dependency.path), metadata(dependency.text, "project_root") ?? "");
35
-
36
- if (metadata(dependency.text, "artifact_version") !== "3.0") errors.push("artifact_version must be 3.0.");
37
- if (metadata(dependency.text, "artifact_type") !== "dependency-analysis") errors.push("artifact_type must be dependency-analysis.");
38
- if (!["frontend", "backend", "both"].includes(scope)) errors.push("analysis_scope must be frontend, backend, or both.");
39
- if (targetIndex >= 0 && !["frontend", "backend", "both"].includes(expectedTarget)) errors.push("--target must be frontend, backend, or both.");
40
- else if (expectedTarget && scope !== expectedTarget) errors.push(`analysis_scope ${scope} does not match requested target ${expectedTarget}.`);
41
- if (!["complete", "blocked"].includes(status)) errors.push("analysis_status must be complete or blocked.");
42
-
43
- function validateRequirementLink({ allowScopeMismatch = false } = {}) {
44
- if (!requirement) return;
45
- if (basename(requirement.path) !== "product-requirement.md") errors.push("Product Requirement filename must be product-requirement.md.");
46
- if (!allowScopeMismatch && !scopeIncludes(metadata(requirement.text, "analysis_scope"), scope)) errors.push("analysis_scope must be included in Product Requirement scope.");
47
- if (metadata(dependency.text, "requirement_id") !== metadata(requirement.text, "requirement_id")) errors.push("requirement_id must match Product Requirement.");
48
- if (!source || resolve(dirname(dependency.path), source) !== requirement.path) errors.push("source_product_requirement must reference the supplied Product Requirement.");
49
- if (dirname(requirement.path) !== dirname(dependency.path)) errors.push("Dependency Analysis and Product Requirement must be in the same requirement directory.");
50
- }
51
-
52
- if (status === "blocked") {
53
- const allowed = new Set(["requirement-missing", "requirement-invalid", "requirement-not-complete", "repository-missing", "repository-unreadable", "scope-mismatch", "missing-stories", "missing-acceptance", "api-business-contract-incomplete"]);
54
- if (!blockedReasons.length || blockedOn === "none") errors.push("blocked analysis must declare blocked_on reasons.");
55
- for (const reason of blockedReasons) if (!allowed.has(reason)) errors.push(`Unknown blocked_on reason: ${reason}.`);
56
- if (requirement) validateRequirementLink({ allowScopeMismatch: blockedReasons.includes("scope-mismatch") });
57
- else {
58
- if (!blockedReasons.includes("requirement-missing")) errors.push("A missing Product Requirement requires blocked_on: requirement-missing.");
59
- if (source !== "none") errors.push("Missing Product Requirement must use source_product_requirement: none.");
60
- }
61
- if (!blockedReasons.some((reason) => ["repository-missing", "repository-unreadable"].includes(reason)) && !repoExists) errors.push("repository_root must be readable unless blocked on repository availability.");
62
- if (sourceApi !== "none") errors.push("Blocked Dependency Analysis must use source_api_documentation: none.");
63
- const required = ["分析范围", "输入与代码基线", "阻断原因", "恢复条件"];
64
- assertHeadings(dependency.text, 2, required, errors, "Blocked Dependency Analysis");
65
- for (const heading of headings(dependency.text, 2)) if (!required.includes(canonical(heading.title))) errors.push(`Blocked Dependency Analysis must not contain section ${canonical(heading.title)}.`);
66
- print("Dependency Analysis", dependency.path, errors);
67
- process.exit(0);
68
- }
69
-
70
- if (!requirement) errors.push("Complete Dependency Analysis requires Product Requirement input.");
71
- else validateRequirementLink();
72
- if (blockedOn !== "none") errors.push("complete analysis must use blocked_on: none.");
73
- if (!repoExists) errors.push("repository_root must be an existing readable directory.");
74
- if (repoPath && repoPath !== projectRoot) errors.push("repository_root must resolve to project_root.");
75
- assertHeadings(dependency.text, 2, ["输入与代码基线", "用户故事覆盖矩阵", "跨故事共享依赖", "风险与未定位项"], errors, "Dependency Analysis");
76
- if (/^##\s+(?:\d+[.、]?\s*)?(?:分析范围|追溯汇总)\s*$/m.test(dependency.text)) errors.push("Complete V3 Dependency Analysis must not contain 分析范围 or 追溯汇总 sections.");
77
- if (scope === "frontend" || scope === "both") assertHeadings(dependency.text, 2, ["前端依赖详情"], errors, "Dependency Analysis");
78
- if (scope === "backend" || scope === "both") assertHeadings(dependency.text, 2, ["后端依赖详情", "API 实现映射"], errors, "Dependency Analysis");
79
- if (scope === "frontend" && /(?:^##\s+.*(?:后端依赖详情|API 实现映射)|\bBE-US-\d{3,}\b|\bAC-BE-\d{3,}\b|\bAPI-\d{3,}\b)/m.test(dependency.text)) errors.push("frontend scope must not contain backend dependency details or API mappings.");
80
- if (scope === "backend" && /(?:^##\s+.*前端依赖详情|\bFE-US-\d{3,}\b|\bAC-FE-\d{3,}\b)/m.test(dependency.text)) errors.push("backend scope must not contain frontend dependency details.");
81
-
82
- const frontendStories = requirement && (scope === "frontend" || scope === "both") ? storyBlocks(section(requirement.text, 2, "前端用户故事"), "FE-US") : [];
83
- const backendStories = requirement && (scope === "backend" || scope === "both") ? storyBlocks(section(requirement.text, 2, "后端用户故事"), "BE-US") : [];
84
- const apiRequired = backendStories.some((story) => /\bAPI\b/i.test(field(story.text, "触发方式") ?? ""));
85
- if (apiRequired) {
86
- if (!api) errors.push("API-triggered backend stories require api-documentation.md.");
87
- if (!sourceApi || sourceApi === "none") errors.push("API-triggered backend stories require source_api_documentation.");
88
- if (api && resolve(dirname(dependency.path), sourceApi) !== api.path) errors.push("source_api_documentation must reference the supplied API Documentation.");
89
- } else {
90
- if (api) errors.push("API Documentation must not be supplied when no selected backend story uses API.");
91
- if (sourceApi !== "none") errors.push("Non-API analysis must use source_api_documentation: none.");
92
- if ((scope === "backend" || scope === "both") && !/不适用.*不涉及 HTTP API/s.test(section(dependency.text, 2, "API 实现映射") ?? "")) errors.push("Non-API analysis must mark API 实现映射 not applicable.");
93
- }
94
-
95
- function validateDetails(frontend, expectedStories) {
96
- const title = frontend ? "前端依赖详情" : "后端依赖详情";
97
- const prefix = frontend ? "FE-US" : "BE-US";
98
- const acPrefix = frontend ? "AC-FE" : "AC-BE";
99
- const requiredFields = frontend
100
- ? ["验收标准", "页面/路由", "组件", "状态", "API client/类型", "状态与边界落点", "定位证据", "风险", "置信度"]
101
- : ["验收标准", "API 文档引用", "路由/入口", "Controller/Handler", "Service/领域逻辑", "DTO/Schema", "数据依赖", "权限依赖", "错误/日志/审计", "测试落点", "定位证据", "风险", "置信度"];
102
- const details = storyBlocks(section(dependency.text, 2, title), prefix);
103
- for (const story of expectedStories) if (!details.some((item) => item.id === story.id)) errors.push(`Dependency Analysis is missing ${title} for ${story.id}.`);
104
- for (const detail of details) {
105
- const story = expectedStories.find((item) => item.id === detail.id);
106
- if (!story) errors.push(`Dependency Analysis contains unselected story ${detail.id}.`);
107
- for (const name of requiredFields) if (!field(detail.text, name)) errors.push(`${detail.id} dependency detail is missing field ${name}.`);
108
- const impact = fieldBlock(detail.text, "影响文件");
109
- if (!impact) errors.push(`${detail.id} dependency detail is missing field 影响文件.`);
110
- const declarations = [...impact.matchAll(/^\s*-\s*(F\d+)\s+(add|modify|reuse|新增|修改|复用)\s+`?([^`\r\n]+)`?/gmi)];
111
- if (!declarations.length) errors.push(`${detail.id} 影响文件 must declare F<number>, add/modify/reuse, and a path.`);
112
- const declared = declarations.map((item) => item[1]);
113
- if (new Set(declared).size !== declared.length) errors.push(`${detail.id} 影响文件 contains duplicate file IDs.`);
114
- for (const ref of detail.text.match(/\bF\d+\b/g) ?? []) if (!declared.includes(ref)) errors.push(`${detail.id} references undeclared impact file ${ref}.`);
115
- if (!/^(?:high|medium|low)$/i.test(field(detail.text, "置信度") ?? "")) errors.push(`${detail.id} 置信度 must be high, medium, or low.`);
116
- if (story) {
117
- const expected = field(story.text, "验收标准")?.match(new RegExp(`${acPrefix}-\\d{3,}`, "g")) ?? [];
118
- const actual = field(detail.text, "验收标准")?.match(new RegExp(`${acPrefix}-\\d{3,}`, "g")) ?? [];
119
- if ([...expected].sort().join() !== [...actual].sort().join()) errors.push(`${detail.id} acceptance references must match Product Requirement.`);
120
- }
121
- }
122
- }
123
-
124
- if (scope === "frontend" || scope === "both") validateDetails(true, frontendStories);
125
- if (scope === "backend" || scope === "both") validateDetails(false, backendStories);
126
- const coverage = section(dependency.text, 2, "用户故事覆盖矩阵") ?? "";
127
- for (const story of [...frontendStories, ...backendStories]) {
128
- if (!coverage.includes(story.id)) errors.push(`Coverage matrix is missing ${story.id}.`);
129
- for (const ac of field(story.text, "验收标准")?.match(/AC-(?:FE|BE)-\d{3,}/g) ?? []) if (!coverage.includes(ac)) errors.push(`Coverage matrix is missing ${ac}.`);
130
- }
131
-
132
- if (api) {
133
- const mapping = section(dependency.text, 2, "API 实现映射") ?? "";
134
- for (const item of apiBlocks(api.text)) {
135
- const operation = tableValue(item.text, "Operation ID");
136
- const signature = item.text.match(/^>\s*`((?:GET|POST|PUT|PATCH|DELETE)\s+\/[^`]+)`/m)?.[1];
137
- if (!mapping.includes(item.id)) errors.push(`API 实现映射 is missing ${item.id}.`);
138
- if (operation && !mapping.includes(operation)) errors.push(`API 实现映射 is missing Operation ID ${operation}.`);
139
- if (signature && !mapping.includes(signature)) errors.push(`API 实现映射 is missing ${signature}.`);
140
- }
141
- }
142
- print("Dependency Analysis", dependency.path, errors);
1
+ #!/usr/bin/env node
2
+
3
+ import { existsSync, statSync } from "node:fs";
4
+ import { basename, dirname, resolve } from "node:path";
5
+ import { apiBlocks, assertHeadings, canonical, field, fieldBlock, headings, load, metadata, print, scopeIncludes, section, storyBlocks, tableValue, validateArtifactLocation } from "./validation-helpers.mjs";
6
+
7
+ const args = process.argv.slice(2);
8
+ const targetIndex = args.indexOf("--target");
9
+ const expectedTarget = targetIndex >= 0 ? args[targetIndex + 1] : undefined;
10
+ const positional = args.filter((_, index) => targetIndex < 0 || (index !== targetIndex && index !== targetIndex + 1));
11
+ const [requirementArg, dependencyArg, apiArg] = positional;
12
+ if (!requirementArg || !dependencyArg) {
13
+ console.error("Usage: node validate-dependency-analysis.mjs <product-requirement.md|none> <dependency-analysis.md> [api-documentation.md] [--target frontend|backend|both]");
14
+ process.exit(2);
15
+ }
16
+ let requirement, dependency, api;
17
+ try {
18
+ if (requirementArg !== "none") requirement = load(requirementArg, "Product Requirement");
19
+ dependency = load(dependencyArg, "Dependency Analysis");
20
+ if (apiArg) api = load(apiArg, "API Documentation");
21
+ } catch (error) { console.error(error.message); process.exit(2); }
22
+
23
+ const errors = [];
24
+ validateArtifactLocation(dependency, errors, "dependency-analysis.md");
25
+ const scope = metadata(dependency.text, "analysis_scope");
26
+ const status = metadata(dependency.text, "analysis_status");
27
+ const blockedOn = metadata(dependency.text, "blocked_on") ?? "";
28
+ const blockedReasons = blockedOn.split(/[\s,,]+/).filter(Boolean);
29
+ const source = metadata(dependency.text, "source_product_requirement");
30
+ const sourceApi = metadata(dependency.text, "source_api_documentation");
31
+ const repo = metadata(dependency.text, "repository_root");
32
+ const repoPath = repo && repo !== "none" ? resolve(dirname(dependency.path), repo) : "";
33
+ const repoExists = Boolean(repoPath && existsSync(repoPath) && statSync(repoPath).isDirectory());
34
+ const projectRoot = resolve(dirname(dependency.path), metadata(dependency.text, "project_root") ?? "");
35
+
36
+ if (metadata(dependency.text, "artifact_version") !== "3.0") errors.push("artifact_version must be 3.0.");
37
+ if (metadata(dependency.text, "artifact_type") !== "dependency-analysis") errors.push("artifact_type must be dependency-analysis.");
38
+ if (!["frontend", "backend", "both"].includes(scope)) errors.push("analysis_scope must be frontend, backend, or both.");
39
+ if (targetIndex >= 0 && !["frontend", "backend", "both"].includes(expectedTarget)) errors.push("--target must be frontend, backend, or both.");
40
+ else if (expectedTarget && scope !== expectedTarget) errors.push(`analysis_scope ${scope} does not match requested target ${expectedTarget}.`);
41
+ if (!["complete", "blocked"].includes(status)) errors.push("analysis_status must be complete or blocked.");
42
+
43
+ function validateRequirementLink({ allowScopeMismatch = false } = {}) {
44
+ if (!requirement) return;
45
+ if (basename(requirement.path) !== "product-requirement.md") errors.push("Product Requirement filename must be product-requirement.md.");
46
+ if (!allowScopeMismatch && !scopeIncludes(metadata(requirement.text, "analysis_scope"), scope)) errors.push("analysis_scope must be included in Product Requirement scope.");
47
+ if (metadata(dependency.text, "requirement_id") !== metadata(requirement.text, "requirement_id")) errors.push("requirement_id must match Product Requirement.");
48
+ if (!source || resolve(dirname(dependency.path), source) !== requirement.path) errors.push("source_product_requirement must reference the supplied Product Requirement.");
49
+ if (dirname(requirement.path) !== dirname(dependency.path)) errors.push("Dependency Analysis and Product Requirement must be in the same requirement directory.");
50
+ }
51
+
52
+ if (status === "blocked") {
53
+ const allowed = new Set(["requirement-missing", "requirement-invalid", "requirement-not-complete", "repository-missing", "repository-unreadable", "scope-mismatch", "missing-stories", "missing-acceptance", "api-business-contract-incomplete"]);
54
+ if (!blockedReasons.length || blockedOn === "none") errors.push("blocked analysis must declare blocked_on reasons.");
55
+ for (const reason of blockedReasons) if (!allowed.has(reason)) errors.push(`Unknown blocked_on reason: ${reason}.`);
56
+ if (requirement) validateRequirementLink({ allowScopeMismatch: blockedReasons.includes("scope-mismatch") });
57
+ else {
58
+ if (!blockedReasons.includes("requirement-missing")) errors.push("A missing Product Requirement requires blocked_on: requirement-missing.");
59
+ if (source !== "none") errors.push("Missing Product Requirement must use source_product_requirement: none.");
60
+ }
61
+ if (!blockedReasons.some((reason) => ["repository-missing", "repository-unreadable"].includes(reason)) && !repoExists) errors.push("repository_root must be readable unless blocked on repository availability.");
62
+ if (sourceApi !== "none") errors.push("Blocked Dependency Analysis must use source_api_documentation: none.");
63
+ const required = ["分析范围", "输入与代码基线", "阻断原因", "恢复条件"];
64
+ assertHeadings(dependency.text, 2, required, errors, "Blocked Dependency Analysis");
65
+ for (const heading of headings(dependency.text, 2)) if (!required.includes(canonical(heading.title))) errors.push(`Blocked Dependency Analysis must not contain section ${canonical(heading.title)}.`);
66
+ print("Dependency Analysis", dependency.path, errors);
67
+ process.exit(0);
68
+ }
69
+
70
+ if (!requirement) errors.push("Complete Dependency Analysis requires Product Requirement input.");
71
+ else validateRequirementLink();
72
+ if (blockedOn !== "none") errors.push("complete analysis must use blocked_on: none.");
73
+ if (!repoExists) errors.push("repository_root must be an existing readable directory.");
74
+ if (repoPath && repoPath !== projectRoot) errors.push("repository_root must resolve to project_root.");
75
+ assertHeadings(dependency.text, 2, ["输入与代码基线", "用户故事覆盖矩阵", "跨故事共享依赖", "风险与未定位项"], errors, "Dependency Analysis");
76
+ if (/^##\s+(?:\d+[.、]?\s*)?(?:分析范围|追溯汇总)\s*$/m.test(dependency.text)) errors.push("Complete V3 Dependency Analysis must not contain 分析范围 or 追溯汇总 sections.");
77
+ if (scope === "frontend" || scope === "both") assertHeadings(dependency.text, 2, ["前端依赖详情"], errors, "Dependency Analysis");
78
+ if (scope === "backend" || scope === "both") assertHeadings(dependency.text, 2, ["后端依赖详情", "API 实现映射"], errors, "Dependency Analysis");
79
+ if (scope === "frontend" && /(?:^##\s+.*(?:后端依赖详情|API 实现映射)|\bBE-US-\d{3,}\b|\bAC-BE-\d{3,}\b|\bAPI-\d{3,}\b)/m.test(dependency.text)) errors.push("frontend scope must not contain backend dependency details or API mappings.");
80
+ if (scope === "backend" && /(?:^##\s+.*前端依赖详情|\bFE-US-\d{3,}\b|\bAC-FE-\d{3,}\b)/m.test(dependency.text)) errors.push("backend scope must not contain frontend dependency details.");
81
+
82
+ const frontendStories = requirement && (scope === "frontend" || scope === "both") ? storyBlocks(section(requirement.text, 2, "前端用户故事"), "FE-US") : [];
83
+ const backendStories = requirement && (scope === "backend" || scope === "both") ? storyBlocks(section(requirement.text, 2, "后端用户故事"), "BE-US") : [];
84
+ const apiRequired = backendStories.some((story) => /\bAPI\b/i.test(field(story.text, "触发方式") ?? ""));
85
+ if (apiRequired) {
86
+ if (!api) errors.push("API-triggered backend stories require api-documentation.md.");
87
+ if (!sourceApi || sourceApi === "none") errors.push("API-triggered backend stories require source_api_documentation.");
88
+ if (api && resolve(dirname(dependency.path), sourceApi) !== api.path) errors.push("source_api_documentation must reference the supplied API Documentation.");
89
+ } else {
90
+ if (api) errors.push("API Documentation must not be supplied when no selected backend story uses API.");
91
+ if (sourceApi !== "none") errors.push("Non-API analysis must use source_api_documentation: none.");
92
+ if ((scope === "backend" || scope === "both") && !/不适用.*不涉及 HTTP API/s.test(section(dependency.text, 2, "API 实现映射") ?? "")) errors.push("Non-API analysis must mark API 实现映射 not applicable.");
93
+ }
94
+
95
+ function validateDetails(frontend, expectedStories) {
96
+ const title = frontend ? "前端依赖详情" : "后端依赖详情";
97
+ const prefix = frontend ? "FE-US" : "BE-US";
98
+ const acPrefix = frontend ? "AC-FE" : "AC-BE";
99
+ const requiredFields = frontend
100
+ ? ["验收标准", "页面/路由", "组件", "状态", "API client/类型", "状态与边界落点", "定位证据", "风险", "置信度"]
101
+ : ["验收标准", "API 文档引用", "路由/入口", "Controller/Handler", "Service/领域逻辑", "DTO/Schema", "数据依赖", "权限依赖", "错误/日志/审计", "测试落点", "定位证据", "风险", "置信度"];
102
+ const details = storyBlocks(section(dependency.text, 2, title), prefix);
103
+ for (const story of expectedStories) if (!details.some((item) => item.id === story.id)) errors.push(`Dependency Analysis is missing ${title} for ${story.id}.`);
104
+ for (const detail of details) {
105
+ const story = expectedStories.find((item) => item.id === detail.id);
106
+ if (!story) errors.push(`Dependency Analysis contains unselected story ${detail.id}.`);
107
+ for (const name of requiredFields) if (!field(detail.text, name)) errors.push(`${detail.id} dependency detail is missing field ${name}.`);
108
+ const impact = fieldBlock(detail.text, "影响文件");
109
+ if (!impact) errors.push(`${detail.id} dependency detail is missing field 影响文件.`);
110
+ const declarations = [...impact.matchAll(/^\s*-\s*(F\d+)\s+(add|modify|reuse|新增|修改|复用)\s+`?([^`\r\n]+)`?/gmi)];
111
+ if (!declarations.length) errors.push(`${detail.id} 影响文件 must declare F<number>, add/modify/reuse, and a path.`);
112
+ const declared = declarations.map((item) => item[1]);
113
+ if (new Set(declared).size !== declared.length) errors.push(`${detail.id} 影响文件 contains duplicate file IDs.`);
114
+ for (const ref of detail.text.match(/\bF\d+\b/g) ?? []) if (!declared.includes(ref)) errors.push(`${detail.id} references undeclared impact file ${ref}.`);
115
+ if (!/^(?:high|medium|low)$/i.test(field(detail.text, "置信度") ?? "")) errors.push(`${detail.id} 置信度 must be high, medium, or low.`);
116
+ if (story) {
117
+ const expected = field(story.text, "验收标准")?.match(new RegExp(`${acPrefix}-\\d{3,}`, "g")) ?? [];
118
+ const actual = field(detail.text, "验收标准")?.match(new RegExp(`${acPrefix}-\\d{3,}`, "g")) ?? [];
119
+ if ([...expected].sort().join() !== [...actual].sort().join()) errors.push(`${detail.id} acceptance references must match Product Requirement.`);
120
+ }
121
+ }
122
+ }
123
+
124
+ if (scope === "frontend" || scope === "both") validateDetails(true, frontendStories);
125
+ if (scope === "backend" || scope === "both") validateDetails(false, backendStories);
126
+ const coverage = section(dependency.text, 2, "用户故事覆盖矩阵") ?? "";
127
+ for (const story of [...frontendStories, ...backendStories]) {
128
+ if (!coverage.includes(story.id)) errors.push(`Coverage matrix is missing ${story.id}.`);
129
+ for (const ac of field(story.text, "验收标准")?.match(/AC-(?:FE|BE)-\d{3,}/g) ?? []) if (!coverage.includes(ac)) errors.push(`Coverage matrix is missing ${ac}.`);
130
+ }
131
+
132
+ if (api) {
133
+ const mapping = section(dependency.text, 2, "API 实现映射") ?? "";
134
+ for (const item of apiBlocks(api.text)) {
135
+ const operation = tableValue(item.text, "Operation ID");
136
+ const signature = item.text.match(/^>\s*`((?:GET|POST|PUT|PATCH|DELETE)\s+\/[^`]+)`/m)?.[1];
137
+ if (!mapping.includes(item.id)) errors.push(`API 实现映射 is missing ${item.id}.`);
138
+ if (operation && !mapping.includes(operation)) errors.push(`API 实现映射 is missing Operation ID ${operation}.`);
139
+ if (signature && !mapping.includes(signature)) errors.push(`API 实现映射 is missing ${signature}.`);
140
+ }
141
+ }
142
+ print("Dependency Analysis", dependency.path, errors);