Skip to content

Commit a68fc7a

Browse files
committed
docs: 更新前端开发教程,添加测试和桥接层文档
- 05-frontend-development.md: - 添加测试章节:运行测试、覆盖率、编写测试示例 - 添加桥接层使用章节:web-bridge API 和事件系统 - 更新请求库文档:新增配置选项表格和日志控制说明 - 更新项目结构:添加 __tests__、coverage、web-bridge 目录 - 更新构建流程:添加 build:web-bridge 步骤 - 修正 UMD 全局变量名:NEKOComponents → ProjectNekoComponents - 03-project-structure.md: - 更新 React 前端目录结构 - 更新 Frontend 模块说明 - 更新开发入口点:添加测试命令
1 parent d349bad commit a68fc7a

2 files changed

Lines changed: 316 additions & 40 deletions

File tree

03-project-structure.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,11 @@ utils/
120120
frontend/
121121
├── packages/ # 前端包
122122
│ ├── common/ # 公共模块
123-
│ ├── components/ # React 组件
124-
│ └── request/ # 请求客户端
123+
│ ├── components/ # React 组件库
124+
│ ├── request/ # 请求客户端(含测试)
125+
│ │ ├── __tests__/ # 单元测试
126+
│ │ └── coverage/ # 测试覆盖率报告
127+
│ └── web-bridge/ # 桥接层(暴露组件到 window)
125128
├── src/ # 源码
126129
│ └── web/ # Web 应用入口
127130
├── scripts/ # 构建脚本
@@ -330,13 +333,15 @@ specs/
330333
位于 `frontend/` 目录,基于 TypeScript + React 的前端架构:
331334

332335
- **packages/**:模块化包结构
333-
- **common/**:公共模块
334-
- **components/**:React 组件库
335-
- **request/**:请求客户端(支持 Web 和 Native)
336+
- **common/**:公共模块(类型定义、工具函数)
337+
- **components/**:React 组件库(Button、StatusToast、Modal 等)
338+
- **request/**:请求客户端(支持 Web 和 Native,含单元测试)
339+
- **web-bridge/**:桥接层(将组件和请求能力暴露到 window)
336340
- **src/web/**:Web 应用入口
337341
- **scripts/**:构建和打包脚本
338342
- **vendor/**:第三方库(React 等)
339343
- 支持组件独立打包和 UMD 格式
344+
- 使用 Vitest 进行单元测试
340345

341346
### 7. Utils 模块(工具函数)
342347

@@ -445,7 +450,10 @@ brain/s2_5/ 或 brain/s3/ (智能体实现)
445450
1. **TypeScript + React 应用**`frontend/`
446451
- 添加新组件:`frontend/packages/components/src/`
447452
- 添加公共模块:`frontend/packages/common/`
453+
- 修改请求客户端:`frontend/packages/request/`
454+
- 修改桥接层:`frontend/packages/web-bridge/`
448455
- 修改 Web 应用:`frontend/src/web/`
456+
- 运行测试:`cd frontend/packages/request && npm test`
449457

450458
2. **传统前端**`static/``templates/`
451459
- 修改 HTML:`templates/`

0 commit comments

Comments
 (0)