关于husky:使用husky-commitlint检查提交描述

应用 husky + commitlint 查看提交形容

在团队合作开发中，良好的代码提交形容能够进步代码的可读性、维护性和版本控制。然而，因为集体习惯差别较大，代码提交形容往往难以对立标准，这时候应用工具来查看提交形容就十分必要了。本文将介绍如何应用 husky 与 commitlint 来查看代码提交形容的规范性。

1：装置 husky

Husky是一个能够用来治理 .git/hooks/ 目录下钩子脚本的工具。它能够在 git 的某些动作（如提交或合并等）之前执行咱们定义的脚本，从而能够帮忙咱们更好地控制代码品质。装置 husky 最简略的办法是通过 npm：

npm install husky --save-dev

2：装置 commitlint

Commitlint是一个用于校验提交信息格式的工具，它会依据预设规定进行查看，如果不合乎规定，则会提醒错误信息。同样，通过 npm 装置 commitlint 也十分不便：

npm install @commitlint/{config-conventional,cli} --save-dev

3：创立 commitlint 配置文件

为了让 commitlint 晓得要应用哪些规定来查看提交信息，咱们须要创立一个 .commitlintrc.js 文件，并增加以下内容：

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

这里咱们应用了一个预设的规定集，即 config-conventional。这个规定集比拟罕用，它会查看提交信息的格局是否合乎Angular 格调的约定，例如：

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

其中，type示意提交类型，如 feat、fix、docs 等；scope示意作用域，能够是任意字符串；description示意简短的形容信息，应该尽量精简但又不失清晰；body 示意具体的形容信息，能够省略；footer示意一些附加信息，如 issue 号码、关联的 MR 等。

4：增加 husky 和 commitlint 钩子

咱们须要在 package.json 文件中增加以下配置：

{
  "husky": {
    "hooks": {"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"}
  }
}

这样，每次执行提交操作时，husky都会主动调用 commitlint 来查看提交信息。

5：测试

当初，咱们能够开始测试成果了。为了测试，能够先在 git 仓库中创立一个新的分支，并进行一些随便的批改。而后，执行以下命令提交代码：

git commit -m "this is an invalid commit message"

如果提交信息不合乎规定，则会提醒以下错误信息：

⧗   input: this is an invalid commit message
✖   subject may not be empty [subject-empty]
✖   type may not be empty [type-empty]

这阐明提交信息不符合规范，须要进行批改。

总结

在本文中，咱们介绍了如何应用 husky 和commitlint来查看代码提交形容的规范性。应用这种形式能够帮忙开发人员更好地控制代码品质，进步团队合作效率。