开发规范
# 开发规范
为了维护项目的代码质量,项目中内置了格式化代码的工具 Prettier 和代码检测质量检查工具 ESlint。
同时,也推荐您在开发过程中遵循 提交规范,以保持项目仓库的分支、提交信息的清晰整洁。 代码编写规范
# vite + vue3 的基础规范
# Prettier
在 VS Code 中安装 Prettier
插件、使用代码自动格式化的功能。
项目架构包含了配置开发规范的 .prettierrc.js
文件
# ESlint
使用ESlint
来检查代码质量和风格问题。
项目中内置了 .eslintrc
文件。您可以通过下面命令来进行代码检查和自动修复。 执行以下指令,会进行问题的检查及修复,在 pre-commit 的 git hook 中,项目也内置了检查指令,帮助您在提交代码前发现问题
# 代码检查
npm run lint
# 自动修复问题
npm run lint:fix
# 目录的命名规范
1.目录名全部使用小写, 使用驼峰式的命名,文件名首字母小写,组件库名首字母大写、 components
。
# 文件的命名规范
1.文件名全部使用小写, 使用驼峰式的命名。如 listScroll.vue 。
2.引导型特殊文件、样式及资源目录文件除外,如 index.ts
、 main.ts
、 index.vue
。
# 类及接口的命名规范
1.类名全部使用大写驼峰,同时命名跟回文件命名。
2.接口命名也是使用驼峰命名 。