diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index a38243a..9c1fc69 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,8 +1,6 @@ -# SoybeanAdmin - AI 开发助手指南 +### 开发工作流 -## 项目概述 - -SoybeanAdmin 是一个基于 Vue3 + Vite7 + TypeScript 的清新优雅的中后台管理模板。这是一个 **pnpm monorepo** 架构的项目,包含多个子包。 +- 如果我向你提一个新需求或一个 bug 修复请求,你有不懂的地方,先主动提问,直到你完全理解需求为止。 ### 核心技术栈 @@ -20,58 +18,10 @@ SoybeanAdmin 是一个基于 Vue3 + Vite7 + TypeScript 的清新优雅的中后 - **包管理器**: pnpm 10.5.0+ - **Node 版本**: 20.19.0+ -## 项目结构 - -### 主要目录说明 - -``` -soybean-admin/ -├── packages/ # Monorepo 子包目录 -│ ├── alova/ # Alova 网络请求封装 -│ ├── axios/ # Axios 网络请求封装 -│ ├── color/ # 颜色工具包 -│ ├── hooks/ # 通用 Hooks 集合 -│ ├── materials/ # 组件物料库 -│ ├── scripts/ # 脚本工具 -│ ├── uno-preset/ # UnoCSS 预设 -│ └── utils/ # 通用工具函数 -├── src/ # 主应用源码 -│ ├── assets/ # 静态资源 -│ ├── components/ # 公共组件 -│ ├── constants/ # 常量定义 -│ ├── enum/ # 枚举定义 -│ ├── hooks/ # 业务 Hooks -│ ├── layouts/ # 布局组件 -│ ├── locales/ # 国际化配置 -│ ├── plugins/ # 插件配置 -│ ├── router/ # 路由配置 -│ ├── service/ # API 服务层 -│ ├── store/ # Pinia 状态管理 -│ ├── styles/ # 全局样式 -│ ├── theme/ # 主题配置 -│ ├── typings/ # TypeScript 类型定义 -│ ├── utils/ # 工具函数 -│ └── views/ # 页面视图 -├── build/ # 构建配置 -└── public/ # 公共静态资源 -``` - -### Monorepo 子包说明 - -- `@sa/axios`: Axios 封装,包含请求拦截、响应处理、错误处理等 -- `@sa/alova`: Alova 封装,提供另一种网络请求方案 -- `@sa/hooks`: 通用 React Hooks 风格的组合式函数 -- `@sa/utils`: 通用工具函数库 -- `@sa/color`: 颜色处理工具 -- `@sa/materials`: UI 组件物料 -- `@sa/scripts`: 命令行工具脚本 -- `@sa/uno-preset`: UnoCSS 自定义预设 - ## 开发规范 ### 代码风格 -- 遵循 [SoybeanJS 规范](https://docs.soybeanjs.cn/zh/standard) - 使用 ESLint (@soybeanjs/eslint-config) 进行代码检查 - 严格的 TypeScript 类型检查 - 使用 Composition API 和 `