Skip to content

Commit 01ff5c1

Browse files
xlorneclaude
andcommitted
docs: 添加前端模块划分规范和 Groovy 脚本架构方案
- 完善 CLAUDE.md 模块结构,添加前端模块划分规范 - 添加前端文件命名规范(小写字母+下划线) - 新增 Groovy 脚本处理架构统一优化计划 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 796a895 commit 01ff5c1

2 files changed

Lines changed: 329 additions & 176 deletions

File tree

CLAUDE.md

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ pnpm run dev:app-mobile # 移动端应用
7373

7474
### 模块结构
7575

76+
#### 后端模块
77+
7678
| 模块 | 描述 |
7779
|--------|-------------|
7880
| `flow-engine-framework` | 核心工作流引擎框架 |
@@ -81,11 +83,40 @@ pnpm run dev:app-mobile # 移动端应用
8183
| `flow-engine-starter-infra` | 基础设施层 |
8284
| `flow-engine-starter-query` | 查询层 |
8385
| `flow-engine-example` | 示例应用 |
84-
| `frontend/apps/app-pc` | PC 端流程设计器和管理后台 |
85-
| `frontend/apps/app-mobile` | 移动端待办/已办页面 |
86-
| `frontend/packages/flow-core` | 核心 API 库 |
87-
| `frontend/packages/flow-types` | TypeScript 类型定义库 |
88-
| `frontend/packages/flow-pc` | PC 端组件库 |
86+
87+
#### 前端模块
88+
89+
| 模块 | 描述 | 依赖 |
90+
|--------|-------------|------|
91+
| `flow-core` | 核心框架库(HTTP、Hooks、Presenter 等),不包含 UI 组件 ||
92+
| `flow-types` | TypeScript 类型定义(流程实例、表单、审批等业务类型) | flow-core |
93+
| `flow-pc-ui` | PC 端基础 UI 组件库(按钮、输入框等原子组件) ||
94+
| `flow-pc-form` | PC 端表单相关组件(表单设计器、表单渲染等) | flow-core, flow-types |
95+
| `flow-pc-design` | PC 端流程设计器组件(节点配置、属性面板等) | flow-core, flow-types, flow-pc-ui |
96+
| `flow-pc-approval` | PC 端审批页面(待办/已办/审批处理等) | flow-pc-design, flow-pc-ui |
97+
98+
**前端模块依赖关系**
99+
100+
```
101+
flow-core (无UI)
102+
103+
flow-types (类型定义)
104+
↑ ↑
105+
│ └── flow-pc-form
106+
│ ↑
107+
└───────→ flow-pc-design ──→ flow-pc-approval
108+
109+
flow-pc-ui (基础UI)
110+
```
111+
112+
**模块划分原则**
113+
114+
- **flow-core**:全局框架依赖,只包含与 UI 无关的基础能力(HTTP、状态管理、工具函数等)
115+
- **flow-types**:全局类型定义,包含流程审批相关的业务类型(手机端和 PC 端共用)
116+
- **flow-pc-ui**:PC 端基础 UI 组件库,提供原子化组件
117+
- **flow-pc-form**:表单相关功能,依赖 flow-core + flow-types
118+
- **flow-pc-design**:流程设计器功能,包含节点配置、属性面板、脚本配置等(本次优化的主要模块)
119+
- **flow-pc-approval**:审批页面功能,依赖 flow-pc-design
89120

90121
### 技术栈
91122

@@ -105,6 +136,7 @@ pnpm run dev:app-mobile # 移动端应用
105136

106137
- **与用户沟通及编写文档时,所有内容必须使用中文表述**
107138
- 前端包管理使用 pnpm(根据用户配置)
139+
- 前端文件命名规范:使用小写字母 + 下划线组合(如 `script_editor.tsx``variable_picker.tsx`
108140
- 设计涉及流程或 UML 图形的解决方案时,使用 Mermaid Markdown 语法
109141
- 在编写计划的时候要遵循 TDD 的开发规范,务必要在方案中进行对实现代码逻辑的单元测试设计。
110142
- 在设计计划方案或执行方案过程中,对于代码的设计规划与调整修改要遵循本项目的代码风格和架构设计规则

0 commit comments

Comments
 (0)