@specpow/framework 0.5.11 → 0.5.13

package/builtin/schemas/bug-fix/schema.yaml

@@ -0,0 +1,77 @@
+# Bug 修复 Schema
+# 用于快速定位和修复 Bug 的工件流
+
+name: bug-fix
+description: 系统化定位和修复 Bug
+
+apply:
+  requires:
+    - tasks
+
+artifacts:
+  - id: proposal
+    name: Bug 描述
+    description: 描述 Bug 现象和复现步骤
+    requires: []
+    template: proposal.md
+    instruction: |
+      记录 Bug 信息：
+      - Bug 标题
+      - 复现步骤（Step 1, 2, 3...）
+      - 预期行为
+      - 实际行为
+      - 环境信息
+      - 影响范围
+    output: proposal.md
+
+  - id: analysis
+    name: 根因分析
+    description: 分析 Bug 根因
+    requires: [proposal]
+    template: analysis.md
+    instruction: |
+      根因分析（4 阶段）：
+      1. 调查 — 收集日志、堆栈、复现
+      2. 模式分析 — 识别错误模式
+      3. 假设 — 提出根因假设
+      4. 验证 — 验证假设正确性
+    output: analysis.md
+
+  - id: fix-plan
+    name: 修复计划
+    description: 制定修复方案
+    requires: [analysis]
+    template: fix-plan.md
+    instruction: |
+      修复方案：
+      - 修复策略（热修复/正常修复/重构修复）
+      - 修改文件列表
+      - 回归测试计划
+    output: fix-plan.md
+
+  - id: tasks
+    name: 修复任务
+    description: 修复步骤拆分
+    requires: [fix-plan]
+    template: tasks.md
+    instruction: |
+      修复任务拆分：
+      1. 编写失败测试（复现 Bug）
+      2. 修复代码
+      3. 验证测试通过
+      4. 回归测试
+      5. 更新文档
+    output: tasks.md
+
+  - id: regression-test
+    name: 回归测试
+    description: 定义修复后的回归验证用例
+    requires: [tasks]
+    template: regression-test.md
+    instruction: |
+      定义回归测试用例：
+      1. 复现测试 — 验证 Bug 已被修复
+      2. 边界测试 — 验证相关边界条件
+      3. 影响范围测试 — 验证修改未引入新问题
+      4. 性能回归 — 确认无性能退化
+    output: regression-test.md

package/builtin/schemas/bug-fix/templates/analysis.md

@@ -0,0 +1,43 @@
+# 根因分析
+
+## 1. 调查
+
+### 错误日志
+```
+（关键错误日志）
+```
+
+### 堆栈跟踪
+```
+（关键堆栈）
+```
+
+### 复现结果
+- 是否可稳定复现: 是/否
+- 复现频率: 
+
+## 2. 模式分析
+
+### 错误模式
+- 错误类型: 
+- 涉及模块: 
+- 最近变更: 
+
+## 3. 假设
+
+### 假设 1: [描述]
+- 证据: 
+- 验证方法: 
+
+### 假设 2: [描述]
+- 证据: 
+- 验证方法: 
+
+## 4. 结论
+
+### 根因
+[确认的根因描述]
+
+### 影响分析
+- 直接影响: 
+- 间接影响: 

package/builtin/schemas/bug-fix/templates/fix-plan.md

@@ -0,0 +1,19 @@
+# 修复方案
+
+## 修复策略
+- [ ] 热修复（紧急上线）
+- [ ] 正常修复（下个版本）
+- [ ] 重构修复（技术债务）
+
+## 修改文件
+| 文件 | 修改类型 | 说明 |
+|------|----------|------|
+| | | |
+
+## 修复描述
+
+
+## 回归测试计划
+- [ ] 原 Bug 场景验证
+- [ ] 相关功能回归
+- [ ] 边界条件验证

package/builtin/schemas/bug-fix/templates/proposal.md

@@ -0,0 +1,30 @@
+# Bug 描述
+
+## Bug 标题
+{{bugTitle}}
+
+## 复现步骤
+1. 
+2. 
+3. 
+
+## 预期行为
+
+
+## 实际行为
+
+
+## 环境信息
+- 环境: 
+- 版本: 
+- 浏览器/客户端: 
+
+## 影响范围
+- 影响用户: 
+- 影响功能: 
+- 严重程度: Critical / Major / Minor
+
+## 相关日志
+```
+（粘贴错误日志）
+```

package/builtin/schemas/bug-fix/templates/regression-test.md

@@ -0,0 +1,70 @@
+# 回归测试: {{bugTitle}}
+
+## Bug 信息
+
+- **Bug 标题**: {{bugTitle}}
+- **修复分支**: feature/{{branch}}
+- **修复日期**: {{timestamp}}
+
+---
+
+## 1. 复现验证
+
+验证 Bug 已被修复。
+
+| 步骤 | 操作 | 修复前结果 | 修复后预期 | 实际结果 | 通过 |
+|------|------|-----------|-----------|---------|------|
+| 1 | | | | | ☐ |
+| 2 | | | | | ☐ |
+| 3 | | | | | ☐ |
+
+---
+
+## 2. 边界测试
+
+验证相关边界条件。
+
+| 场景 | 输入/条件 | 预期结果 | 实际结果 | 通过 |
+|------|----------|---------|---------|------|
+| 空值输入 | | | | ☐ |
+| 最大值 | | | | ☐ |
+| 并发场景 | | | | ☐ |
+| 异常数据 | | | | ☐ |
+
+---
+
+## 3. 影响范围验证
+
+验证修改未引入新问题。
+
+### 修改的文件
+| 文件 | 修改类型 | 关联功能 | 验证状态 |
+|------|---------|---------|---------|
+| | | | ☐ 通过 / ☐ 失败 |
+
+### 关联功能检查
+| 功能模块 | 测试场景 | 验证状态 |
+|---------|---------|---------|
+| | | ☐ 通过 / ☐ 失败 |
+
+---
+
+## 4. 性能回归
+
+| 指标 | 修复前 | 修复后 | 是否退化 |
+|------|-------|-------|---------|
+| 响应时间 | | | ☐ 无退化 |
+| 内存占用 | | | ☐ 无退化 |
+| 数据库查询 | | | ☐ 无退化 |
+
+---
+
+## 5. 回归确认
+
+- [ ] 所有复现验证通过
+- [ ] 所有边界测试通过
+- [ ] 影响范围验证通过
+- [ ] 性能无退化
+- [ ] 已更新相关文档
+
+**验证人**: _______________  **日期**: _______________

package/builtin/schemas/crud-module/schema.yaml

@@ -0,0 +1,90 @@
+# CRUD 模块 Schema
+# 用于快速生成标准 CRUD 模块的工件流
+
+name: crud-module
+description: 快速生成标准 CRUD 模块（Entity/Mapper/Service/Controller/页面）
+
+apply:
+  requires:
+    - tasks
+
+artifacts:
+  - id: proposal
+    name: 模块提案
+    description: 描述要生成的 CRUD 模块
+    requires: []
+    template: proposal.md
+    instruction: |
+      根据用户描述，生成 CRUD 模块提案。
+      包含：模块名称、核心实体、CRUD 操作列表、业务规则。
+    output: proposal.md
+
+  - id: specs
+    name: 模块规范
+    description: 定义 CRUD 接口规范
+    requires: [proposal]
+    template: spec.md
+    instruction: |
+      定义 CRUD 接口规范：
+      - GET /api/{entity} — 分页查询
+      - GET /api/{entity}/:id — 详情查询
+      - POST /api/{entity} — 新增
+      - PUT /api/{entity}/:id — 修改
+      - DELETE /api/{entity}/:id — 删除
+      每个接口定义请求参数和响应格式。
+    output: specs/{{entity}}/spec.md
+
+  - id: design
+    name: 模块设计
+    description: 数据库设计和接口定义
+    requires: [proposal, specs]
+    template: design.md
+    instruction: |
+      设计数据库表结构和接口定义：
+      - 表结构（字段、类型、索引）
+      - 接口签名
+      - 前后端分工
+    output: design.md
+
+  - id: tasks
+    name: 任务列表
+    description: 代码生成任务拆分
+    requires: [design]
+    template: tasks.md
+    instruction: |
+      按以下顺序拆分任务：
+      1. Entity 实体类
+      2. Mapper + XML
+      3. Service 接口 + 实现
+      4. Controller
+      5. 前端 API 接口
+      6. 前端列表页
+      7. 前端表单页
+      8. 菜单注册
+      9. 单元测试
+    output: tasks.md
+
+  - id: api-docs
+    name: API 接口文档
+    description: 标准 API 接口文档
+    requires: [design]
+    template: api-docs.md
+    instruction: |
+      生成标准 API 接口文档：
+      - 接口概览表
+      - 每个接口的请求参数和响应示例（JSON 格式）
+      - 通用错误码说明
+    output: api-docs.md
+
+  - id: menu-register
+    name: 菜单注册
+    description: 菜单注册配置
+    requires: [tasks]
+    template: menu-register.md
+    instruction: |
+      生成菜单注册配置：
+      - 菜单名称、父级菜单、排序、图标
+      - 路由配置（path、component、meta）
+      - 权限标识（按钮级权限）
+      - SQL 插入语句
+    output: menu-register.md

package/builtin/schemas/crud-module/templates/api-docs.md

@@ -0,0 +1,146 @@
+# API 接口文档: {{moduleName}}
+
+> 模块: {{module}} | 实体: {{Entity}} | 基础路径: `/api/{{entity}}`
+
+---
+
+## 接口概览
+
+| Method | Path | 描述 | 认证 |
+|--------|------|------|------|
+| GET | `/api/{{entity}}` | 分页查询 | 需要 |
+| GET | `/api/{{entity}}/:id` | 详情查询 | 需要 |
+| POST | `/api/{{entity}}` | 新增 | 需要 |
+| PUT | `/api/{{entity}}/:id` | 修改 | 需要 |
+| DELETE | `/api/{{entity}}/:id` | 删除 | 需要 |
+
+---
+
+## 1. 分页查询
+
+**请求**: `GET /api/{{entity}}`
+
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| page | number | 否 | 页码，默认 1 |
+| size | number | 否 | 每页条数，默认 10 |
+| keyword | string | 否 | 关键词搜索 |
+
+**响应示例**:
+```json
+{
+  "code": 200,
+  "message": "success",
+  "data": {
+    "records": [
+      {
+        "id": 1,
+        "name": "示例数据",
+        "createTime": "2025-01-01 00:00:00"
+      }
+    ],
+    "total": 100,
+    "page": 1,
+    "size": 10
+  }
+}
+```
+
+---
+
+## 2. 详情查询
+
+**请求**: `GET /api/{{entity}}/:id`
+
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | number | 是 | 记录 ID（路径参数） |
+
+**响应示例**:
+```json
+{
+  "code": 200,
+  "message": "success",
+  "data": {
+    "id": 1,
+    "name": "示例数据",
+    "createTime": "2025-01-01 00:00:00",
+    "updateTime": "2025-01-01 00:00:00"
+  }
+}
+```
+
+---
+
+## 3. 新增
+
+**请求**: `POST /api/{{entity}}`
+
+**请求体**:
+```json
+{
+  "name": "新增数据"
+}
+```
+
+**响应示例**:
+```json
+{
+  "code": 200,
+  "message": "success",
+  "data": 1
+}
+```
+
+---
+
+## 4. 修改
+
+**请求**: `PUT /api/{{entity}}/:id`
+
+**请求体**:
+```json
+{
+  "name": "修改后的数据"
+}
+```
+
+**响应示例**:
+```json
+{
+  "code": 200,
+  "message": "success",
+  "data": null
+}
+```
+
+---
+
+## 5. 删除
+
+**请求**: `DELETE /api/{{entity}}/:id`
+
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | number | 是 | 记录 ID（路径参数） |
+
+**响应示例**:
+```json
+{
+  "code": 200,
+  "message": "success",
+  "data": null
+}
+```
+
+---
+
+## 通用错误码
+
+| 错误码 | 说明 | 示例 |
+|--------|------|------|
+| 400 | 请求参数错误 | `{"code": 400, "message": "参数校验失败"}` |
+| 401 | 未认证 | `{"code": 401, "message": "请先登录"}` |
+| 403 | 无权限 | `{"code": 403, "message": "权限不足"}` |
+| 404 | 资源不存在 | `{"code": 404, "message": "记录不存在"}` |
+| 500 | 服务器内部错误 | `{"code": 500, "message": "系统异常"}` |

package/builtin/schemas/crud-module/templates/design.md

@@ -0,0 +1,36 @@
+# CRUD 模块设计
+
+## 1. 数据库设计
+
+### 表结构
+```sql
+CREATE TABLE `{{table_name}}` (
+  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键ID',
+  -- 业务字段（根据提案填充）
+  `create_by` varchar(64) DEFAULT '' COMMENT '创建人',
+  `create_time` datetime DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
+  `update_by` varchar(64) DEFAULT '' COMMENT '更新人',
+  `update_time` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
+  `is_deleted` tinyint(1) DEFAULT 0 COMMENT '逻辑删除',
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='{{table_comment}}';
+```
+
+## 2. 接口定义
+
+| Method | Path | 描述 | 请求参数 | 响应 |
+|--------|------|------|----------|------|
+| GET | /api/{{entity}} | 分页查询 | page, size, 查询条件 | PageResult |
+| GET | /api/{{entity}}/:id | 详情 | - | EntityVO |
+| POST | /api/{{entity}} | 新增 | EntityDTO | id |
+| PUT | /api/{{entity}}/:id | 修改 | EntityDTO | - |
+| DELETE | /api/{{entity}}/:id | 删除 | - | - |
+
+## 3. 前后端分工
+
+| 功能 | 前端 | 后端 |
+|------|------|------|
+| 列表页 | 表格+搜索+分页 | 分页查询接口 |
+| 新增 | 表单弹窗 | 新增接口 |
+| 编辑 | 表单弹窗 | 修改接口 |
+| 删除 | 确认弹窗 | 删除接口 |

package/builtin/schemas/crud-module/templates/menu-register.md

@@ -0,0 +1,72 @@
+# 菜单注册: {{moduleName}}
+
+> 模块: {{module}} | 实体: {{Entity}} | 基础路径: `/{{module}}/{{entity}}`
+
+---
+
+## 1. 菜单配置
+
+| 配置项 | 值 | 说明 |
+|--------|-----|------|
+| 菜单名称 | {{moduleName}} | 显示在侧边栏的名称 |
+| 父级菜单 | 根目录 / 按实际选择 | 菜单层级 |
+| 排序 | 100 | 同级菜单排序，数字越小越靠前 |
+| 图标 | el-icon-document | Element UI 图标名称 |
+| 路由路径 | /{{module}}/{{entity}} | 前端路由 |
+| 组件路径 | {{module}}/{{entity}}/index | Vue 组件路径 |
+
+---
+
+## 2. 路由配置
+
+```javascript
+// src/router/modules/{{module}}.js
+export default {
+  path: '/{{module}}',
+  component: Layout,
+  children: [
+    {
+      path: '{{entity}}',
+      name: '{{Entity}}',
+      component: () => import('@/views/{{module}}/{{entity}}/index.vue'),
+      meta: {
+        title: '{{moduleName}}',
+        icon: 'document',
+        keepAlive: true,
+      },
+    },
+  ],
+};
+```
+
+---
+
+## 3. 权限标识
+
+| 权限标识 | 描述 | 对应操作 |
+|---------|------|---------|
+| `{{module}}:{{entity}}:view` | 查看 | 列表页 + 详情 |
+| `{{module}}:{{entity}}:add` | 新增 | 新增按钮 |
+| `{{module}}:{{entity}}:edit` | 修改 | 编辑按钮 |
+| `{{module}}:{{entity}}:delete` | 删除 | 删除按钮 |
+
+---
+
+## 4. SQL 插入语句
+
+```sql
+-- 菜单数据
+INSERT INTO sys_menu (menu_name, parent_id, order_num, path, component, menu_type, visible, status, perms, icon, create_by, create_time, remark)
+VALUES ('{{moduleName}}', 0, 100, '/{{module}}/{{entity}}', '{{module}}/{{entity}}/index', 'C', '0', '0', '{{module}}:{{entity}}:view', 'document', 'admin', NOW(), '{{moduleName}}菜单');
+
+-- 按钮权限
+INSERT INTO sys_menu (menu_name, parent_id, order_num, path, component, menu_type, visible, status, perms, icon, create_by, create_time, remark)
+VALUES
+-- 查看（@parentId 替换为上面插入的菜单 ID）
+('{{moduleName}}查询', @parentId, 1, '#', '', 'F', '0', '0', '{{module}}:{{entity}}:view', '#', 'admin', NOW(), ''),
+('{{moduleName}}新增', @parentId, 2, '#', '', 'F', '0', '0', '{{module}}:{{entity}}:add', '#', 'admin', NOW(), ''),
+('{{moduleName}}修改', @parentId, 3, '#', '', 'F', '0', '0', '{{module}}:{{entity}}:edit', '#', 'admin', NOW(), ''),
+('{{moduleName}}删除', @parentId, 4, '#', '', 'F', '0', '0', '{{module}}:{{entity}}:delete', '#', 'admin', NOW(), '');
+```
+
+> **注意**: 执行 SQL 前请先确认 `parent_id` 的值（根据实际父级菜单调整）。

package/builtin/schemas/crud-module/templates/proposal.md

@@ -0,0 +1,30 @@
+# CRUD 模块提案
+
+## 模块名称
+{{moduleName}}
+
+## 核心实体
+- 实体名: 
+- 表名: 
+- 描述: 
+
+## CRUD 操作
+- [ ] 分页查询（列表）
+- [ ] 详情查询
+- [ ] 新增
+- [ ] 修改
+- [ ] 删除
+- [ ] 导出（可选）
+- [ ] 导入（可选）
+
+## 业务规则
+1. 
+2. 
+
+## 字段清单
+| 字段名 | 类型 | 必填 | 说明 |
+|--------|------|------|------|
+| | | | |
+
+## 非目标
+- 不包含: 

package/builtin/schemas/crud-module/templates/spec.md

@@ -0,0 +1,33 @@
+# CRUD 接口规范
+
+## ADDED Requirements
+
+### API-001: 分页查询
+系统应当提供 `GET /api/{{entity}}` 接口，支持分页查询。
+
+**验收标准:**
+- **Given** 数据库中存在 {{entity}} 记录
+- **When** 用户请求 `GET /api/{{entity}}?page=1&size=10`
+- **Then** 返回分页数据，包含 total、list、page、size
+
+### API-002: 详情查询
+系统应当提供 `GET /api/{{entity}}/:id` 接口。
+
+**验收标准:**
+- **Given** 存在 ID 为 1 的记录
+- **When** 用户请求 `GET /api/{{entity}}/1`
+- **Then** 返回该记录详情
+
+### API-003: 新增
+系统应当提供 `POST /api/{{entity}}` 接口。
+
+**验收标准:**
+- **Given** 用户提供必填字段
+- **When** 用户请求 `POST /api/{{entity}}`
+- **Then** 创建记录并返回新 ID
+
+### API-004: 修改
+系统应当提供 `PUT /api/{{entity}}/:id` 接口。
+
+### API-005: 删除
+系统应当提供 `DELETE /api/{{entity}}/:id` 接口（逻辑删除）。