@tea-agent/loop-agent 0.13.0-alpha.0 → 0.13.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/AGENTS.md +4 -0
- package/CHANGELOG.md +57 -53
- package/README.md +12 -3
- package/dist/application/dag/generate-task-dag.js +28 -58
- package/dist/application/evaluation/candidate-hash.js +75 -0
- package/dist/application/evaluation/candidate.js +52 -0
- package/dist/application/evaluation/replay.js +289 -0
- package/dist/application/evaluation/types.js +130 -0
- package/dist/cli/command-definitions.js +17 -4
- package/dist/cli/program.js +8 -4
- package/dist/commands/eval.js +235 -0
- package/dist/commands/init.js +131 -24
- package/dist/executors/pi-sdk-executor.js +38 -24
- package/dist/executors/shell-executor.js +226 -15
- package/dist/executors/shell-presets.js +20 -0
- package/dist/executors/shell-verification.js +7 -0
- package/dist/governance/manifest-types.js +1 -0
- package/dist/infrastructure/evaluation/candidate-store.js +439 -0
- package/dist/infrastructure/evaluation/store.js +40 -0
- package/dist/task/config-types.js +23 -0
- package/dist/worker/observe/routes.js +18 -3
- package/dist/worker/observe/spec-evidence.js +1 -1
- package/dist/worker/observe/static/dom.js +160 -1
- package/dist/worker/observe/static/state.js +14 -0
- package/dist/worker/observe/static/views/dag-inspector.js +35 -4
- package/dist/worker/observe/static/views/dag.js +9 -0
- package/dist/worker/observe/static/views/dashboard.js +702 -445
- package/dist/worker/observe/static/views/session-timeline.js +15 -1
- package/dist/workflows/dag/backend-test-analysis-contract.js +120 -0
- package/dist/workflows/dag/backend-test-case-manifest.js +503 -0
- package/dist/workflows/dag/backend-test-execution-contract.js +353 -0
- package/dist/workflows/dag/backend-test-result-contract.js +568 -0
- package/dist/workflows/dag/decision-envelope.js +57 -2
- package/dist/workflows/dag/dynamic-runtime/map.js +90 -2
- package/dist/workflows/dag/frontend-implementation-contract.js +240 -0
- package/dist/workflows/dag/frontend-project-capability.js +309 -0
- package/dist/workflows/dag/frontend-repair.js +341 -0
- package/dist/workflows/dag/frontend-risk.js +161 -0
- package/dist/workflows/dag/frontend-verification-trace.js +190 -0
- package/dist/workflows/dag/init-hybrid.js +2407 -297
- package/dist/workflows/dag/node-execution.js +9 -0
- package/dist/workflows/dag/prompt.js +9 -0
- package/dist/workflows/dag/repair-artifact.js +43 -3
- package/dist/workflows/dag/report.js +35 -1
- package/dist/workflows/dag/runner.js +28 -2
- package/dist/workflows/dag/skill-instructions.js +4 -2
- package/dist/workflows/dag/task-demand-routing.js +383 -0
- package/dist/workflows/dag/types.js +71 -13
- package/dist/workflows/dag/upstream-artifacts.js +1 -0
- package/dist/workflows/dag/validate.js +59 -1
- package/docs/README.md +6 -3
- package/docs/agent-dag-recovery-playbook.md +5 -3
- package/docs/agent-dag-runner.md +3 -3
- package/docs/architecture/README.md +3 -3
- package/docs/architecture/dag-execution.md +1 -1
- package/docs/architecture/evolution.md +13 -13
- package/docs/architecture/facts-and-state.md +1 -1
- package/docs/architecture/runtime-boundaries.md +7 -7
- package/docs/architecture/system-overview.md +3 -3
- package/docs/architecture/worker-and-feature.md +3 -3
- package/docs/design/README.md +124 -42
- package/docs/development-principles.md +4 -4
- package/docs/exec-plans/active/README.md +12 -11
- package/docs/exec-plans/completed/README.md +33 -0
- package/docs/feature-workflow.md +114 -39
- package/docs/init-surface.manifest.json +30 -3
- package/docs/loop-agent-harness.md +9 -8
- package/docs/production-readiness.md +1 -1
- package/docs/progress/README.md +23 -1
- package/docs/reports/README.md +65 -6
- package/docs/skills/vetted-skill-registry.md +2 -0
- package/docs/templates/agent-dag.schema.json +29 -1
- package/docs/templates/agent-dag.supervised-implementation.json +127 -8
- package/docs/templates/backend-test-analysis.schema.json +44 -0
- package/docs/templates/backend-test-case-manifest.schema.json +190 -0
- package/docs/templates/backend-test-dag.classify.prompt.md +75 -0
- package/docs/templates/backend-test-dag.generate-pytest.prompt.md +81 -16
- package/docs/templates/backend-test-dag.json +311 -40
- package/docs/templates/backend-test-dag.retrospect.prompt.md +44 -30
- package/docs/templates/backend-test-dag.review-cases.prompt.md +10 -8
- package/docs/templates/backend-test-execution.schema.json +133 -0
- package/docs/templates/backend-test-result.schema.json +99 -0
- package/docs/templates/branch-merge-report.md +93 -0
- package/docs/templates/frontend-design-contract.md +9 -0
- package/docs/templates/frontend-eval/fixtures/failures/01-type-build-error.md +17 -0
- package/docs/templates/frontend-eval/fixtures/failures/02-unit-component-test-fail.md +16 -0
- package/docs/templates/frontend-eval/fixtures/failures/03-fixture-schema-drift.md +16 -0
- package/docs/templates/frontend-eval/fixtures/failures/04-missing-loading-empty-error-state.md +16 -0
- package/docs/templates/frontend-eval/fixtures/failures/05-forbidden-write-writeset-expansion.md +16 -0
- package/docs/templates/frontend-eval/fixtures/failures/06-unapproved-dependency-add.md +16 -0
- package/docs/templates/frontend-eval/fixtures/failures/07-mock-production-on.md +21 -0
- package/docs/templates/frontend-eval/fixtures/functional/01-simple-component-style.md +29 -0
- package/docs/templates/frontend-eval/fixtures/functional/02-form-validation.md +28 -0
- package/docs/templates/frontend-eval/fixtures/functional/03-list-detail-page.md +28 -0
- package/docs/templates/frontend-eval/fixtures/functional/04-api-mock.md +29 -0
- package/docs/templates/frontend-eval/fixtures/functional/05-permission-auth-gated-ui.md +27 -0
- package/docs/templates/frontend-eval/fixtures/functional/06-ssr-server-client-boundary.md +28 -0
- package/docs/templates/frontend-eval/fixtures/functional/07-shared-public-component-api.md +28 -0
- package/docs/templates/frontend-eval/fixtures/functional/08-pure-local-no-remote.md +27 -0
- package/docs/templates/frontend-eval/metrics.md +138 -0
- package/docs/templates/frontend-eval/smoke-targets.md +53 -0
- package/docs/templates/frontend-implementation-contract.schema.json +27 -0
- package/docs/templates/frontend-task-constraints.md +10 -0
- package/docs/templates/frontend-task-requirement.md +9 -0
- package/docs/templates/frontend-test-dag.generate-cases.prompt.md +5 -0
- package/docs/templates/frontend-test-dag.json +23 -0
- package/docs/templates/frontend-test-dag.retrieve-context.prompt.md +3 -0
- package/docs/templates/frontend-test-dag.retrospect.prompt.md +3 -0
- package/docs/templates/frontend-test-dag.review-cases.prompt.md +3 -0
- package/docs/templates/frontend-test-dag.review-execution.prompt.md +3 -0
- package/docs/templates/knowledge-graph-bootstrap-dag.json +1 -1
- package/docs/templates/knowledge-sync-dag.json +1 -0
- package/docs/verification-matrix.md +4 -1
- package/examples/decision-gate-agent-dag.json +4 -4
- package/examples/hybrid-loop-agent-dag.json +1 -1
- package/package.json +2 -2
- package/scripts/kb-bootstrap-init-skeleton.sh +2 -1
- package/scripts/kb-graph-incremental-prepare.mjs +19 -5
- package/scripts/kb-graph-promote.mjs +12 -1
- package/skills/ai-engineering-context/SKILL.md +2 -2
- package/skills/analyze-product-dependencies/SKILL.md +67 -0
- package/skills/analyze-product-dependencies/agents/openai.yaml +4 -0
- package/skills/analyze-product-dependencies/references/api-documentation-schema.md +30 -0
- package/skills/analyze-product-dependencies/references/dependency-analysis-schema.md +28 -0
- package/skills/analyze-product-dependencies/references/example.md +76 -0
- package/skills/analyze-product-dependencies/references/forward-test-cases.md +35 -0
- package/skills/analyze-product-dependencies/references/input-contract.md +11 -0
- package/skills/analyze-product-dependencies/references/scouting-rules.md +61 -0
- package/skills/analyze-product-dependencies/scripts/test-validators.mjs +267 -0
- package/skills/analyze-product-dependencies/scripts/validate-api-documentation.mjs +101 -0
- package/skills/analyze-product-dependencies/scripts/validate-dependency-analysis.mjs +142 -0
- package/skills/analyze-product-dependencies/scripts/validate-product-requirement-input.mjs +76 -0
- package/skills/analyze-product-dependencies/scripts/validation-helpers.mjs +146 -0
- package/skills/analyze-product-requirements/SKILL.md +90 -0
- package/skills/analyze-product-requirements/agents/openai.yaml +4 -0
- package/skills/analyze-product-requirements/references/acceptance-criteria.md +91 -0
- package/skills/analyze-product-requirements/references/clarification-and-knowledge.md +56 -0
- package/skills/analyze-product-requirements/references/example.md +86 -0
- package/skills/analyze-product-requirements/references/forward-test-cases.md +66 -0
- package/skills/analyze-product-requirements/references/product-analysis-schema.md +32 -0
- package/skills/analyze-product-requirements/references/product-requirement-schema.md +33 -0
- package/skills/analyze-product-requirements/references/requirement-clarification-schema.md +35 -0
- package/skills/analyze-product-requirements/scripts/test-validators.mjs +193 -0
- package/skills/analyze-product-requirements/scripts/validate-product-analysis.mjs +69 -0
- package/skills/analyze-product-requirements/scripts/validate-product-requirement.mjs +97 -0
- package/skills/analyze-product-requirements/scripts/validate-requirement-clarification.mjs +98 -0
- package/skills/analyze-product-requirements/scripts/validation-helpers.mjs +156 -0
- package/skills/browser-tools/SKILL.md +196 -0
- package/skills/browser-tools/browser-content.js +103 -0
- package/skills/browser-tools/browser-cookies.js +35 -0
- package/skills/browser-tools/browser-eval.js +53 -0
- package/skills/browser-tools/browser-hn-scraper.js +108 -0
- package/skills/browser-tools/browser-nav.js +44 -0
- package/skills/browser-tools/browser-pick.js +162 -0
- package/skills/browser-tools/browser-screenshot.js +34 -0
- package/skills/browser-tools/browser-start.js +86 -0
- package/skills/browser-tools/package-lock.json +2556 -0
- package/skills/browser-tools/package.json +19 -0
- package/skills/frontend-design-review/SKILL.md +6 -1
- package/skills/frontend-design-review/references/review-checklist.md +25 -4
- package/skills/frontend-implementation/SKILL.md +25 -30
- package/skills/frontend-implementation/references/code-standards.md +20 -22
- package/skills/frontend-implementation/references/node-contracts.md +17 -53
- package/skills/frontend-review/SKILL.md +10 -4
- package/skills/frontend-review/references/review-findings.md +8 -3
- package/skills/frontend-verification/SKILL.md +22 -9
- package/skills/frontend-verification/references/verification-checklist.md +17 -5
- package/skills/grill-with-docs/SKILL.md +5 -5
- package/skills/grill-with-docs/adr-format.md +3 -3
- package/skills/init-capability-evolution/SKILL.md +5 -5
- package/skills/loop-agent/SKILL.md +5 -5
- package/skills/loop-agent/references/README.md +3 -3
- package/skills/loop-agent/references/command-reference.md +98 -24
- package/skills/loop-agent/references/docs-converge.md +15 -15
- package/skills/loop-agent/references/harness-policy.md +2 -2
- package/skills/loop-agent/references/hybrid-dag.md +32 -22
- package/skills/loop-agent/references/multi-worktree.md +1 -1
- package/skills/loop-agent/references/orchestrator-and-interventions.md +8 -8
- package/skills/loop-agent/references/task-workflow.md +1 -1
- package/skills/loop-agent/references/verification-and-failure-handling.md +6 -4
- package/skills/playwright-cli/SKILL.md +420 -0
- package/skills/playwright-cli/references/element-attributes.md +23 -0
- package/skills/playwright-cli/references/playwright-tests.md +39 -0
- package/skills/playwright-cli/references/request-mocking.md +87 -0
- package/skills/playwright-cli/references/running-code.md +241 -0
- package/skills/playwright-cli/references/session-management.md +225 -0
- package/skills/playwright-cli/references/storage-state.md +275 -0
- package/skills/playwright-cli/references/test-generation.md +433 -0
- package/skills/playwright-cli/references/tracing.md +139 -0
- package/skills/playwright-cli/references/video-recording.md +143 -0
- package/skills/playwright-cli-case-generator/SKILL.md +74 -0
- package/skills/requesting-code-review/SKILL.md +1 -1
- package/skills/systematic-debugging/CREATION-LOG.md +3 -3
- package/skills/systematic-debugging/SKILL.md +1 -1
- package/skills/systematic-debugging/test-academic.md +1 -1
- package/skills/systematic-debugging/test-pressure-1.md +1 -1
- package/skills/systematic-debugging/test-pressure-2.md +1 -1
- package/skills/systematic-debugging/test-pressure-3.md +1 -1
- package/skills/verification-before-completion/SKILL.md +1 -1
|
@@ -0,0 +1,267 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
import { mkdirSync, mkdtempSync, writeFileSync } from "node:fs";
|
|
4
|
+
import { tmpdir } from "node:os";
|
|
5
|
+
import { dirname, join } from "node:path";
|
|
6
|
+
import { fileURLToPath } from "node:url";
|
|
7
|
+
import { spawnSync } from "node:child_process";
|
|
8
|
+
|
|
9
|
+
const scriptDir = dirname(fileURLToPath(import.meta.url));
|
|
10
|
+
const temp = mkdtempSync(join(tmpdir(), "dependency-v3-validators-"));
|
|
11
|
+
const repo = join(temp, "repo");
|
|
12
|
+
const artifactDir = join(repo, "docs", "product-analysis", "refund-status");
|
|
13
|
+
mkdirSync(artifactDir, { recursive: true });
|
|
14
|
+
const requirementValidator = join(scriptDir, "validate-product-requirement-input.mjs");
|
|
15
|
+
const apiValidator = join(scriptDir, "validate-api-documentation.mjs");
|
|
16
|
+
const dependencyValidator = join(scriptDir, "validate-dependency-analysis.mjs");
|
|
17
|
+
|
|
18
|
+
const run = (script, args) => spawnSync(process.execPath, [script, ...args], { encoding: "utf8" });
|
|
19
|
+
function pass(name, result) {
|
|
20
|
+
if (result.status !== 0) throw new Error(`${name} should pass:\n${result.stderr}${result.stdout}`);
|
|
21
|
+
}
|
|
22
|
+
function fail(name, result, message) {
|
|
23
|
+
if (result.status === 0) throw new Error(`${name} should fail.`);
|
|
24
|
+
if (message && !`${result.stderr}${result.stdout}`.includes(message)) throw new Error(`${name} should mention ${message}:\n${result.stderr}${result.stdout}`);
|
|
25
|
+
}
|
|
26
|
+
function variant(name, text) {
|
|
27
|
+
const path = join(artifactDir, name);
|
|
28
|
+
writeFileSync(path, text);
|
|
29
|
+
return path;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
const requirementPath = join(artifactDir, "product-requirement.md");
|
|
33
|
+
const apiPath = join(artifactDir, "api-documentation.md");
|
|
34
|
+
const dependencyPath = join(artifactDir, "dependency-analysis.md");
|
|
35
|
+
|
|
36
|
+
const requirement = `---
|
|
37
|
+
artifact_version: "3.0"
|
|
38
|
+
artifact_type: product-requirement
|
|
39
|
+
requirement_id: refund-status
|
|
40
|
+
project_root: ../../..
|
|
41
|
+
requirement_status: complete
|
|
42
|
+
analysis_scope: backend
|
|
43
|
+
source_requirement: inline
|
|
44
|
+
source_product_analysis: none
|
|
45
|
+
source_clarification: none
|
|
46
|
+
---
|
|
47
|
+
# Product Requirement
|
|
48
|
+
## 1. 需求概述
|
|
49
|
+
订单所属用户可以查询退款状态。
|
|
50
|
+
## 2. 业务目标
|
|
51
|
+
- 提供可解释的退款进度。
|
|
52
|
+
## 3. 需求范围
|
|
53
|
+
### 3.1 已确认需求
|
|
54
|
+
- 仅订单所属用户可查询。
|
|
55
|
+
### 3.2 非目标
|
|
56
|
+
- 不修改退款流程。
|
|
57
|
+
### 3.3 默认假设
|
|
58
|
+
- 无。
|
|
59
|
+
### 3.4 未决事项
|
|
60
|
+
- 无。
|
|
61
|
+
## 4. 业务规则
|
|
62
|
+
- 不得泄露其他用户订单。
|
|
63
|
+
## 5. 后端用户故事
|
|
64
|
+
### BE-US-001 查询退款状态
|
|
65
|
+
- 系统能力:返回指定订单的退款状态
|
|
66
|
+
- 使用方:订单详情页
|
|
67
|
+
- 业务价值:让用户了解退款进度
|
|
68
|
+
- 触发方式:API
|
|
69
|
+
- 验收标准:AC-BE-001
|
|
70
|
+
## 6. 后端输出规范
|
|
71
|
+
### BE-US-001 查询退款状态
|
|
72
|
+
- 输入语义:当前用户和订单 ID
|
|
73
|
+
- 输出语义:退款状态、步骤和更新时间
|
|
74
|
+
- 数据读写:只读订单及退款记录
|
|
75
|
+
- 权限规则:仅订单所属用户
|
|
76
|
+
- 业务规则:按最新退款记录返回
|
|
77
|
+
- 安全要求:不得泄露内部错误或其他用户数据
|
|
78
|
+
- 幂等与并发:重复查询不修改数据
|
|
79
|
+
- 错误与边界:订单不存在返回标准错误
|
|
80
|
+
#### AC-BE-001 返回退款状态
|
|
81
|
+
Given:
|
|
82
|
+
- 请求用户已认证且拥有目标订单。
|
|
83
|
+
When:
|
|
84
|
+
- 用户请求目标订单退款状态。
|
|
85
|
+
Then:
|
|
86
|
+
- HTTP 状态码为 200。
|
|
87
|
+
- 返回 refundStatus 和 updatedAt。
|
|
88
|
+
- 查询不得修改退款记录。
|
|
89
|
+
异常场景:
|
|
90
|
+
- 无权访问时返回 403 且不得泄露订单详情。
|
|
91
|
+
## 7. 决策追溯
|
|
92
|
+
- 需求直接来源于明确需求。
|
|
93
|
+
`;
|
|
94
|
+
|
|
95
|
+
const api = `---
|
|
96
|
+
artifact_version: "3.0"
|
|
97
|
+
artifact_type: api-documentation
|
|
98
|
+
requirement_id: refund-status
|
|
99
|
+
project_root: ../../..
|
|
100
|
+
api_status: complete
|
|
101
|
+
analysis_scope: backend
|
|
102
|
+
source_product_requirement: ./product-requirement.md
|
|
103
|
+
repository_root: ../../..
|
|
104
|
+
---
|
|
105
|
+
# API Documentation
|
|
106
|
+
## 1. 通用约定
|
|
107
|
+
### 1.1 Base URL
|
|
108
|
+
- /api/v1
|
|
109
|
+
### 1.2 统一响应结构
|
|
110
|
+
- data 包裹成功响应。
|
|
111
|
+
### 1.3 错误响应结构
|
|
112
|
+
- code 和 message。
|
|
113
|
+
### 1.4 分页约定
|
|
114
|
+
- 本接口不分页。
|
|
115
|
+
### 1.5 时间和标识符规范
|
|
116
|
+
- ISO 8601 和字符串 ID。
|
|
117
|
+
## 2. API 索引
|
|
118
|
+
| API | Method + Path | Operation ID | 用户故事 | AC | 变更 |
|
|
119
|
+
|---|---|---|---|---|---|
|
|
120
|
+
| API-001 | GET /api/v1/orders/{orderId}/refund-status | getRefundStatus | BE-US-001 | AC-BE-001 | 新增 |
|
|
121
|
+
## 3. API 详情
|
|
122
|
+
### API-001 查询退款状态
|
|
123
|
+
> \`GET /api/v1/orders/{orderId}/refund-status\`
|
|
124
|
+
#### 基本信息
|
|
125
|
+
| 字段 | 值 |
|
|
126
|
+
|---|---|
|
|
127
|
+
| Operation ID | getRefundStatus |
|
|
128
|
+
| 变更类型 | 新增 |
|
|
129
|
+
| 幂等性 | 只读请求天然幂等 |
|
|
130
|
+
#### Path 参数
|
|
131
|
+
| 参数 | 类型 | 必填 | 语义 |
|
|
132
|
+
|---|---|---|---|
|
|
133
|
+
| orderId | string | 是 | 订单标识 |
|
|
134
|
+
#### 成功响应
|
|
135
|
+
- HTTP:200
|
|
136
|
+
\`\`\`json
|
|
137
|
+
{"data":{"refundStatus":"processing","updatedAt":"2026-01-01T00:00:00Z"}}
|
|
138
|
+
\`\`\`
|
|
139
|
+
#### 错误响应
|
|
140
|
+
| 状态码 | 错误码 | 条件 |
|
|
141
|
+
|---|---|---|
|
|
142
|
+
| 403 | FORBIDDEN | 资源访问被拒绝 |
|
|
143
|
+
\`\`\`json
|
|
144
|
+
{"code":"FORBIDDEN","message":"forbidden"}
|
|
145
|
+
\`\`\`
|
|
146
|
+
## 4. 数据模型
|
|
147
|
+
- RefundStatus 包含 refundStatus 和 updatedAt。
|
|
148
|
+
## 5. 错误码
|
|
149
|
+
- FORBIDDEN:请求被拒绝。
|
|
150
|
+
`;
|
|
151
|
+
|
|
152
|
+
const dependency = `---
|
|
153
|
+
artifact_version: "3.0"
|
|
154
|
+
artifact_type: dependency-analysis
|
|
155
|
+
requirement_id: refund-status
|
|
156
|
+
project_root: ../../..
|
|
157
|
+
analysis_scope: backend
|
|
158
|
+
source_product_requirement: ./product-requirement.md
|
|
159
|
+
source_api_documentation: ./api-documentation.md
|
|
160
|
+
repository_root: ../../..
|
|
161
|
+
analysis_status: complete
|
|
162
|
+
blocked_on: none
|
|
163
|
+
---
|
|
164
|
+
# Dependency Analysis
|
|
165
|
+
## 1. 输入与代码基线
|
|
166
|
+
- 需求:./product-requirement.md
|
|
167
|
+
- 仓库:../../..
|
|
168
|
+
## 2. 用户故事覆盖矩阵
|
|
169
|
+
| 故事 | AC | API | 主要代码入口 | 状态 |
|
|
170
|
+
|---|---|---|---|---|
|
|
171
|
+
| BE-US-001 | AC-BE-001 | API-001 | F1 | confirmed |
|
|
172
|
+
## 3. 后端依赖详情
|
|
173
|
+
### BE-US-001 查询退款状态
|
|
174
|
+
- 验收标准:AC-BE-001
|
|
175
|
+
- API 文档引用:API-001
|
|
176
|
+
- 影响文件:
|
|
177
|
+
- F1 modify \`src/refund/refund.controller.ts\`:增加查询入口
|
|
178
|
+
- F2 modify \`src/refund/refund.service.ts\`:组合退款状态
|
|
179
|
+
- F3 reuse \`src/refund/refund.repository.ts\`:读取退款记录
|
|
180
|
+
- 路由/入口:F1 注册退款状态路由
|
|
181
|
+
- Controller/Handler:F1 校验身份和订单 ID
|
|
182
|
+
- Service/领域逻辑:F2 组合状态和更新时间
|
|
183
|
+
- DTO/Schema:F1 复用统一响应结构
|
|
184
|
+
- 数据依赖:F3 读取退款记录
|
|
185
|
+
- 权限依赖:F1 校验订单归属
|
|
186
|
+
- 错误/日志/审计:F1 映射 403 和 404
|
|
187
|
+
- 测试落点:F1、F2 的相邻测试文件
|
|
188
|
+
- 定位证据:现有订单路由调用 F2,F2 注入 F3
|
|
189
|
+
- 风险:旧退款记录可能缺少 updatedAt
|
|
190
|
+
- 置信度:high
|
|
191
|
+
## 4. API 实现映射
|
|
192
|
+
| API | Operation ID | 方法与路径 | 代码入口 |
|
|
193
|
+
|---|---|---|---|
|
|
194
|
+
| API-001 | getRefundStatus | GET /api/v1/orders/{orderId}/refund-status | F1 |
|
|
195
|
+
## 5. 跨故事共享依赖
|
|
196
|
+
- 复用订单鉴权和统一错误结构。
|
|
197
|
+
## 6. 风险与未定位项
|
|
198
|
+
- 需要确认历史数据的 updatedAt 完整性。
|
|
199
|
+
`;
|
|
200
|
+
|
|
201
|
+
writeFileSync(requirementPath, requirement);
|
|
202
|
+
writeFileSync(apiPath, api);
|
|
203
|
+
writeFileSync(dependencyPath, dependency);
|
|
204
|
+
|
|
205
|
+
const paginationSections = `#### Query 参数
|
|
206
|
+
| 参数 | 类型 | 必填 | 允许值 | 语义 |
|
|
207
|
+
|---|---|---|---|---|
|
|
208
|
+
| pageSize | integer | 否 | 10 \| 20 \| 50 \| 100 | 每页条数 |
|
|
209
|
+
| cursor | string | 否 | - | 下一页游标 |
|
|
210
|
+
`;
|
|
211
|
+
const paginatedApi = api.replace("#### 成功响应", `${paginationSections}#### 成功响应`);
|
|
212
|
+
|
|
213
|
+
let checks = 0;
|
|
214
|
+
function expectPass(name, script, args) { pass(name, run(script, args)); checks += 1; }
|
|
215
|
+
function expectFail(name, script, args, message) { fail(name, run(script, args), message); checks += 1; }
|
|
216
|
+
|
|
217
|
+
expectPass("valid V3 requirement input", requirementValidator, [requirementPath, "--target", "backend"]);
|
|
218
|
+
expectFail("reject scope expansion", requirementValidator, [requirementPath, "--target", "both"], "not included");
|
|
219
|
+
expectFail("require matching output spec", requirementValidator, [variant("requirement-no-spec.md", requirement.replace("### BE-US-001 查询退款状态\n- 输入语义", "### BE-US-002 查询退款状态\n- 输入语义"))], "Missing output specification");
|
|
220
|
+
expectFail("require matching AC", requirementValidator, [variant("requirement-bad-ac.md", requirement.replace("- 验收标准:AC-BE-001", "- 验收标准:AC-BE-002"))], "must match");
|
|
221
|
+
|
|
222
|
+
expectPass("valid compact API documentation", apiValidator, [requirementPath, apiPath, "--target", "backend"]);
|
|
223
|
+
writeFileSync(apiPath, paginatedApi);
|
|
224
|
+
expectPass("valid optional page sizes", apiValidator, [requirementPath, apiPath]);
|
|
225
|
+
writeFileSync(apiPath, api);
|
|
226
|
+
expectFail("pagination requires all page sizes", apiValidator, [requirementPath, variant("api-pagination-incomplete.md", paginatedApi.replace("10 | 20 | 50 | 100", "10 | 20 | 50"))], "exactly 10, 20, 50, and 100");
|
|
227
|
+
expectFail("pagination page size must be optional", apiValidator, [requirementPath, variant("api-pagination-required.md", paginatedApi.replace("| pageSize | integer | 否 |", "| pageSize | integer | 是 |"))], "must be optional");
|
|
228
|
+
expectFail("API index covers story", apiValidator, [requirementPath, variant("api-no-story.md", api.replace("BE-US-001 | AC-BE-001", "BE-US-999 | AC-BE-001"))], "does not cover");
|
|
229
|
+
expectFail("API success JSON must parse", apiValidator, [requirementPath, variant("api-bad-json.md", api.replace("{\"data\":{\"refundStatus\":\"processing\",\"updatedAt\":\"2026-01-01T00:00:00Z\"}}", "{bad json}"))], "must be valid JSON");
|
|
230
|
+
expectFail("API does not repeat ID", apiValidator, [requirementPath, variant("api-repeat-id.md", api.replace("| Operation ID | getRefundStatus |", "| API ID | API-001 |\n| Operation ID | getRefundStatus |"))], "must not repeat API ID");
|
|
231
|
+
expectFail("API rejects authentication sections", apiValidator, [requirementPath, variant("api-auth.md", api.replace("### 1.2 统一响应结构", "### 1.2 认证方式\n- Bearer token\n### 1.3 统一响应结构"))], "must not contain authentication");
|
|
232
|
+
expectFail("API rejects reuse-check output", apiValidator, [requirementPath, variant("api-reuse-check.md", api.replace("## 4. 数据模型", "## 4. 数据模型\n### 4.1 复用检查"))], "must not contain reuse-check");
|
|
233
|
+
|
|
234
|
+
expectPass("valid V3 dependency analysis", dependencyValidator, [requirementPath, dependencyPath, apiPath, "--target", "backend"]);
|
|
235
|
+
expectFail("impact files are required", dependencyValidator, [requirementPath, variant("dependency-no-impact.md", dependency.replace(/- 影响文件:[\s\S]*?- 路由\/入口:/, "- 路由/入口:")), apiPath], "missing field 影响文件");
|
|
236
|
+
expectFail("impact file IDs must be declared", dependencyValidator, [requirementPath, variant("dependency-bad-file-ref.md", dependency.replace("- Service/领域逻辑:F2", "- Service/领域逻辑:F9")), apiPath], "undeclared impact file F9");
|
|
237
|
+
expectFail("dependency rejects trace summary", dependencyValidator, [requirementPath, variant("dependency-trace.md", dependency + "\n## 7. 追溯汇总\n- BE-US-001。\n"), apiPath], "must not contain 分析范围 or 追溯汇总");
|
|
238
|
+
expectFail("API mapping keeps operation", dependencyValidator, [requirementPath, variant("dependency-no-operation.md", dependency.replace("getRefundStatus", "missingOperation")), apiPath], "missing Operation ID getRefundStatus");
|
|
239
|
+
expectFail("dependency AC matches requirement", dependencyValidator, [requirementPath, variant("dependency-bad-ac.md", dependency.replace("- 验收标准:AC-BE-001", "- 验收标准:AC-BE-002")), apiPath], "must match Product Requirement");
|
|
240
|
+
|
|
241
|
+
const blocked = `---
|
|
242
|
+
artifact_version: "3.0"
|
|
243
|
+
artifact_type: dependency-analysis
|
|
244
|
+
requirement_id: refund-status
|
|
245
|
+
project_root: ../../..
|
|
246
|
+
analysis_scope: backend
|
|
247
|
+
source_product_requirement: none
|
|
248
|
+
source_api_documentation: none
|
|
249
|
+
repository_root: none
|
|
250
|
+
analysis_status: blocked
|
|
251
|
+
blocked_on: requirement-missing repository-missing
|
|
252
|
+
---
|
|
253
|
+
# Dependency Analysis
|
|
254
|
+
## 1. 分析范围
|
|
255
|
+
- backend
|
|
256
|
+
## 2. 输入与代码基线
|
|
257
|
+
- 未提供需求和仓库。
|
|
258
|
+
## 3. 阻断原因
|
|
259
|
+
- 缺少 Product Requirement。
|
|
260
|
+
## 4. 恢复条件
|
|
261
|
+
- 提供 complete Product Requirement 和仓库。
|
|
262
|
+
`;
|
|
263
|
+
writeFileSync(dependencyPath, blocked);
|
|
264
|
+
expectPass("valid blocked dependency", dependencyValidator, ["none", dependencyPath, "--target", "backend"]);
|
|
265
|
+
writeFileSync(dependencyPath, dependency);
|
|
266
|
+
|
|
267
|
+
console.log(`Dependency V3 validator matrix passed: ${checks} checks.`);
|
|
@@ -0,0 +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);
|
|
@@ -0,0 +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);
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
import { acceptanceBlocks, assertHeadings, containsUnresolvedBlockingPriority, field, load, metadata, outputSpecBlocks, print, scopeIncludes, section, storyBlocks, validateAcceptance, validateArtifactLocation } from "./validation-helpers.mjs";
|
|
4
|
+
|
|
5
|
+
const args = process.argv.slice(2);
|
|
6
|
+
const fileArg = args[0];
|
|
7
|
+
const targetIndex = args.indexOf("--target");
|
|
8
|
+
const target = targetIndex >= 0 ? args[targetIndex + 1] : args[1];
|
|
9
|
+
if (!fileArg) {
|
|
10
|
+
console.error("Usage: node validate-product-requirement-input.mjs <product-requirement.md> [frontend|backend|both] | [--target frontend|backend|both]");
|
|
11
|
+
process.exit(2);
|
|
12
|
+
}
|
|
13
|
+
let artifact;
|
|
14
|
+
try { artifact = load(fileArg, "Product Requirement"); }
|
|
15
|
+
catch (error) { console.error(error.message); process.exit(2); }
|
|
16
|
+
|
|
17
|
+
const errors = [];
|
|
18
|
+
validateArtifactLocation(artifact, errors, "product-requirement.md");
|
|
19
|
+
const version = metadata(artifact.text, "artifact_version");
|
|
20
|
+
const upstreamScope = metadata(artifact.text, "analysis_scope");
|
|
21
|
+
const scope = target ?? upstreamScope;
|
|
22
|
+
if (!["2.0", "3.0"].includes(version)) errors.push("artifact_version must be 2.0 or 3.0.");
|
|
23
|
+
if (metadata(artifact.text, "artifact_type") !== "product-requirement") errors.push("artifact_type must be product-requirement.");
|
|
24
|
+
if (metadata(artifact.text, "requirement_status") !== "complete") errors.push("requirement_status must be complete.");
|
|
25
|
+
if (!["frontend", "backend", "both"].includes(upstreamScope)) errors.push("analysis_scope must be frontend, backend, or both.");
|
|
26
|
+
if (!["frontend", "backend", "both"].includes(scope)) errors.push("target must be frontend, backend, or both.");
|
|
27
|
+
else if (!scopeIncludes(upstreamScope, scope)) errors.push(`target ${scope} is not included in upstream scope ${upstreamScope}.`);
|
|
28
|
+
|
|
29
|
+
if (version === "3.0") {
|
|
30
|
+
assertHeadings(artifact.text, 2, ["需求概述", "业务目标", "需求范围", "业务规则", "决策追溯"], errors, "Product Requirement");
|
|
31
|
+
if (/^##\s+(?:\d+[.、]?\s*)?(?:用户角色|验收标准汇总)\s*$/m.test(artifact.text)) errors.push("V3 Product Requirement must not contain standalone 用户角色 or 验收标准汇总 sections.");
|
|
32
|
+
} else {
|
|
33
|
+
assertHeadings(artifact.text, 2, ["需求背景", "需求摘要", "业务目标", "用户角色", "需求范围", "业务规则", "验收标准汇总", "决策追溯"], errors, "V2 Product Requirement");
|
|
34
|
+
}
|
|
35
|
+
const range = section(artifact.text, 2, "需求范围") ?? "";
|
|
36
|
+
assertHeadings(range, 3, ["已确认需求", "非目标", "默认假设", "未决事项"], errors, "需求范围");
|
|
37
|
+
if (containsUnresolvedBlockingPriority(section(range, 3, "未决事项") ?? "")) errors.push("Product Requirement contains unresolved P0/P1 items.");
|
|
38
|
+
|
|
39
|
+
function validateDomain(name) {
|
|
40
|
+
const frontend = name === "frontend";
|
|
41
|
+
const title = frontend ? "前端" : "后端";
|
|
42
|
+
const prefix = frontend ? "FE-US" : "BE-US";
|
|
43
|
+
const acPrefix = frontend ? "AC-FE" : "AC-BE";
|
|
44
|
+
const storyFields = version === "3.0"
|
|
45
|
+
? (frontend ? ["角色", "目标", "价值", "入口", "验收标准"] : ["系统能力", "使用方", "业务价值", "触发方式", "验收标准"])
|
|
46
|
+
: (frontend ? ["用户角色", "用户目标", "页面/入口", "页面/组件", "展示内容", "交互动作", "UI 状态", "权限可见性", "前端边界处理", "验收标准"] : ["系统能力", "使用方", "触发方式", "输入语义", "输出语义", "数据读写", "权限规则", "业务规则", "安全要求", "后端边界处理", "验收标准"]);
|
|
47
|
+
assertHeadings(artifact.text, 2, [`${title}用户故事`, `${title}输出规范`], errors, "Product Requirement");
|
|
48
|
+
const stories = storyBlocks(section(artifact.text, 2, `${title}用户故事`), prefix);
|
|
49
|
+
if (!stories.length) errors.push(`Missing ${prefix}-* stories.`);
|
|
50
|
+
const specs = version === "3.0" ? outputSpecBlocks(section(artifact.text, 2, `${title}输出规范`), prefix) : [];
|
|
51
|
+
const specFields = frontend ? ["页面/组件", "展示内容", "交互动作", "UI 状态", "表单校验", "权限可见性", "边界处理"] : ["输入语义", "输出语义", "数据读写", "权限规则", "业务规则", "安全要求", "幂等与并发", "错误与边界"];
|
|
52
|
+
const seen = new Set();
|
|
53
|
+
for (const story of stories) {
|
|
54
|
+
if (seen.has(story.id)) errors.push(`Duplicate story ID: ${story.id}.`);
|
|
55
|
+
seen.add(story.id);
|
|
56
|
+
for (const fieldName of storyFields) if (!field(story.text, fieldName)) errors.push(`${story.id} is missing field ${fieldName}.`);
|
|
57
|
+
if (!frontend && !/^(?:API|定时任务|事件|消息|内部调用|数据迁移)(?:$|[、,,/])/i.test(field(story.text, "触发方式") ?? "")) errors.push(`${story.id} 触发方式 is invalid.`);
|
|
58
|
+
const container = version === "3.0" ? specs.find((spec) => spec.id === story.id) : story;
|
|
59
|
+
if (!container) {
|
|
60
|
+
errors.push(`Missing output specification for ${story.id}.`);
|
|
61
|
+
continue;
|
|
62
|
+
}
|
|
63
|
+
if (version === "3.0") for (const fieldName of specFields) if (!field(container.text, fieldName)) errors.push(`${story.id} output specification is missing field ${fieldName}.`);
|
|
64
|
+
const criteria = acceptanceBlocks(container, acPrefix);
|
|
65
|
+
if (!criteria.length) errors.push(`${story.id} is missing embedded acceptance criteria.`);
|
|
66
|
+
const actual = criteria.map((item) => item.id).sort();
|
|
67
|
+
const referenced = [...(field(story.text, "验收标准") ?? "").matchAll(new RegExp(`${acPrefix}-\\d{3,}`, "g"))].map((item) => item[0]).sort();
|
|
68
|
+
if (actual.join() !== referenced.join()) errors.push(`${story.id} acceptance references must match its embedded criteria.`);
|
|
69
|
+
for (const item of criteria) validateAcceptance(item.text, item.id, errors);
|
|
70
|
+
}
|
|
71
|
+
if (version === "3.0") for (const spec of specs) if (!stories.some((story) => story.id === spec.id)) errors.push(`Output specification references unknown story ${spec.id}.`);
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
if (scope === "frontend" || scope === "both") validateDomain("frontend");
|
|
75
|
+
if (scope === "backend" || scope === "both") validateDomain("backend");
|
|
76
|
+
print("Product Requirement input", artifact.path, errors);
|