代码编辑器:VSCode
编辑器插件: 见 .vscode/extensions.json
- 框架:TypeScript 4.x + Vue 3.x
- 工程化:vite 5
- 包管理器:pnpm
- 代码规范:Prettier + ESLint + lsLint
- Git Hook 工具:husky + lint-staged
- 提交规范:Commitlint
- 组件库:[email protected]
- 路由:[email protected]
- 本地持久化库:[email protected]
- 原子化 Css:unocss
- 生成 svg 雪碧图: vite-plugin-svg-icons
- 项目名:小写方式,多个单词以短横线分隔,例如:
vue-admin
- 类型声明:大驼峰方式,例如:
LoadMore
- 目录名:小写方式,多个单词以短横线分隔,例如:
array-union
- 图像文件:小写方式,多个单词以下划线分隔,例如:
banner_sina.jpg
- HTML 文件:小写方式,多个单词以下划线分隔,例如:
error_report.html
- CSS 文件:小写方式,多个单词以短横线分隔,例如:
date-picker.scss
- JavaScript/TypeScript 文件:小写方式,多个单词以短横线分隔,例如:
date-util.js
- Vue 组件:小写方式,多个单词以短横线分隔,例如:
base-svg-icon.vue
- 调用 Vue 组件:小写方式,多个单词以短横线分隔,例如:
<base-svg-icon></base-svg-icon>
- 声明 prop:小驼峰方式,例如:
userName
- Vue Router Path:小驼峰方式,例如:
/userName
- 变量:小驼峰方式,例如:
const mySchool = "我的学校"
- 常量:大写方式,多个单词以下划线分隔,例如:
const MAX_COUNT = 10
- 方法:小驼峰方式,使用动词、动词+名词形式,例如:
init()
、jumpPage()
- 请求数据的方法:使用动词+名词形式,以
data
结尾,例如:getListData()
- 自定义事件:小写方式,多个单词以短横线分隔,例如:
emit('my-event')
请按照上述规范进行项目命名和代码编写,以保持一致的代码风格和易读性。
pnpm install
pnpm dev
pnpm run build
pnpm run lint
<---- 具体查看请求封装API
-
类型 描述 build 编译相关的修改,例如发布版本、对项目构建或者依赖的改动 chore 其他修改, 比如改变构建流程、或者增加依赖库、工具等 ci 持续集成修改 docs 文档修改 feat 新特性、新功能 fix 修改bug perf 优化相关,比如提升性能、体验 refactor 代码重构 revert 回滚到上一个版本 style 代码格式修改, 注意不是 css 修改 test 测试用例修改