@hunter-harness/workflow-harness 0.3.1 → 0.4.1

package/harness/bundles/java/pi/harness-apidoc/checklist.md

@@ -0,0 +1,142 @@
+---
+description: harness-apidoc 的7步工作流详细步骤、接口提取规则和执行日志记录格式。仅在执行文档生成流程时读取。
+---
+
+# harness-apidoc 检查清单
+
+## 步骤 0：启动准备
+
+确定变更名：用 Glob 搜索 `.harness/changes/*/plans/*-plan.md`（**排除 `.harness/archive/*/`**），读取 frontmatter 提取 `change-name`。默认最多一个未归档变更；如有多个，优先取最近修改的，或询问用户。
+
+**检查 worktree**：读取 `.harness/changes/<change-name>/meta/worktree.json`（旧路径兼容根目录 `worktree.json`）：
+
+- `requested=true` 且 `worktreeRoot` 存在 → cd 到 `worktreeRoot`，确保读取 worktree 中最新代码
+- `requested=true` 但 worktree 不存在 → **停止并提示用户修复 worktree 状态，不得静默回到主目录**
+- `requested=false` 或文件不存在 → 在主目录执行
+
+不要用 `**` 通配符扫描 worktree（返回 100+ 无关文件）。
+
+**append `phase.start`**（`harness_events.py`；禁止手工 Edit `execution-log.md`）：
+
+```powershell
+python <skills-root>/scripts/harness_events.py append --change-dir ".harness/changes/<change-name>" --phase apidoc --type phase.start --note "<触发指令>"
+```
+
+## 步骤 1：识别变更范围
+
+读取变更计划文件，结合 `git diff --stat` 确定涉及的 Controller、VO、ErrorCode 文件。
+
+**⚠️ 必读：审查 logs/execution-log.md 中的后续修复记录**
+
+plan 文件是初始设计，代码可能在 review/test 阶段被修改。必须读取 `logs/execution-log.md` 中 plan 之后的条目（旧路径兼容根目录 `execution-log.md`；特别是 harness-review 和审查修复补充），关注：
+
+- 哪些方法被修改了实现逻辑（如硬编码改为枚举）
+- 哪些字段被新增/删除/重命名
+- 哪些行为发生了变更（如权限策略调整）
+
+在生成文档时，以**实际代码**为准，不以 plan 文件的伪代码为准。
+
+## 步骤 2：提取接口信息
+
+逐个读取变更涉及的 Controller 文件，提取：
+
+- **接口路径和方法**：从 `@RequestMapping`、`@GetMapping`、`@PostMapping` 等注解
+- **请求参数**：从方法签名和 `@RequestBody`、`@RequestParam`、`@PathVariable` 注解
+- **请求体结构**：从 SaveReqVO、PageReqVO 等请求 VO 的字段定义
+- **响应体结构**：从 RespVO、SimpleRespVO 等响应 VO 的字段定义
+- **校验规则**：从 VO 上的 `@NotNull`、`@NotBlank`、`@Size` 等校验注解
+- **错误码**：从 ErrorCodeConstants 或相关常量类
+
+用 CodeGraph 辅助探索调用链（Controller → Service → Mapper），理解接口的业务逻辑。
+
+**⚠️ 行为变更接口必须读 Service 实际实现**
+
+对于有行为变更的接口（如权限调整、返回值结构变更、查询逻辑修改），必须读取 Service 实现类的实际代码，不能仅依赖 plan 文件中的伪代码。
+
+重点验证：
+
+- `getMeta()` 等返回动态数据的接口 → 读实际返回值构造逻辑
+- 枚举/常量值 → 读实际枚举类源码，不从 plan 推断
+- 权限校验逻辑 → 读实际 Service 方法体
+
+**枚举值交叉验证**：数据字典中的枚举值必须从实际枚举类源码提取，不从 plan 文件的伪代码推断。如果 plan 中写 `new SceneMetaVO("1", ...)` 但实际代码用 `ProjectTypeEnum.DELIVERY.getCode()`，以实际代码为准。
+
+**codegraph 降级策略**：
+
+- `codegraph_search` 返回 0 结果时（新文件索引未同步），立即用 Grep 搜索
+- `codegraph_node` 遇到重名符号时（如多个 ErrorCodeConstants），用 `file` 参数指定文件名
+- 不要对同一符号重复调用 codegraph_node 超过 2 次，第 2 次仍不对则用 Read 直接读文件
+
+## 步骤 3：确定文档类型
+
+| 变更规模 | 文档类型 | 说明 |
+|----------|----------|------|
+| 新功能/新模块（5+ 新接口） | **完整接口文档** | 包含所有章节 |
+| 扩展已有接口（新增字段、修改逻辑） | **增量接口文档** | 只描述变更部分，注明与旧版本的差异 |
+| 小改动（1-2 个字段变更） | **增量接口文档** | 简要描述变更 |
+
+## 步骤 4：生成文档
+
+按照 `reference.md` 的7章节模板生成文档。关键要求：
+- 每个接口必须有：路径参数表、Query/请求体字段表、响应字段表
+- 响应示例必须包含完整 JSON
+- 字段表必须包含：字段名、类型、必填（请求）、说明
+- 校验规则写入字段表的「校验」列（如 `≤50字符`、`枚举`）
+- 枚举值必须列入「数据字典」章节，标注前端展示方式
+- 前端用法要写具体（不是"展示数据"，而是控件+联动）
+- 扩展接口必须描述行为变更（不只是字段变更）
+- 前端交互建议用表格：操作 → 接口 → 触发时机 → 交互效果
+- 兼容性说明用表格：场景 → 旧行为 → 新行为 → 前端处理
+- 错误码必须包含触发场景列
+- 从代码提取信息，不从需求文档猜测
+
+**⚠️ 前端影响分级标注（强制）**
+
+每个变更接口必须标注前端影响级别，让前端开发者一眼看出哪些需要改代码、哪些无需处理：
+
+| 标记 | 含义 | 前端动作 |
+|:----:|------|----------|
+| 🔴 **BREAKING** | 破坏性变更，前端不修改会报错或功能异常 | **必须修改**，优先处理 |
+| 🟡 **NEEDS-UPDATE** | 非破坏性变更，但前端需要适配才能使用新功能 | **建议修改**，否则无法使用新能力 |
+| 🟢 **TRANSPARENT** | 后端内部变更，前端无感，无需修改 | 无需处理，仅供了解 |
+
+**判定规则**：
+
+- 🔴 **BREAKING**：删除字段、字段类型变更、枚举值删除/变更、请求必填字段新增、响应结构变更、接口路径变更
+- 🟡 **NEEDS-UPDATE**：新增可选字段、新增可选参数、新增响应字段（前端可选渲染）、行为变更（如权限放开，前端可删除旧的 403 处理）
+- 🟢 **TRANSPARENT**：后端内部重构（如死代码删除、Mapper 优化）、性能优化、日志变更、注释变更
+
+**标注位置**：
+
+1. **接口变更概览表**：在「变更」列后增加「前端影响」列
+2. **扩展接口详情**：每个接口标题下方用 callout 标注
+3. **文档开头**：增加「前端改动清单」摘要章节
+
+**前端改动清单模板**（放在文档开头，接口变更概览之前）：
+
+```markdown
+## ⚡ 前端改动清单
+
+> 前端开发者请优先处理以下 🔴 BREAKING 项，其次处理 🟡 NEEDS-UPDATE 项。
+
+| 优先级 | 接口 | 改动点 | 前端动作 |
+|:------:|------|--------|----------|
+| 🔴 | `GET /indicator/meta` | `applicableScenes[].code` 值从数字改为枚举编码 | Select 组件 value 改用 `projectType` 字段 |
+| 🔴 | `POST /indicator/applicable` | 请求体 `sceneCode` 删除 | 改为传 `projectType` |
+| 🟡 | `GET /indicator/enabled` | 新增 `projectType` 过滤参数 | 可选适配，传入可筛选适用指标 |
+| 🟢 | `POST /indicator/list` | 后端自动 orgCode 过滤 | 无需处理，前端可删除传 orgCode 逻辑 |
+```
+
+## 步骤 5：保存文档
+
+用 Write 工具保存到 `.harness/changes/<change-name>/apidoc/<模块名>-前端接口文档-YYYY-MM-DD.md`。
+
+## 步骤 6：展示并确认
+
+展示文档摘要，询问用户是否满意。不满意 → 修改后重新保存。
+
+**append `phase.complete`**（`note` 含结果/摘要/文档路径）：
+
+```powershell
+python <skills-root>/scripts/harness_events.py append --change-dir ".harness/changes/<change-name>" --phase apidoc --type phase.complete --note "OK|WARN|FAIL — <摘要>"
+```

package/harness/bundles/java/pi/harness-apidoc/reference.md

@@ -0,0 +1,233 @@
+---
+description: harness-apidoc 的文档7章节完整模板和增量接口文档差异说明。仅在生成文档需要参考模板结构时读取。
+---
+
+# harness-apidoc 参考 — 文档模板
+
+## 文档7章节完整模板
+
+```markdown
+# <模块名> — 前端接口文档
+
+> **版本**：V<N> ｜ **日期**：YYYY-MM-DD ｜ **变更**：<change-name>
+> **基础路径**：`/<模块路径>` ｜ **认证**：Bearer Token ｜ **Content-Type**：`application/json`
+
+---
+
+## ⚡ 前端改动清单
+
+> 前端开发者请优先处理以下 🔴 BREAKING 项，其次处理 🟡 NEEDS-UPDATE 项。
+
+| 优先级 | 接口 | 改动点 | 前端动作 |
+|:------:|------|--------|----------|
+| 🔴 | `GET /xxx/meta` | `code` 值从数字改为枚举编码 | Select 组件 value 改用 `projectType` 字段 |
+| 🔴 | `POST /xxx/applicable` | 请求体 `sceneCode` 删除 | 改为传 `projectType` |
+| 🟡 | `GET /xxx/enabled` | 新增 `projectType` 过滤参数 | 可选适配，传入可筛选适用数据 |
+| 🟢 | `POST /xxx/list` | 后端自动 orgCode 过滤 | 无需处理，前端可删除传 orgCode 逻辑 |
+
+> 影响级别：🔴 BREAKING（必须修改）｜ 🟡 NEEDS-UPDATE（建议修改）｜ 🟢 TRANSPARENT（无需处理）
+
+---
+
+## 一、接口变更概览
+
+| # | 方法 | 路径 | 说明 | 变更 | 前端影响 |
+|:--:|------|------|------|:----:|:--------:|
+| 1 | GET | `/xxx/meta` | 获取下拉选项 | 🆕 新增 | — |
+| 2 | POST | `/xxx/applicable` | 查询可用数据 | 🆕 新增 | — |
+| 3 | POST | `/xxx/list/{pageNum}/{pageSize}` | 分页查询（新增字段） | 📝 扩展 | 🟡 |
+| 4 | GET | `/xxx/{id}` | 详情（新增子表） | 📝 扩展 | 🟡 |
+| 5 | DELETE | `/xxx/{ids}` | 批量删除 | — 不变 | 🟢 |
+
+> 变更标记：🆕 新增 ｜ 📝 扩展 ｜ ❌ 删除 ｜ — 不变 ｜ ⚠️ 废弃
+> 前端影响：🔴 BREAKING ｜ 🟡 NEEDS-UPDATE ｜ 🟢 TRANSPARENT
+
+---
+
+## 二、新增接口
+
+### 2.1 <接口名称>
+
+> `GET /xxx/meta` ｜ 用途：获取下拉选项
+
+**路径参数**：无
+
+**Query 参数**：
+
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|:----:|------|
+| `type` | String | 是 | 选项类型（见数据字典） |
+
+**响应示例**：
+
+```json
+{
+  "code": 0,
+  "msg": "成功",
+  "data": [
+    { "label": "选项A", "value": "A" }
+  ]
+}
+```
+
+**响应字段**：
+
+| 字段 | 类型 | 说明 |
+|------|------|------|
+| `data[].label` | String | 选项显示文本 |
+| `data[].value` | String | 选项值 |
+
+**前端用法**：`type` → 下拉选择控件数据源
+
+---
+
+### 2.2 <接口名称>
+
+> `POST /xxx/applicable` ｜ 用途：查询可用数据
+
+**请求体示例**：
+
+```json
+{
+  "keyword": "张三",
+  "status": "ENABLED"
+}
+```
+
+**请求字段**：
+
+| 字段 | 类型 | 必填 | 校验 | 说明 |
+|------|------|:----:|------|------|
+| `keyword` | String | 否 | ≤50字符 | 模糊搜索关键词 |
+| `status` | String | 否 | 枚举 | 状态过滤（见数据字典） |
+
+**响应字段**：
+
+| 字段 | 类型 | 说明 |
+|------|------|------|
+| `data[].id` | Long | 数据ID |
+| `data[].name` | String | 数据名称 |
+| `data[].status` | String | 状态（见数据字典） |
+
+**前端用法**：
+- `keyword` → 搜索输入框，输入后实时查询
+- `status` → 筛选下拉框，选中后过滤结果
+
+---
+
+## 三、扩展接口详情
+
+### 3.1 <接口名称>（新增字段）
+
+> `POST /xxx/list/{pageNum}/{pageSize}` ｜ 变更：新增 `status` 查询条件 + 响应新增 `status` 字段
+
+> 🟡 **NEEDS-UPDATE**：前端可选适配新字段，不修改不影响现有功能
+
+**新增请求字段**：
+
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|:----:|------|
+| `status` | String | 否 | 状态过滤（见数据字典） |
+
+**新增响应字段**：
+
+| 字段 | 类型 | 说明 |
+|------|------|------|
+| `data.list[].status` | String | 状态值（见数据字典） |
+
+**行为变更**：分页结果默认按创建时间倒序（原为正序）
+
+---
+
+## 四、数据结构
+
+### VO 定义
+
+#### <VOName>（<用途>）
+
+```typescript
+interface <VOName> {
+  id: number;              // 数据ID
+  name: string;            // 数据名称
+  status: string;          // 状态（见数据字典）
+  createTime: string | null; // 创建时间，ISO 8601
+}
+```
+
+### 数据字典
+
+#### status — 状态
+
+| 值 | 说明 | 前端展示 |
+|------|------|------|
+| `ENABLED` | 启用 | 🟢 绿色标签 |
+| `DISABLED` | 禁用 | 🔴 红色标签 |
+
+#### type — 选项类型
+
+| 值 | 说明 |
+|------|------|
+| `A` | 类型A |
+| `B` | 类型B |
+
+---
+
+## 五、前端交互建议
+
+### <页面名称>
+
+| 操作 | 调用接口 | 触发时机 | 交互效果 |
+|------|----------|----------|----------|
+| 页面加载 | `GET /xxx/meta` | `onMounted` | 填充筛选下拉框 |
+| 搜索 | `POST /xxx/list` | 输入后防抖 300ms | 刷新表格数据 |
+| 查看详情 | `GET /xxx/{id}` | 点击行 | 弹出详情抽屉 |
+
+---
+
+## 六、兼容性说明
+
+| 场景 | 旧行为 | 新行为 | 前端处理 |
+|------|--------|--------|----------|
+| `status=null` 的历史数据 | 字段不存在 | 返回 `null` | 前端判空显示「未设置」 |
+| 旧版分页响应 | 无 `status` 字段 | 新增 `status` 字段 | 前端可选渲染，不阻塞 |
+
+---
+
+## 七、错误码速查表
+
+| 编码 | 常量 | 信息 | 触发场景 |
+|------|------|------|----------|
+| 1002001 | `XXX_NOT_FOUND` | 数据不存在 | 查询ID不存在 |
+| 1002002 | `XXX_STATUS_INVALID` | 状态不允许操作 | 状态流转违规 |
+```
+
+## 增量接口文档差异
+
+增量文档与完整文档结构相同，但：
+
+- **前端改动清单**：必须包含，放在文档开头，列出所有 🔴 和 🟡 项
+- **接口变更概览**：只列出有变更的接口，必须包含「前端影响」列
+- **新增接口**章节：只写新增的
+- **扩展接口详情**：每个接口只展示新增/变更字段，用注释标注 `// ========== 新增字段 ==========`
+- **前端影响标注**：每个扩展接口标题下方必须用 callout 标注影响级别：
+
+  ```markdown
+  > 🔴 **BREAKING**：请求体 `sceneCode` 字段已删除，前端必须改为传 `projectType`，否则接口无法正常工作
+
+  > 🟡 **NEEDS-UPDATE**：新增 `projectType` 可选参数，前端可选适配以使用筛选功能
+
+  > 🟢 **TRANSPARENT**：后端自动 orgCode 过滤，前端无需修改（可选删除旧的传 orgCode 逻辑）
+  ```
+
+- **审查修复标注**：如果接口在 review 阶段被修改，在扩展接口详情中添加标注：
+
+  ```markdown
+  > ℹ️ **审查修复**：此接口在 harness-review 阶段有以下修改：
+  > - `code` 值从硬编码数字改为 `ProjectTypeEnum` 枚举编码
+  > - 前端依赖 `code` 字段需同步更新
+  ```
+
+- **数据结构**：只写新增或变更的 VO 字段和数据字典
+- **兼容性说明**：重点描述旧数据如何兼容新字段 + 审查修复引入的 breaking change，每行标注影响级别
+- **错误码**：只列新增的错误码
+- **前端交互建议**：只描述受变更影响的页面和操作