AGENTS.md
1.93 KB
inclusion: always
Codex 项目规则
1. 字符集规范
- 所有源码、配置、脚本、文档统一使用 UTF-8 编码。
- 新建文件默认使用 UTF-8(建议无 BOM)。
- 禁止混用 GBK/ANSI/UTF-16 等编码,避免出现中文乱码和跨平台差异。
2. 项目结构
HaHWeb/
├─ src/
│ ├─ components/ # 公共组件
│ ├─ composables/ # 组合式函数(hooks)
│ ├─ data/ # 静态/模拟数据
│ ├─ i18n/ # 国际化资源
│ ├─ layouts/ # 布局组件
│ ├─ pages/ # 页面模块
│ ├─ router/ # 路由配置
│ ├─ scss/ # 全局样式
│ ├─ services/ # API 与业务服务层
│ └─ stores/ # Pinia 状态管理
├─ public/ # 静态资源
├─ docs/ # 项目文档
├─ e2e/ # 端到端测试
├─ .storybook/ # Storybook 配置
├─ package.json # 依赖与脚本
├─ tsconfig.json # TypeScript 配置
├─ vite.config.ts # Vite 配置
└─ tailwind.config.js # Tailwind 配置
3. 技术栈
- 前端框架:Vue 3.5(Composition API)
- 语言:TypeScript 5
- 构建工具:Vite 5
- UI 组件库:Vuestic UI 1.10
- 状态管理:Pinia 2
- 路由:Vue Router 4
- 国际化:vue-i18n 9
- 表格:AG Grid Vue 3
- 样式:TailwindCSS 3 + Sass/SCSS
- 代码规范:ESLint + Prettier + lint-staged + Husky
- 可视化/图表:Chart.js + vue-chartjs
- 实时通信:@microsoft/signalr
4. 常用命令
yarn dev # 本地开发
yarn build # 构建(含 lint + type check)
yarn build:ci # CI 构建
yarn lint # 代码检查与修复
yarn format # 代码格式化
yarn preview # 本地预览
yarn storybook # 启动 Storybook
yarn e2e # 运行 E2E