Git commit代码规范校验

---

为什么要对git 进行代码规范校验？

在团队协作开发中，遵循一致的代码提交规范是至关重要的。Git commit规范可以帮助团队成员更好地理解每个提交所做的更改，提高代码可读性和维护性。

如何进行代码规范校验？

需要用到两个工具：husky 和 commitlint

Husky

Husky是一个可以让我们使用Git hooks的工具，通过配置pre-commit钩子函数，在代码提交前执行自定义的脚本。它使得我们能够在提交代码之前运行一系列命令，从而实现对代码规范的强制校验。

使用方法：

1. 将husky添加到项目的开发依赖中

npm install -D husky

2. 在packgae.json中添加prepare脚本

{
 "scripts": {
   "prepare": "husky install"
 }
}

prepare脚本会在npm install（不带参数）之后自动执行。也就是说当我们执行npm install安装完项目依赖后会执行 husky install命令，该命令会创建.husky/目录并指定该目录为git hooks所在的目录。

3. 在commit-msg里配置对提交信息进行校验，直接执行命令行：npx husky add .husky/commit-msg ‘npx --no-install commitlint --edit “$1”’

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx --no-install commitlint --edit "$1"

Commitlint

Commitlint是一个用于Git提交信息规范校验的工具。它可以让开发者遵循一致的提交信息格式，如约定的commit message格式。

使用方法：

1. 安装commitlint及其插件

npm install @commitlint/cli @commitlint/config-conventional --save-dev

2. 在根目录下创建commitlint.config.js文件，并添加以下配置：

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

完成这两步之后就可以实现使用commitlint对git的commit操作进行标准化的默认校验，默认校验规则可以自行查阅commitlint的官方文档，这里不做具体介绍。