Vue3项目代码规范

代码规范

项目结构
editorconfig配置
prettierrc配置
prettierignore配置
eslint配置
git Husky和eslint
git commit规范
- 代码提交风格
- 代码提交验证

项目结构

vue3-ts-cms
├─ .browserslistrc
├─ .editorconfig
├─ .eslintrc.js
├─ .gitignore
├─ .prettierignore
├─ .prettierrc
├─ babel.config.js
├─ package-lock.json
├─ package.json
├─ public
│  ├─ favicon.ico
│  └─ index.html
├─ README.md
├─ src
│  ├─ App.vue
│  ├─ assets
│  │  └─ logo.png
│  ├─ components
│  ├─ main.ts
│  ├─ shims-vue.d.ts
├─ tsconfig.json

editorconfig配置

EditorConfig 有助于为不同 IDE 编辑器上处理同一项目的多个开发人员维护一致的编码风格。
在项目的根目录下创建 .editorconfig 文件后，复制下面配置。
.editorconfig

# http://editorconfig.orgroot = true # 当前文件是否在根目录下[*] # 表示所有文件适用
charset = utf-8 # 设置文件字符集为 utf-8
indent_style = space # 缩进风格（tab | space）
indent_size = 2 # 缩进大小
end_of_line = lf # 控制换行类型(lf | cr | crlf)
trim_trailing_whitespace = true # 去除行首的任意空白字符
insert_final_newline = true # 始终在文件末尾插入一个新行[*.md] # 表示仅 md 文件适用以下规则
max_line_length = off
trim_trailing_whitespace = false

PS：若在VSCode配置editorconfig，则需要安装一个插件：EditorConfig for VS Code

prettierrc配置

Prettier 是一款强大的代码格式化工具，支持 JavaScript、TypeScript、CSS、SCSS、Less、JSX、Angular、Vue、GraphQL、JSON、Markdown 等语言，基本上前端能用到的文件格式它都可以搞定，是当下最流行的代码格式化工具
在根目录下创建 .prettierrc 文件后，复制下面配置
.prettierrc

{"useTabs": false,"tabWidth": 2,"printWidth": 80,"singleQuote": true,"trailingComma": "none","semi": false
}

属性	说明
useTabs	true：使用tab缩进 false：使用空格缩进
tabWidth	在tab是空格的情况下，是几个空格，选择2个
printWidth	当行字符的长度超过设置的长度，代码将换行。推荐80，100
singleQuote	true：使用单引号 false：使用双引号
trailingComma	在多行输入的尾逗号是否添加，设置为 `none`
semi	语句末尾是否要加分号，默认值true，选择false表示不加

测试prettier生效直接在代码中保存即可见效。

情况一：保存代码无法格式化。
原因：可能VSCode有多个保存自动格式化的插件，未设置默认的插件，VSCode不知道选择哪个插件进行格式化
解决方法：右键->格式化文档会提醒没有设置默认的格式化插件，选择prettier插件即可，再自动保存时就可以自动格式化了
情况二：保存代码无法格式化，但是右键->格式化文档可以格式化
原因：可能VSCode未设置保存文件格式化
解决方法：文件->设置->搜索栏搜索save->找到Editor: Format On Save并勾选上即可

prettierignore配置

不是所有的文件保存的时候都需要格式化，有些文件保存则不需要格式化。此时就需要配置忽略格式化文件配置
在根目录下创建 .prettierignore 忽略文件，复制下面配置
.prettierignore

/dist/*
.local
.output.js
/node_modules/****/*.svg
**/*.sh/public/*

PS：若在VSCode中配置prettierrc和prettierignore，则需要安装一个插件：prettier

PS：配置好prettierrc文件后，保存文件即可格式化。
快速格式化文件：需要在package.json添加一个脚本，再运行此脚本即可使所有文件都格式化（prettierignore配置忽略的文件除外）

"prettier": "prettier --write ."

运行脚本

npm run prettier

eslint配置

在前面创建项目的时候，我们就选择了ESLint，所以Vue会默认帮助我们配置需要的ESLint环境。
PS：若在VSCode中，则需要安装一个插件：ESLint

解决eslint和prettier冲突的问题：
安装插件：（vue在创建项目时，如果选择prettier，那么这两个插件会自动安装，就不需要再安装）

npm i eslint-plugin-prettier eslint-config-prettier -D

在eslintrc.js文件添加一个配置后重启VSCode即可解决冲突问题

注意：plugin和:之间没有空格，不然会不符合eslint的语法报异常

"plugin:prettier/recommended"

git Husky和eslint

虽然我们已经要求项目使用 eslint 了，但是不能保证其他组员提交代码之前都将代码格式化了。也就是我们希望保证代码仓库中的代码都是符合 eslint 规范的。

那么我们就需要在组员执行 git commit 命令的时候对其进行校验，如果不符合 eslint 规范，那么自动通过规范进行修复。

那么如何做到这一点呢？可以通过Husky工具：
husky 是一个git hook工具，可以帮助我们触发git提交的各个阶段：pre-commit、commit-msg、pre-push

我们可以使用自动配置命令：

windows:
npx husky-init '&&' npm install
--------------------------------
linux:
npx husky-init '&&' npm install

这个自动配置命令会做三件事：

1.安装husky相关的依赖：

2.在项目根目录下创建 .husky 文件夹：

npx huksy install

3.在package.json中添加一个脚本：

接下来，我们需要去完成一个操作：在进行commit时，执行lint脚本：

这个时候我们执行git commit的时候会自动对代码进行lint校验。

git commit规范

代码提交风格

通常我们的git commit会按照统一的风格来提交，这样可以快速定位每次提交的内容，方便之后对版本进行控制。

但是如果每次手动来编写这些是比较麻烦的事情，我们可以使用一个工具：Commitizen

Commitizen 是一个帮助我们编写规范 commit message 的工具；

1.安装Commitizen

npm install commitizen -D

2.安装cz-conventional-changelog，并且初始化cz-conventional-changelog：

npx commitizen init cz-conventional-changelog --save-dev --save-exact

这个命令会帮助我们安装cz-conventional-changelog：

并且在package.json中进行配置：

这个时候我们提交代码需要使用 npx cz：

第一步是选择type，本次更新的类型

Type	作用
feat	新增特性 (feature)
fix	修复 Bug(bug fix)
docs	修改文档 (documentation)
style	代码格式修改(white-space, formatting, missing semi colons, etc)
refactor	代码重构(refactor)
perf	改善性能(A code change that improves performance)
test	测试(when adding missing tests)
build	变更项目构建或外部依赖（例如 scopes: webpack、gulp、npm 等）
ci	更改持续集成软件的配置文件和 package 中的 scripts 命令，例如 scopes: Travis, Circle 等
chore	变更构建流程或辅助工具(比如更改测试环境)
revert	代码回退

第二步选择本次修改的范围（作用域）

第三步选择提交的信息

第四步提交详细的描述信息

第五步是否是一次重大的更改

第六步是否影响某个open issue

我们也可以在scripts中构建一个命令来执行 cz：

代码提交验证

如果我们按照cz来规范了提交风格，但是依然有同事通过 git commit 按照不规范的格式提交应该怎么办呢？

我们可以通过commitlint来限制提交；

1.安装 @commitlint/config-conventional 和 @commitlint/cli

npm i @commitlint/config-conventional @commitlint/cli -D

2.在根目录创建commitlint.config.js文件，配置commitlint

module.exports = {extends: ['@commitlint/config-conventional']
}

3.使用husky生成commit-msg文件，验证提交信息：

npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"