@robsun/create-keystone-app 0.2.6 → 0.2.7

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 (13) hide show
  1. package/dist/create-keystone-app.js +0 -0
  2. package/dist/create-module.js +0 -0
  3. package/package.json +6 -7
  4. package/template/.claude/skills/keystone-dev/SKILL.md +12 -9
  5. package/template/.claude/skills/keystone-dev/references/APPROVAL.md +74 -0
  6. package/template/.claude/skills/keystone-dev/{CAPABILITIES.md → references/CAPABILITIES.md} +1 -0
  7. package/template/.claude/skills/keystone-dev/{TEMPLATES.md → references/TEMPLATES.md} +1 -0
  8. package/template/.claude/skills/keystone-dev/references/TESTING.md +44 -0
  9. package/template/.codex/skills/keystone-dev/SKILL.md +12 -9
  10. package/template/.codex/skills/keystone-dev/references/APPROVAL.md +74 -0
  11. package/template/.codex/skills/keystone-dev/{CAPABILITIES.md → references/CAPABILITIES.md} +1 -0
  12. package/template/.codex/skills/keystone-dev/{TEMPLATES.md → references/TEMPLATES.md} +1 -0
  13. package/template/.codex/skills/keystone-dev/references/TESTING.md +44 -0
package/dist/create-keystone-app.js CHANGED
File without changes
package/dist/create-module.js CHANGED
File without changes
package/package.json CHANGED
@@ -1,10 +1,6 @@
1
- {
1
+ {
2
2
  "name": "@robsun/create-keystone-app",
3
- "version": "0.2.6",
4
- "scripts": {
5
- "build": "node scripts/build.js",
6
- "prepublishOnly": "node scripts/build.js && node scripts/prune-template-deps.js"
7
- },
3
+ "version": "0.2.7",
8
4
  "publishConfig": {
9
5
  "access": "public"
10
6
  },
@@ -19,5 +15,8 @@
19
15
  ],
20
16
  "engines": {
21
17
  "node": ">=18"
18
+ },
19
+ "scripts": {
20
+ "build": "node scripts/build.js"
22
21
  }
23
- }
22
+ }
package/template/.claude/skills/keystone-dev/SKILL.md CHANGED
@@ -10,10 +10,11 @@ description: 基于 Keystone 平台开发业务模块。当用户需要创建新
10
10
  ## 工作流程
11
11
 
12
12
  1. **解析需求** → 识别所需能力
13
- 2. **生成前端模块** → routes.tsx, pages/, services/, types.ts
14
- 3. **生成后端模块** → handler/, service/, repository/, migrations/
15
- 4. **自动注册** → main.tsx + manifest.go + config.yaml
16
- 5. **输出调整建议**
13
+ 2. **生成前端模块** → routes.tsx, pages/, services/, types.ts
14
+ 3. **生成后端模块** → handler/, service/, repository/, migrations/
15
+ 4. **自动注册** → main.tsx + manifest.go + config.yaml
16
+ 5. **输出调整建议**
17
+ 6. **补测试并执行** → 见 references/testing.md
17
18
 
18
19
  ## 能力选择矩阵
19
20
 
@@ -26,11 +27,13 @@ description: 基于 Keystone 平台开发业务模块。当用户需要创建新
26
27
  | 导入、批量 | DataImporter | ImportHandler + Job队列 |
27
28
  | 导出、下载 | DataExporter | ExportHandler + Job队列 |
28
29
  | 上传、附件 | FileUpload | UploadHandler + 存储服务 |
29
- | 审批、流程 | ApprovalFlowEditor | 审批引擎 |
30
- | 权限 | PermissionGuard | 权限中间件 |
31
-
32
- 详细能力清单见 [CAPABILITIES.md](CAPABILITIES.md)。
33
- 代码模板见 [TEMPLATES.md](TEMPLATES.md)。
30
+ | 审批、流程 | ApprovalFlowEditor | 审批引擎 |
31
+ | 权限 | PermissionGuard | 权限中间件 |
32
+
33
+ 审批流程与接入说明见 [references/approval.md](references/approval.md)。
34
+ 测试清单见 [references/testing.md](references/testing.md)。
35
+ 详细能力清单见 [references/CAPABILITIES.md](references/CAPABILITIES.md)。
36
+ 代码模板见 [references/TEMPLATES.md](references/TEMPLATES.md)。
34
37
 
35
38
  ## 模块结构约定
36
39
 
package/template/.claude/skills/keystone-dev/references/APPROVAL.md ADDED
@@ -0,0 +1,74 @@
1
+ # Keystone 审批接入流程
2
+
3
+ ## 目标
4
+ 本文只描述审批接入所需的表单 schema 与 context 映射等开发工作，
5
+ 流程节点与审批路径由人工在审批配置页面完成。
6
+
7
+ ## 适用场景
8
+ - 新业务需要审批门禁（新业务类型）。
9
+ - 既有业务接入审批门禁（在业务表单提交或关键业务动作前加审批）。
10
+
11
+ ## 不在范围
12
+ - 配置审批流程与节点（由人工在流程配置页面完成）。
13
+ - 修改 approval 基础模块或审批页面本身。
14
+ - 改造审批权限体系或审批路由结构。
15
+
16
+ ## 开发路径选择
17
+ - Greenfield：新业务从零引入审批。
18
+ - Retrofit：已有业务接入审批。
19
+
20
+ ## 开发步骤 A：新业务（Greenfield）
21
+ 1) 前端配置 `approval.businessTypes` 标签映射（用于流程配置时选择表单），
22
+ 流程配置页面的业务类型选择会作为 schema code 加载表单字段，需保持一致。
23
+ 2) 注册表单 schema（条件节点字段来源）。
24
+ 3) 在业务提交处创建审批实例，写入 context JSON 用于条件路由。
25
+ 4) 绑定 OnApproved/OnRejected 回调更新业务状态。
26
+ 5) 按测试清单执行（见 testing.md）。
27
+
28
+ ## 开发步骤 B：已有业务接入（Retrofit）
29
+ 1) 确认触发点与审批边界（业务表单提交或关键业务动作前）。
30
+ 2) 将现有字段映射为 context JSON（供条件节点判断）。
31
+ 3) 做幂等：按业务类型 + 业务 ID 查已有实例再创建。
32
+ 4) pending 期间阻断业务动作（状态拦截或硬拦截）。
33
+ 5) 决定是否回填存量数据（跳过或补建实例）。
34
+
35
+ ## 业务侧改动清单
36
+
37
+ 后端（业务模块内）
38
+ - 在业务 service/handler 中调用审批服务创建实例（必要时通过 FlowMatcher 选 flow）。
39
+ - 在业务模块注册审批回调，审批通过/驳回时更新业务状态。
40
+ - 需要数据范围过滤时，实现 ApprovalContextResolver 并在应用装配时注入。
41
+ - 如需默认 flow 或 schema，放在业务模块的迁移/seed 中，不改动审批模块。
42
+
43
+ 前端（业务模块内）
44
+ - 配置 `approval.businessTypes` 标签映射，保证业务类型显示正确。
45
+ - 流程配置使用已有审批管理页面，不做二次开发。
46
+
47
+ ## 权限说明
48
+ 使用系统既有审批权限码：
49
+ approval:flow:view|create|edit|delete
50
+ approval:instance:view|approve|cancel
51
+ approval:record:view|export
52
+
53
+ ## 集成自检
54
+ - Flow code <= 50 且使用大写；business type 用短字符串。
55
+ - approve/reject/cancel 使用 version 做乐观锁。
56
+ - 变更接口时更新 OpenAPI 合同。
57
+ - 新增默认流程时补迁移或 seed。
58
+
59
+ 测试清单见 [testing.md](testing.md)。
60
+
61
+ ## 参考入口
62
+
63
+ 后端
64
+ - domain/approval/service/service.go
65
+ - domain/approval/service/flow_matcher.go
66
+ - domain/approval/service/callback_registry.go
67
+ - api/routes/approval_routes.go
68
+ - contracts/011-approvals/approvals-api.yaml
69
+
70
+ 前端
71
+ - packages/keystone-web-core/src/platform/config/appConfig.ts
72
+ - packages/keystone-web-core/src/platform/core/approval/services/approvalService.ts
73
+ - packages/keystone-web-core/src/platform/core/approval/stores/approvalStore.ts
74
+ - packages/keystone-web-core/src/modules/keystone/approval/pages/*
package/template/.claude/skills/keystone-dev/{CAPABILITIES.md → references/CAPABILITIES.md} RENAMED
@@ -41,6 +41,7 @@ import {
41
41
  ApprovalHistory // 审批历史
42
42
  } from '@robsun/keystone-web-core'
43
43
  ```
44
+ 审批流程与接入说明见 [approval.md](approval.md)。
44
45
 
45
46
  ### 4. 帮助系统
46
47
  ```typescript
package/template/.claude/skills/keystone-dev/{TEMPLATES.md → references/TEMPLATES.md} RENAMED
@@ -5,6 +5,7 @@
5
5
  ### Ant Design v6 注意事项
6
6
  - `Space` 使用 `orientation`，不要用 `direction`。
7
7
  - `Modal` 使用 `destroyOnHidden`，不要用 `destroyOnClose`。
8
+ - `Drawer` 使用 `size`，不要用 `width`。
8
9
 
9
10
  ### routes.tsx
10
11
  ```tsx
package/template/.claude/skills/keystone-dev/references/TESTING.md ADDED
@@ -0,0 +1,44 @@
1
+ # Keystone 开发测试清单
2
+
3
+ ## 快速入口
4
+ - 仓库根目录：`pnpm test`（模板测试 + `go test ./...`）
5
+ - 仅 Go：`go test ./...`
6
+ - 模板项目：`pnpm -C packages/create-keystone-app/template test`
7
+
8
+ ## 按改动范围选择
9
+ 后端（api/domain/infra/bootstrap/server）
10
+ - `go test ./...`
11
+ - 若改动较大可补 `go vet ./...`
12
+
13
+ 模板前端（packages/create-keystone-app/template/apps/web）
14
+ - `pnpm -C packages/create-keystone-app/template/apps/web typecheck`
15
+ - `pnpm -C packages/create-keystone-app/template/apps/web lint`
16
+ - `pnpm -C packages/create-keystone-app/template/apps/web test`
17
+
18
+ 前端核心包（packages/keystone-web-core）
19
+ - `pnpm -C packages/keystone-web-core build`
20
+
21
+ 脚手架/模板变更
22
+ - `pnpm scaffold:verify`
23
+
24
+ 合同变更
25
+ - `pnpm contracts:check`
26
+ - 如更新了合同内容，执行 `pnpm contracts:sync`
27
+
28
+ ## 写测试（必做）
29
+ 后端
30
+ - 领域/服务逻辑新增或改动：在 `tests/unit/platform/service` 或对应 domain 下补单测。
31
+ - Repository 变更：在 `tests/unit/platform/repository` 补单测。
32
+ - 新增/调整 API：在 `tests/integration/platform/api` 补集成测试。
33
+ - 参考用例：`tests/unit/platform/approval/service_test.go`、`tests/integration/platform/api/approval_schema_test.go`。
34
+
35
+ 前端（模板 web）
36
+ - 新增页面/交互：在 `packages/create-keystone-app/template/apps/web/tests` 新增 `*.test.tsx`。
37
+ - 使用 vitest + Testing Library（已在 `vite.config.ts` 配好 test 配置）。
38
+
39
+ 前端核心包（keystone-web-core）
40
+ - 新增核心组件/逻辑：优先在模板 web 侧写集成测试覆盖。
41
+ - 如必须在包内写单测，需要补齐包内测试配置后再添加用例。
42
+
43
+ ## 最小通过标准
44
+ - 单点改动跑对应子项；跨域改动直接跑 `pnpm test`。
package/template/.codex/skills/keystone-dev/SKILL.md CHANGED
@@ -10,10 +10,11 @@ description: 基于 Keystone 平台开发业务模块。当用户需要创建新
10
10
  ## 工作流程
11
11
 
12
12
  1. **解析需求** → 识别所需能力
13
- 2. **生成前端模块** → routes.tsx, pages/, services/, types.ts
14
- 3. **生成后端模块** → handler/, service/, repository/, migrations/
15
- 4. **自动注册** → main.tsx + manifest.go + config.yaml
16
- 5. **输出调整建议**
13
+ 2. **生成前端模块** → routes.tsx, pages/, services/, types.ts
14
+ 3. **生成后端模块** → handler/, service/, repository/, migrations/
15
+ 4. **自动注册** → main.tsx + manifest.go + config.yaml
16
+ 5. **输出调整建议**
17
+ 6. **补测试并执行** → 见 references/testing.md
17
18
 
18
19
  ## 能力选择矩阵
19
20
 
@@ -26,11 +27,13 @@ description: 基于 Keystone 平台开发业务模块。当用户需要创建新
26
27
  | 导入、批量 | DataImporter | ImportHandler + Job队列 |
27
28
  | 导出、下载 | DataExporter | ExportHandler + Job队列 |
28
29
  | 上传、附件 | FileUpload | UploadHandler + 存储服务 |
29
- | 审批、流程 | ApprovalFlowEditor | 审批引擎 |
30
- | 权限 | PermissionGuard | 权限中间件 |
31
-
32
- 详细能力清单见 [CAPABILITIES.md](CAPABILITIES.md)。
33
- 代码模板见 [TEMPLATES.md](TEMPLATES.md)。
30
+ | 审批、流程 | ApprovalFlowEditor | 审批引擎 |
31
+ | 权限 | PermissionGuard | 权限中间件 |
32
+
33
+ 审批流程与接入说明见 [references/approval.md](references/approval.md)。
34
+ 测试清单见 [references/testing.md](references/testing.md)。
35
+ 详细能力清单见 [references/CAPABILITIES.md](references/CAPABILITIES.md)。
36
+ 代码模板见 [references/TEMPLATES.md](references/TEMPLATES.md)。
34
37
 
35
38
  ## 模块结构约定
36
39
 
package/template/.codex/skills/keystone-dev/references/APPROVAL.md ADDED
@@ -0,0 +1,74 @@
1
+ # Keystone 审批接入流程
2
+
3
+ ## 目标
4
+ 本文只描述审批接入所需的表单 schema 与 context 映射等开发工作，
5
+ 流程节点与审批路径由人工在审批配置页面完成。
6
+
7
+ ## 适用场景
8
+ - 新业务需要审批门禁（新业务类型）。
9
+ - 既有业务接入审批门禁（在业务表单提交或关键业务动作前加审批）。
10
+
11
+ ## 不在范围
12
+ - 配置审批流程与节点（由人工在流程配置页面完成）。
13
+ - 修改 approval 基础模块或审批页面本身。
14
+ - 改造审批权限体系或审批路由结构。
15
+
16
+ ## 开发路径选择
17
+ - Greenfield：新业务从零引入审批。
18
+ - Retrofit：已有业务接入审批。
19
+
20
+ ## 开发步骤 A：新业务（Greenfield）
21
+ 1) 前端配置 `approval.businessTypes` 标签映射（用于流程配置时选择表单），
22
+ 流程配置页面的业务类型选择会作为 schema code 加载表单字段，需保持一致。
23
+ 2) 注册表单 schema（条件节点字段来源）。
24
+ 3) 在业务提交处创建审批实例，写入 context JSON 用于条件路由。
25
+ 4) 绑定 OnApproved/OnRejected 回调更新业务状态。
26
+ 5) 按测试清单执行（见 testing.md）。
27
+
28
+ ## 开发步骤 B：已有业务接入（Retrofit）
29
+ 1) 确认触发点与审批边界（业务表单提交或关键业务动作前）。
30
+ 2) 将现有字段映射为 context JSON（供条件节点判断）。
31
+ 3) 做幂等：按业务类型 + 业务 ID 查已有实例再创建。
32
+ 4) pending 期间阻断业务动作（状态拦截或硬拦截）。
33
+ 5) 决定是否回填存量数据（跳过或补建实例）。
34
+
35
+ ## 业务侧改动清单
36
+
37
+ 后端（业务模块内）
38
+ - 在业务 service/handler 中调用审批服务创建实例（必要时通过 FlowMatcher 选 flow）。
39
+ - 在业务模块注册审批回调，审批通过/驳回时更新业务状态。
40
+ - 需要数据范围过滤时，实现 ApprovalContextResolver 并在应用装配时注入。
41
+ - 如需默认 flow 或 schema，放在业务模块的迁移/seed 中，不改动审批模块。
42
+
43
+ 前端（业务模块内）
44
+ - 配置 `approval.businessTypes` 标签映射，保证业务类型显示正确。
45
+ - 流程配置使用已有审批管理页面，不做二次开发。
46
+
47
+ ## 权限说明
48
+ 使用系统既有审批权限码：
49
+ approval:flow:view|create|edit|delete
50
+ approval:instance:view|approve|cancel
51
+ approval:record:view|export
52
+
53
+ ## 集成自检
54
+ - Flow code <= 50 且使用大写；business type 用短字符串。
55
+ - approve/reject/cancel 使用 version 做乐观锁。
56
+ - 变更接口时更新 OpenAPI 合同。
57
+ - 新增默认流程时补迁移或 seed。
58
+
59
+ 测试清单见 [testing.md](testing.md)。
60
+
61
+ ## 参考入口
62
+
63
+ 后端
64
+ - domain/approval/service/service.go
65
+ - domain/approval/service/flow_matcher.go
66
+ - domain/approval/service/callback_registry.go
67
+ - api/routes/approval_routes.go
68
+ - contracts/011-approvals/approvals-api.yaml
69
+
70
+ 前端
71
+ - packages/keystone-web-core/src/platform/config/appConfig.ts
72
+ - packages/keystone-web-core/src/platform/core/approval/services/approvalService.ts
73
+ - packages/keystone-web-core/src/platform/core/approval/stores/approvalStore.ts
74
+ - packages/keystone-web-core/src/modules/keystone/approval/pages/*
package/template/.codex/skills/keystone-dev/{CAPABILITIES.md → references/CAPABILITIES.md} RENAMED
@@ -41,6 +41,7 @@ import {
41
41
  ApprovalHistory // 审批历史
42
42
  } from '@robsun/keystone-web-core'
43
43
  ```
44
+ 审批流程与接入说明见 [approval.md](approval.md)。
44
45
 
45
46
  ### 4. 帮助系统
46
47
  ```typescript
package/template/.codex/skills/keystone-dev/{TEMPLATES.md → references/TEMPLATES.md} RENAMED
@@ -5,6 +5,7 @@
5
5
  ### Ant Design v6 注意事项
6
6
  - `Space` 使用 `orientation`，不要用 `direction`。
7
7
  - `Modal` 使用 `destroyOnHidden`，不要用 `destroyOnClose`。
8
+ - `Drawer` 使用 `size`，不要用 `width`。
8
9
 
9
10
  ### routes.tsx
10
11
  ```tsx
package/template/.codex/skills/keystone-dev/references/TESTING.md ADDED
@@ -0,0 +1,44 @@
1
+ # Keystone 开发测试清单
2
+
3
+ ## 快速入口
4
+ - 仓库根目录：`pnpm test`（模板测试 + `go test ./...`）
5
+ - 仅 Go：`go test ./...`
6
+ - 模板项目：`pnpm -C packages/create-keystone-app/template test`
7
+
8
+ ## 按改动范围选择
9
+ 后端（api/domain/infra/bootstrap/server）
10
+ - `go test ./...`
11
+ - 若改动较大可补 `go vet ./...`
12
+
13
+ 模板前端（packages/create-keystone-app/template/apps/web）
14
+ - `pnpm -C packages/create-keystone-app/template/apps/web typecheck`
15
+ - `pnpm -C packages/create-keystone-app/template/apps/web lint`
16
+ - `pnpm -C packages/create-keystone-app/template/apps/web test`
17
+
18
+ 前端核心包（packages/keystone-web-core）
19
+ - `pnpm -C packages/keystone-web-core build`
20
+
21
+ 脚手架/模板变更
22
+ - `pnpm scaffold:verify`
23
+
24
+ 合同变更
25
+ - `pnpm contracts:check`
26
+ - 如更新了合同内容，执行 `pnpm contracts:sync`
27
+
28
+ ## 写测试（必做）
29
+ 后端
30
+ - 领域/服务逻辑新增或改动：在 `tests/unit/platform/service` 或对应 domain 下补单测。
31
+ - Repository 变更：在 `tests/unit/platform/repository` 补单测。
32
+ - 新增/调整 API：在 `tests/integration/platform/api` 补集成测试。
33
+ - 参考用例：`tests/unit/platform/approval/service_test.go`、`tests/integration/platform/api/approval_schema_test.go`。
34
+
35
+ 前端（模板 web）
36
+ - 新增页面/交互：在 `packages/create-keystone-app/template/apps/web/tests` 新增 `*.test.tsx`。
37
+ - 使用 vitest + Testing Library（已在 `vite.config.ts` 配好 test 配置）。
38
+
39
+ 前端核心包（keystone-web-core）
40
+ - 新增核心组件/逻辑：优先在模板 web 侧写集成测试覆盖。
41
+ - 如必须在包内写单测，需要补齐包内测试配置后再添加用例。
42
+
43
+ ## 最小通过标准
44
+ - 单点改动跑对应子项；跨域改动直接跑 `pnpm test`。