From 3b2b551ccedaf977f6df75d0165c46f388e5d902 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=A3=B7=E5=8F=B6?= <14103883+leaf-phos@user.noreply.gitee.com> Date: Sat, 4 Jan 2025 20:35:17 +0800 Subject: [PATCH] =?UTF-8?q?=E8=AE=BE=E5=A4=87=E7=B3=BB=E6=95=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .cursorrules | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .cursorrules diff --git a/.cursorrules b/.cursorrules new file mode 100644 index 0000000..a2d75cb --- /dev/null +++ b/.cursorrules @@ -0,0 +1,39 @@ +# 项目背景 +这是一个基于RuoYi-Vue的智能开关项目后台管理系统,主要用于管理智能开关设备、用户、订单、支付、设备状态、设备参数等。 + +# 主要框架 +- Vue2 +- Element-UI +- Axios +- Vuex +- Vue-Router + +# 编码标准 +- 变量和函数名使用 camelCase 规范,组件名使用 PascalCase +- 组件的样式使用 scoped 属性,避免样式污染 +- 样式使用scss +- props、data、methods、computed、watch 生命周期函数等都使用驼峰命名 +- 对于全局能够重复使用的组件,尽量封装成组件,并放在 src/components 目录下 +- 对于业务能够重复使用的组件,尽量封装成组件,并放在 src/views/{模块名}/components 目录下 +- 所有请求都需要在 src/api/{模块名}.js 文件中定义,并保持统一的命名规范,使用时统一调用 +- 业务操作尽量封装成方法或组件 +- table中的数据使用columns定义,具体可以参考其他组件 +- 保持与现有代码风格一致 +- 代码需要具有可读性,注释清晰,后续可拓展 + +# 项目结构 +- src/api 目录下存放接口文件 +- src/assets 目录下存放静态资源 +- src/components 目录下存放全局组件 +- src/views 目录下存放页面 +- src/utils 目录下存放工具类 +- src/utils/constants.js 目录下存放常量 +- src/utils/utils.js 目录下存放工具类 +- src/views/ss 目录下存放业务相关页面 +- src/views/system 目录下存放系统相关页面 + +# 文档规范 +- 使用 JSDoc 格式编写函数和组件的注释 +- 组件必须包含 PropTypes 验证 +- 每个主要目录必须包含 README.md 文件 +- 同时提供英语和中文版本的 README.md 文件 \ No newline at end of file