由于项目中一直未能规范提交日志，导致提交的的东西乱七八糟的，所以决定使用commitlint+husky 来规范 git commit
安装
npm install husky@4.3.8 --save-dev
或者
yarn add husky@4.3.8 -D
这里需要注意一点是安装最新husky版本会有各种各样问题, 例如我使用命令行提交的会遇到这个问题
$ git commit -m "xx"
error Command "husky-run" not found.
安装的版本是 "husky": "^7.0.1",, 查阅了网上一些资料发现是新版本的问题，并参照了一些三方开源库
react-native-document-picker
因为最新一直在调研移动端浏览文件的库，发现库维护的还是比较及时的，所以查看了它里面的husky
husky
发现它的版本是
^4.2.5, 其实真实匹配安装的版本是4.3.8，大家有兴趣可以自己查看yarn.lock.
所以 建议大家安装 4.3.8版本，可以确保没有问题，还有一点需要注意的是，可能某些人用空项目做测试，但是前提一定要进行 git init.
配置
如果使用commitlint，首先需要安装对用的包
npm install --save-dev @commitlint/config-conventional @commitlint/cli
或者
yarn add @commitlint/config-conventional @commitlint/cli -D
然后创建配置文件.commitlintrc.js 或者 commitlint.config.js 都可以，或者在package.json中配置也行，我这里采用配置.commitlintrc.js, 在文件中引入插件。
// .commitlintrc.js 文件
module.exports = {
extends: ["@commitlint/config-conventional"],
};
在package.json 配置提交钩子
...
"husky": {
"hooks": {
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
}
...
这里配置了commit-msg拦截钩子，当然还可以配置其他的，最常用的是pre-commit,我们可以做一些lint操作。
配置完以上的信息，这些终端执行 git commit -m "xx" 这时候验证就会生效
git commit -m 'xx'
husky > commit-msg (node v12.13.0)
⧗ input: xx
✖ subject may not be empty [subject-empty]
✖ type may not be empty [type-empty]
✖ found 2 problems, 0 warnings
ⓘ Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
husky > commit-msg hook failed (add --no-verify to bypass)
我们就需要按照既定的规则去提交
- 提交格式
git commit -m <type>[optional scope]: <description>
type ：用于表明我们这次提交的改动类型，是新增了功能？还是修改了测试代码？又或者是更新了文档？
optional scope：一个可选的修改范围。用于标识此次提交主要涉及到代码中哪个模块。
description：一句话描述此次提交的主要内容，做到言简意赅。
- 常用的 type 类型
| 类型 | 描述 |
|---|---|
| build | 编译相关的修改，例如发布版本、对项目构建或者依赖的改动 |
| chore | 其他修改, 比如改变构建流程、或者增加依赖库、工具等 |
| ci | 持续集成修改 |
| docs | 文档修改 |
| feat | 新特性、新功能 |
| fix | 修改 bug |
| perf | 优化相关，比如提升性能、体验 |
| refactor | 回滚到上一个版本 |
| style | 代码格式修改, 注意不是 css 修改 |
| test | 测试用例修改 |
- 例子
git commit -m 'fix(login): 修复登录的bug'
我们会发现提交成功了
git commit -m 'fix(login): 修复登录的bug'
husky > commit-msg (node v12.13.0)
[master ae56c33] fix(login): 修复登录的bug
1 file changed, 2 deletions(-)
在mac 上我们用sourceTree 提交会遇不校验的问题，大家可以参照
mac上使用sourceTree提交代码不会走husky自定义的钩子
我遇到的问题不是npx找不到，不过解决思路是一样的
cd ~
vim .huskyrc
把yarn路径添加上就可以了
网友评论