feat: 重组为标准 skill 包结构 + 修复 verify.sh bash 3.2 兼容
- 新增 .claude/skills/new-project/SKILL.md(标准 skill 格式) - install-skill.sh 安装时组装 SKILL.md + verify.sh,单一源无重复 - verify.sh 改用索引数组替代 declare -A,兼容 macOS bash 3.2 - log_pass/log_skip 显式 return 0,避免 set -e 下非 verbose 误退出 - README 改为 skill 优先;补全 copier.yml/scripts/template 入库
This commit is contained in:
@@ -0,0 +1,111 @@
|
||||
---
|
||||
paths: ["frontend/**"]
|
||||
---
|
||||
|
||||
# frontend
|
||||
|
||||
React + Vite + TypeScript + Tailwind 前端的技术栈、目录、各层职责边界、TS 规范与测试规范。
|
||||
|
||||
聊天式交互界面,实时展示 Gemini 对话、风格预览、HTML 演示文稿和下载入口。
|
||||
|
||||
## 技术栈
|
||||
|
||||
| 库 | 用途 |
|
||||
|----|------|
|
||||
| React 18 + Vite | 构建工具 + UI 框架 |
|
||||
| TypeScript(strict mode) | 类型安全 |
|
||||
| Tailwind CSS v3 | 样式(禁止自定义 CSS,全用 utility class) |
|
||||
| Zustand | 全局状态管理 |
|
||||
| TanStack Query v5 | 服务端状态(REST 请求) |
|
||||
| Zod | 运行时 WebSocket 消息验证 |
|
||||
| sonner | Toast 通知(错误/成功提示) |
|
||||
| Vitest + Testing Library | 单元测试 |
|
||||
|
||||
## 包管理(pnpm)
|
||||
|
||||
```bash
|
||||
pnpm add zustand @tanstack/react-query zod sonner
|
||||
pnpm dev # 开发服务器 http://localhost:5173
|
||||
pnpm build # 构建
|
||||
pnpm test # vitest(watch 模式)
|
||||
pnpm test:run # 单次运行(CI 用)
|
||||
pnpm typecheck # tsc --noEmit
|
||||
```
|
||||
|
||||
关键文件:`package.json`、`pnpm-lock.yaml`(锁文件,必须提交 git)、`vite.config.ts`、`tsconfig.json`
|
||||
|
||||
## 环境配置(.env)
|
||||
|
||||
配置项见 `.env.example`(提交 git);真实配置放 `.env`(gitignore)。
|
||||
|
||||
- **只有 `VITE_` 前缀的变量**才会被注入浏览器端代码,通过 `import.meta.env.VITE_XXX` 读取
|
||||
- **前端变量对用户完全可见,严禁放任何密钥**(图片源 API Key 走 localStorage,不进 .env)
|
||||
|
||||
```typescript
|
||||
const wsUrl = import.meta.env.VITE_BACKEND_WS_URL // ws://localhost:8000
|
||||
```
|
||||
|
||||
## 目录结构
|
||||
|
||||
```
|
||||
frontend/
|
||||
├── src/
|
||||
│ ├── components/ # 纯 UI 组件(无业务逻辑,无直接 store 读写)
|
||||
│ │ ├── ChatBubble.tsx # 单条对话气泡(Gemini / 用户)
|
||||
│ │ ├── ChatInput.tsx # 输入框 + 发送按钮
|
||||
│ │ ├── StylePicker.tsx # 3 张风格预览卡片,点击选择
|
||||
│ │ ├── PreviewFrame.tsx # iframe 展示完整 HTML 演示文稿
|
||||
│ │ ├── ProgressBar.tsx # 截图/合成进度条
|
||||
│ │ ├── DownloadBar.tsx # HTML + PPTX 下载按钮
|
||||
│ │ ├── ErrorBoundary.tsx # React 错误边界(组件级异常)
|
||||
│ │ └── Toast.tsx # 全局 Toast 容器(sonner Toaster)
|
||||
│ ├── pages/ # 页面级组件(组合 components,接入 hooks)
|
||||
│ │ └── GeneratorPage.tsx
|
||||
│ ├── hooks/ # 自定义 Hook(业务逻辑与副作用)
|
||||
│ │ ├── useWebSocket.ts # WebSocket 生命周期管理
|
||||
│ │ ├── usePresentation.ts # 会话状态机(dispatch + 状态衍生)
|
||||
│ │ └── useImageSource.ts # 图片源配置读写(localStorage)
|
||||
│ ├── services/ # 外部通信封装(纯函数,无 React 依赖)
|
||||
│ │ └── wsClient.ts # WebSocket send/receive,消息序列化
|
||||
│ ├── store/ # Zustand store
|
||||
│ │ └── presentationStore.ts # session、messages、previewUrls、status
|
||||
│ ├── types/ # TypeScript 类型(只定义,不实现)
|
||||
│ │ └── messages.ts # WsMessage、PreviewItem、SessionStatus 等
|
||||
│ ├── schemas/ # Zod schema(运行时验证,与 types 一一对应)
|
||||
│ │ └── messages.ts # wsMessageSchema、stylePickSchema 等
|
||||
│ ├── utils/ # 纯函数工具(无副作用)
|
||||
│ │ └── ansiStrip.ts # 过滤 ANSI 转义码
|
||||
│ └── main.tsx # 入口:挂载 ErrorBoundary + Toaster
|
||||
└── tests/
|
||||
├── components/
|
||||
├── hooks/
|
||||
└── schemas/
|
||||
```
|
||||
|
||||
## 各层职责边界
|
||||
|
||||
| 层 | 可以做 | 不可以做 |
|
||||
|----|--------|---------|
|
||||
| `components/` | 渲染 props,emit 回调 | 直接读 store、发 WebSocket |
|
||||
| `pages/` | 组合 components,调用 hooks | 包含复杂业务逻辑 |
|
||||
| `hooks/` | 读写 store,调用 services | 返回 JSX |
|
||||
| `services/` | 网络通信、序列化 | 读 store,使用 React API |
|
||||
| `store/` | 持有状态,提供 actions | 包含副作用 |
|
||||
|
||||
## TypeScript 规范
|
||||
|
||||
- 开启 `strict: true`
|
||||
- 命名:camelCase 变量/函数、PascalCase 组件/类型
|
||||
- 禁止 `any`(用 `unknown` + 类型守卫)
|
||||
- 所有 Zustand action 必须有明确返回类型
|
||||
- Zod schema 与 TypeScript 类型通过 `z.infer<>` 保持同源,禁止手写重复类型
|
||||
- **`types/messages.ts` 由后端 Pydantic 契约生成**(`pnpm gen:types`),禁止手改;改协议从后端改起(见根 CLAUDE.md「契约管理」)
|
||||
- 线上 JSON 契约字段为 snake_case,故生成类型的 DTO 字段为 snake_case;前端自身内部标识符仍用 camelCase
|
||||
|
||||
## 测试规范
|
||||
|
||||
- 组件测试:Testing Library,测行为不测实现(不 query class/id,用 role/label)
|
||||
- Hook 测试:`renderHook` + mock `wsClient`
|
||||
- Schema 测试:Zod parse 合法/非法用例各覆盖
|
||||
- ErrorBoundary 测试:注入 throw 的子组件,验证 fallback 渲染
|
||||
- 覆盖率目标:hooks 和 schemas 100%,组件 > 70%
|
||||
Reference in New Issue
Block a user