@robsun/create-keystone-app 0.2.5 → 0.2.6
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/package.json
CHANGED
|
@@ -1,75 +1,75 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: keystone-dev
|
|
3
|
-
description: 基于 Keystone 平台开发业务模块。当用户需要创建新模块、添加业务功能、实现 CRUD、审批流程、数据导入导出、文件上传时使用。Use when creating modules, adding features, implementing CRUD, approval workflows, import/export, or file upload for Keystone platform.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Keystone 业务模块开发
|
|
7
|
-
|
|
8
|
-
使用 Keystone 平台快速开发业务模块。
|
|
9
|
-
|
|
10
|
-
## 工作流程
|
|
11
|
-
|
|
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. **输出调整建议**
|
|
17
|
-
|
|
18
|
-
## 能力选择矩阵
|
|
19
|
-
|
|
20
|
-
根据需求关键词选用对应能力：
|
|
21
|
-
|
|
22
|
-
| 需求关键词 | 前端能力 | 后端能力 |
|
|
23
|
-
|-----------|---------|---------|
|
|
24
|
-
| 列表、查询 | ProTable + 过滤 + 分页 | ListHandler + Repository |
|
|
25
|
-
| 表单、编辑 | ProForm + 验证 | CreateHandler + UpdateHandler |
|
|
26
|
-
| 导入、批量 | DataImporter | ImportHandler + Job队列 |
|
|
27
|
-
| 导出、下载 | DataExporter | ExportHandler + Job队列 |
|
|
28
|
-
| 上传、附件 | FileUpload | UploadHandler + 存储服务 |
|
|
29
|
-
| 审批、流程 | ApprovalFlowEditor | 审批引擎 |
|
|
30
|
-
| 权限 | PermissionGuard | 权限中间件 |
|
|
31
|
-
|
|
32
|
-
详细能力清单见 [CAPABILITIES.md](CAPABILITIES.md)。
|
|
33
|
-
代码模板见 [TEMPLATES.md](TEMPLATES.md)。
|
|
34
|
-
|
|
35
|
-
## 模块结构约定
|
|
36
|
-
|
|
37
|
-
### 前端模块
|
|
38
|
-
```
|
|
39
|
-
apps/web/src/modules/{name}/
|
|
40
|
-
├── index.ts # registerModule()
|
|
41
|
-
├── routes.tsx # 路由 + 菜单 + 权限
|
|
42
|
-
├── pages/
|
|
43
|
-
│ ├── List.tsx # ProTable
|
|
44
|
-
│ ├── Detail.tsx
|
|
45
|
-
│ └── Form.tsx # ProForm
|
|
46
|
-
├── services/api.ts
|
|
47
|
-
├── types.ts
|
|
48
|
-
└── help/index.md
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
### 后端模块
|
|
52
|
-
```
|
|
53
|
-
apps/server/internal/modules/{name}/
|
|
54
|
-
├── module.go
|
|
55
|
-
├── api/handler/
|
|
56
|
-
├── domain/models/
|
|
57
|
-
├── domain/service/
|
|
58
|
-
├── infra/repository/
|
|
59
|
-
└── bootstrap/migrations/
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
## 权限命名
|
|
63
|
-
|
|
64
|
-
格式: `{module}:{resource}:{action}`
|
|
65
|
-
|
|
66
|
-
动作: view | create | update | delete | manage | export | import | approve
|
|
67
|
-
|
|
68
|
-
## 注册步骤
|
|
69
|
-
|
|
70
|
-
生成代码后需完成以下注册（**缺一不可**）：
|
|
71
|
-
|
|
72
|
-
1. **前端导入** `main.tsx`: `import './modules/{name}'`
|
|
73
|
-
2. **前端启用** `app.config.ts`: 添加到 `modules.enabled` 数组 ⚠️ **必须，否则菜单不显示**
|
|
74
|
-
3. **后端注册** `manifest.go`: `import {name}module "app/internal/modules/{name}"` + `Register({name}module.NewModule())`
|
|
75
|
-
4. **后端启用** `config.yaml`: 添加到 `modules.enabled`
|
|
1
|
+
---
|
|
2
|
+
name: keystone-dev
|
|
3
|
+
description: 基于 Keystone 平台开发业务模块。当用户需要创建新模块、添加业务功能、实现 CRUD、审批流程、数据导入导出、文件上传时使用。Use when creating modules, adding features, implementing CRUD, approval workflows, import/export, or file upload for Keystone platform.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Keystone 业务模块开发
|
|
7
|
+
|
|
8
|
+
使用 Keystone 平台快速开发业务模块。
|
|
9
|
+
|
|
10
|
+
## 工作流程
|
|
11
|
+
|
|
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. **输出调整建议**
|
|
17
|
+
|
|
18
|
+
## 能力选择矩阵
|
|
19
|
+
|
|
20
|
+
根据需求关键词选用对应能力：
|
|
21
|
+
|
|
22
|
+
| 需求关键词 | 前端能力 | 后端能力 |
|
|
23
|
+
|-----------|---------|---------|
|
|
24
|
+
| 列表、查询 | ProTable + 过滤 + 分页 | ListHandler + Repository |
|
|
25
|
+
| 表单、编辑 | ProForm + 验证 | CreateHandler + UpdateHandler |
|
|
26
|
+
| 导入、批量 | DataImporter | ImportHandler + Job队列 |
|
|
27
|
+
| 导出、下载 | DataExporter | ExportHandler + Job队列 |
|
|
28
|
+
| 上传、附件 | FileUpload | UploadHandler + 存储服务 |
|
|
29
|
+
| 审批、流程 | ApprovalFlowEditor | 审批引擎 |
|
|
30
|
+
| 权限 | PermissionGuard | 权限中间件 |
|
|
31
|
+
|
|
32
|
+
详细能力清单见 [CAPABILITIES.md](CAPABILITIES.md)。
|
|
33
|
+
代码模板见 [TEMPLATES.md](TEMPLATES.md)。
|
|
34
|
+
|
|
35
|
+
## 模块结构约定
|
|
36
|
+
|
|
37
|
+
### 前端模块
|
|
38
|
+
```
|
|
39
|
+
apps/web/src/modules/{name}/
|
|
40
|
+
├── index.ts # registerModule()
|
|
41
|
+
├── routes.tsx # 路由 + 菜单 + 权限
|
|
42
|
+
├── pages/
|
|
43
|
+
│ ├── List.tsx # ProTable
|
|
44
|
+
│ ├── Detail.tsx
|
|
45
|
+
│ └── Form.tsx # ProForm
|
|
46
|
+
├── services/api.ts
|
|
47
|
+
├── types.ts
|
|
48
|
+
└── help/index.md
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### 后端模块
|
|
52
|
+
```
|
|
53
|
+
apps/server/internal/modules/{name}/
|
|
54
|
+
├── module.go
|
|
55
|
+
├── api/handler/
|
|
56
|
+
├── domain/models/
|
|
57
|
+
├── domain/service/
|
|
58
|
+
├── infra/repository/
|
|
59
|
+
└── bootstrap/migrations/
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## 权限命名
|
|
63
|
+
|
|
64
|
+
格式: `{module}:{resource}:{action}`
|
|
65
|
+
|
|
66
|
+
动作: view | create | update | delete | manage | export | import | approve
|
|
67
|
+
|
|
68
|
+
## 注册步骤
|
|
69
|
+
|
|
70
|
+
生成代码后需完成以下注册（**缺一不可**）：
|
|
71
|
+
|
|
72
|
+
1. **前端导入** `main.tsx`: `import './modules/{name}'`
|
|
73
|
+
2. **前端启用** `app.config.ts`: 添加到 `modules.enabled` 数组 ⚠️ **必须，否则菜单不显示**
|
|
74
|
+
3. **后端注册** `manifest.go`: `import {name}module "app/internal/modules/{name}"` + `Register({name}module.NewModule())`
|
|
75
|
+
4. **后端启用** `config.yaml`: 添加到 `modules.enabled`
|
|
@@ -2,6 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
## 前端模板
|
|
4
4
|
|
|
5
|
+
### Ant Design v6 注意事项
|
|
6
|
+
- `Space` 使用 `orientation`，不要用 `direction`。
|
|
7
|
+
- `Modal` 使用 `destroyOnHidden`，不要用 `destroyOnClose`。
|
|
8
|
+
|
|
5
9
|
### routes.tsx
|
|
6
10
|
```tsx
|
|
7
11
|
import { RouteObject } from 'react-router-dom'
|
|
@@ -87,19 +91,20 @@ export function Component() {
|
|
|
87
91
|
### Form.tsx (ProForm)
|
|
88
92
|
```tsx
|
|
89
93
|
import { ProForm } from '@robsun/keystone-web-core'
|
|
90
|
-
import { api } from '@robsun/keystone-web-core'
|
|
91
94
|
import { useParams, useNavigate } from 'react-router-dom'
|
|
95
|
+
import { create{Entity}, update{Entity} } from '../services/api'
|
|
92
96
|
|
|
93
97
|
export function Component() {
|
|
94
|
-
const { id } = useParams()
|
|
98
|
+
const { id: rawId } = useParams()
|
|
95
99
|
const navigate = useNavigate()
|
|
96
|
-
const
|
|
100
|
+
const id = Number(rawId)
|
|
101
|
+
const isEdit = Number.isFinite(id)
|
|
97
102
|
|
|
98
103
|
const onSubmit = async (values: any) => {
|
|
99
104
|
if (isEdit) {
|
|
100
|
-
await
|
|
105
|
+
await update{Entity}(id, values)
|
|
101
106
|
} else {
|
|
102
|
-
await
|
|
107
|
+
await create{Entity}(values)
|
|
103
108
|
}
|
|
104
109
|
navigate('/{name}')
|
|
105
110
|
}
|
|
@@ -1,75 +1,75 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: keystone-dev
|
|
3
|
-
description: 基于 Keystone 平台开发业务模块。当用户需要创建新模块、添加业务功能、实现 CRUD、审批流程、数据导入导出、文件上传时使用。Use when creating modules, adding features, implementing CRUD, approval workflows, import/export, or file upload for Keystone platform.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Keystone 业务模块开发
|
|
7
|
-
|
|
8
|
-
使用 Keystone 平台快速开发业务模块。
|
|
9
|
-
|
|
10
|
-
## 工作流程
|
|
11
|
-
|
|
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. **输出调整建议**
|
|
17
|
-
|
|
18
|
-
## 能力选择矩阵
|
|
19
|
-
|
|
20
|
-
根据需求关键词选用对应能力：
|
|
21
|
-
|
|
22
|
-
| 需求关键词 | 前端能力 | 后端能力 |
|
|
23
|
-
|-----------|---------|---------|
|
|
24
|
-
| 列表、查询 | ProTable + 过滤 + 分页 | ListHandler + Repository |
|
|
25
|
-
| 表单、编辑 | ProForm + 验证 | CreateHandler + UpdateHandler |
|
|
26
|
-
| 导入、批量 | DataImporter | ImportHandler + Job队列 |
|
|
27
|
-
| 导出、下载 | DataExporter | ExportHandler + Job队列 |
|
|
28
|
-
| 上传、附件 | FileUpload | UploadHandler + 存储服务 |
|
|
29
|
-
| 审批、流程 | ApprovalFlowEditor | 审批引擎 |
|
|
30
|
-
| 权限 | PermissionGuard | 权限中间件 |
|
|
31
|
-
|
|
32
|
-
详细能力清单见 [CAPABILITIES.md](CAPABILITIES.md)。
|
|
33
|
-
代码模板见 [TEMPLATES.md](TEMPLATES.md)。
|
|
34
|
-
|
|
35
|
-
## 模块结构约定
|
|
36
|
-
|
|
37
|
-
### 前端模块
|
|
38
|
-
```
|
|
39
|
-
apps/web/src/modules/{name}/
|
|
40
|
-
├── index.ts # registerModule()
|
|
41
|
-
├── routes.tsx # 路由 + 菜单 + 权限
|
|
42
|
-
├── pages/
|
|
43
|
-
│ ├── List.tsx # ProTable
|
|
44
|
-
│ ├── Detail.tsx
|
|
45
|
-
│ └── Form.tsx # ProForm
|
|
46
|
-
├── services/api.ts
|
|
47
|
-
├── types.ts
|
|
48
|
-
└── help/index.md
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
### 后端模块
|
|
52
|
-
```
|
|
53
|
-
apps/server/internal/modules/{name}/
|
|
54
|
-
├── module.go
|
|
55
|
-
├── api/handler/
|
|
56
|
-
├── domain/models/
|
|
57
|
-
├── domain/service/
|
|
58
|
-
├── infra/repository/
|
|
59
|
-
└── bootstrap/migrations/
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
## 权限命名
|
|
63
|
-
|
|
64
|
-
格式: `{module}:{resource}:{action}`
|
|
65
|
-
|
|
66
|
-
动作: view | create | update | delete | manage | export | import | approve
|
|
67
|
-
|
|
68
|
-
## 注册步骤
|
|
69
|
-
|
|
70
|
-
生成代码后需完成以下注册（**缺一不可**）：
|
|
71
|
-
|
|
72
|
-
1. **前端导入** `main.tsx`: `import './modules/{name}'`
|
|
73
|
-
2. **前端启用** `app.config.ts`: 添加到 `modules.enabled` 数组 ⚠️ **必须，否则菜单不显示**
|
|
74
|
-
3. **后端注册** `manifest.go`: `import {name}module "app/internal/modules/{name}"` + `Register({name}module.NewModule())`
|
|
75
|
-
4. **后端启用** `config.yaml`: 添加到 `modules.enabled`
|
|
1
|
+
---
|
|
2
|
+
name: keystone-dev
|
|
3
|
+
description: 基于 Keystone 平台开发业务模块。当用户需要创建新模块、添加业务功能、实现 CRUD、审批流程、数据导入导出、文件上传时使用。Use when creating modules, adding features, implementing CRUD, approval workflows, import/export, or file upload for Keystone platform.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Keystone 业务模块开发
|
|
7
|
+
|
|
8
|
+
使用 Keystone 平台快速开发业务模块。
|
|
9
|
+
|
|
10
|
+
## 工作流程
|
|
11
|
+
|
|
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. **输出调整建议**
|
|
17
|
+
|
|
18
|
+
## 能力选择矩阵
|
|
19
|
+
|
|
20
|
+
根据需求关键词选用对应能力：
|
|
21
|
+
|
|
22
|
+
| 需求关键词 | 前端能力 | 后端能力 |
|
|
23
|
+
|-----------|---------|---------|
|
|
24
|
+
| 列表、查询 | ProTable + 过滤 + 分页 | ListHandler + Repository |
|
|
25
|
+
| 表单、编辑 | ProForm + 验证 | CreateHandler + UpdateHandler |
|
|
26
|
+
| 导入、批量 | DataImporter | ImportHandler + Job队列 |
|
|
27
|
+
| 导出、下载 | DataExporter | ExportHandler + Job队列 |
|
|
28
|
+
| 上传、附件 | FileUpload | UploadHandler + 存储服务 |
|
|
29
|
+
| 审批、流程 | ApprovalFlowEditor | 审批引擎 |
|
|
30
|
+
| 权限 | PermissionGuard | 权限中间件 |
|
|
31
|
+
|
|
32
|
+
详细能力清单见 [CAPABILITIES.md](CAPABILITIES.md)。
|
|
33
|
+
代码模板见 [TEMPLATES.md](TEMPLATES.md)。
|
|
34
|
+
|
|
35
|
+
## 模块结构约定
|
|
36
|
+
|
|
37
|
+
### 前端模块
|
|
38
|
+
```
|
|
39
|
+
apps/web/src/modules/{name}/
|
|
40
|
+
├── index.ts # registerModule()
|
|
41
|
+
├── routes.tsx # 路由 + 菜单 + 权限
|
|
42
|
+
├── pages/
|
|
43
|
+
│ ├── List.tsx # ProTable
|
|
44
|
+
│ ├── Detail.tsx
|
|
45
|
+
│ └── Form.tsx # ProForm
|
|
46
|
+
├── services/api.ts
|
|
47
|
+
├── types.ts
|
|
48
|
+
└── help/index.md
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### 后端模块
|
|
52
|
+
```
|
|
53
|
+
apps/server/internal/modules/{name}/
|
|
54
|
+
├── module.go
|
|
55
|
+
├── api/handler/
|
|
56
|
+
├── domain/models/
|
|
57
|
+
├── domain/service/
|
|
58
|
+
├── infra/repository/
|
|
59
|
+
└── bootstrap/migrations/
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## 权限命名
|
|
63
|
+
|
|
64
|
+
格式: `{module}:{resource}:{action}`
|
|
65
|
+
|
|
66
|
+
动作: view | create | update | delete | manage | export | import | approve
|
|
67
|
+
|
|
68
|
+
## 注册步骤
|
|
69
|
+
|
|
70
|
+
生成代码后需完成以下注册（**缺一不可**）：
|
|
71
|
+
|
|
72
|
+
1. **前端导入** `main.tsx`: `import './modules/{name}'`
|
|
73
|
+
2. **前端启用** `app.config.ts`: 添加到 `modules.enabled` 数组 ⚠️ **必须，否则菜单不显示**
|
|
74
|
+
3. **后端注册** `manifest.go`: `import {name}module "app/internal/modules/{name}"` + `Register({name}module.NewModule())`
|
|
75
|
+
4. **后端启用** `config.yaml`: 添加到 `modules.enabled`
|
|
@@ -2,6 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
## 前端模板
|
|
4
4
|
|
|
5
|
+
### Ant Design v6 注意事项
|
|
6
|
+
- `Space` 使用 `orientation`，不要用 `direction`。
|
|
7
|
+
- `Modal` 使用 `destroyOnHidden`，不要用 `destroyOnClose`。
|
|
8
|
+
|
|
5
9
|
### routes.tsx
|
|
6
10
|
```tsx
|
|
7
11
|
import { RouteObject } from 'react-router-dom'
|
|
@@ -87,19 +91,20 @@ export function Component() {
|
|
|
87
91
|
### Form.tsx (ProForm)
|
|
88
92
|
```tsx
|
|
89
93
|
import { ProForm } from '@robsun/keystone-web-core'
|
|
90
|
-
import { api } from '@robsun/keystone-web-core'
|
|
91
94
|
import { useParams, useNavigate } from 'react-router-dom'
|
|
95
|
+
import { create{Entity}, update{Entity} } from '../services/api'
|
|
92
96
|
|
|
93
97
|
export function Component() {
|
|
94
|
-
const { id } = useParams()
|
|
98
|
+
const { id: rawId } = useParams()
|
|
95
99
|
const navigate = useNavigate()
|
|
96
|
-
const
|
|
100
|
+
const id = Number(rawId)
|
|
101
|
+
const isEdit = Number.isFinite(id)
|
|
97
102
|
|
|
98
103
|
const onSubmit = async (values: any) => {
|
|
99
104
|
if (isEdit) {
|
|
100
|
-
await
|
|
105
|
+
await update{Entity}(id, values)
|
|
101
106
|
} else {
|
|
102
|
-
await
|
|
107
|
+
await create{Entity}(values)
|
|
103
108
|
}
|
|
104
109
|
navigate('/{name}')
|
|
105
110
|
}
|