CommitLint约束

4.1、背景

• 在提交git信息时，开发者每个人提交的内容格式不一，为约束统一 提交信息规范，在合并、查找、回滚等情况下可以快速定位，让团队内的提交内容更加规范使用 commitlint 约束规范

4.2、什么是commitLint

• commitlint 用来校验你提交的信息是否符合规范，它和commitizen很类似，它们都做一件事，那就是让你提交的信息更规范
• Typicode's blog - Why husky has dropped conventional JS config，哈士奇高版本低版本讲解
• 🐶 husky | 🐶 husky，哈士奇官网

4.3、快速上手

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

# 下载husky 依赖
npx husky install

# 在husky中添加该hook
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
npx husky add .husky/pre-commit "npm run test"

# 在package.json 中添加
"scripts": {
  "prepare": "husky install",
  "test": "eslint --fix && eslint"
}
"commitlint": {
  "extends": "@commitlint/config-conventional"
}

4.4、使用

• 模版格式为：类型冒号空格加内容，例如[type]: xxx
• git commit -m 'feat: xxxx'

# commit type
- build：主要目的是修改项目构建系统(例如 glup，webpack，rollup 的配置等)的提交
- ci：主要目的是修改项目继续集成流程(例如 Travis，Jenkins，GitLab CI，Circle等)的提交
- docs：文档更新
- feat：新增功能
- fix：bug 修复
- perf：性能优化
- refactor：重构代码(既没有新增功能，也没有修复 bug)
- style：不影响程序逻辑的代码修改(修改空白字符，补全缺失的分号等)
- test：新增测试用例或是更新现有测试
- revert：回滚某个更早之前的提交
- chore：不属于以上类型的其他类型

4.5、知识点

v4和>v4的区别

• 在 v4 版本之前 husky的工作方式是这样的：为了能够让用户设置任何类型的git hooks，husky不得不创建所有类型的git hooks
  • 这样做的好处就是无论用户设置什么类型的git hook，husky都能确保其正常运行。但是缺点也是显而易见的，即使用户没有设置任何git hook，husky也向git中添加了所有类型的git hook这样会导致即使没有任何东西可运行，节点也会启动。
  • 2016 年，Git 2.9引进了core.hooksPath，可以设置Git hooks脚本的目录，这个引进也就是新版husky改进的基础：

• 可以使用husky install将git hooks的目录指定为.husky/
  • 使用husky add命令向.husky/中添加hook

• 通过这种方式我们就可以只添加我们需要的git hook，而且所有的脚本都保存在了一个地方（.husky/目录下）
  • 换句话说，当你用新的 husky 创建一个 hook 时，它是纯 shell 的，可以直接访问。Git 和你之间不再有任何关系❤️

运行机制

• 在git 中提供了一种hook 的工具husky，在执行git-commit和git-push阶段可以执行相对于的脚本命令，可以在git 的提交中校验 提交信息的规范性、检查代码、运行测试等。 配合commitlint 可以验证commit 信息的格式模板
• 为什么要在scripts 中添加 prepare？
  • prepare 是 NPM 操作生命周期中的一环，在执行 install 的时候会按生命周期顺序执行相应钩子，当开发者A 配置完husky 后，如果开发者B不执行 husky install 的命令，那么husky 将无法生效，所以需要再install nodeModules 的时候进行husky 的下载
    • NPM7：preinstall -> install -> postinstall -> prepublish -> preprepare -> prepare -> postprepare
• huksy 的hooks 是如何执行的？
  • husky 目前是一个独立的shell，在触发git生命周期的时候，会执行hook 当中的脚本命令，例如npm run test，所以该命令是需要再全局或者项目中进行配置才可以生效