husky
「这是我参与2022首次更文挑战的第11天，活动详情查看：2022首次更文挑战」
我们在团队协作开发的过程中，可以使用各种lint工具约束团队的开发规范
但是我们并不能保证团队成员在提交代码的时候，保证代码已经符合规范
或者我们希望可以自动对不符合规范的代码进行自动修复
那么如何做到这一点呢？可以通过Husky工具：
- husky是一个git hook工具，可以帮助我们触发git提交的各个阶段：pre-commit(提交commit前)、commit-msg（在提交commit msg的时候）、pre-push(将本地记录提交到远程分支)
这里我们可以使用自动配置命令：
> npx husky-init && npm install
这里会做三件事：
1.安装husky相关的依赖：
2.在项目目录下创建 .husky 文件夹：
3.在package.json中添加一个脚本：--- 该脚本会在husky工作的合适时机，在内部被自动调用
接下来，我们需要去完成一个操作：在进行commit时，执行lint脚本：
"scripts": {
// 默认情况下 eslint只能对js文件进行检测和修复
// 如果需要对其它文件进行检测和修复，需要使用--ext手动指定对应文件后缀
"lint": "eslint --fix --ext .js,.ts,.vue src"
}
这个时候我们执行git commit的时候会自动对代码进行lint校验。
git commit规范
代码提交风格
通常我们的git commit会按照统一的风格来提交，这样可以快速定位每次提交的内容，方便之后对版本进行控制。
但是如果每次手动来编写这些是比较麻烦的事情，我们可以使用一个工具：Commitizen
- commitizen 是一个帮助我们编写规范 commit message 的工具；
1.安装commitizen
# 安装完毕后会在.bin目录下生成一个工具 --- cz
> 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：
"scripts": {
"commit": "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 | 代码回退 |
- 第二步选择本次修改的范围（作用域）--- 改了那些文件
- 第三步选择提交的信息 --- 需要提交的信息 --- 有字数限制
- 第四步提交详细的描述信息 --- 需要提交的信息 --- 没有字数限制
- 第五步是否是一次重大的更改 --- 默认回车 对应的就是no
- 第六步是否影响某个open issue ---- 默认回车对应的就是no
代码提交验证
如果我们按照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文件，验证提交信息：
# .husky/<对应hook名> 需要是一个unix可执行文件
# 所以如果是手动创建的，需要执行chmod +x <文件路径(可以直接将文件拖入命令行)>
# 从而手动将文件转变为unix的可执行文件
> npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"
