在前端开发中，代码质量和规范性非常重要。为了保证代码风格的一致性，我们可以使用一些工具来进行自动校验。其中，一个叫做 commitlint 的 npm 包可以帮助我们规范我们的 Git 提交信息。
安装
首先，我们需要全局安装 commitlint：
npm install -g @commitlint/cli
然后，在项目目录下安装 commitlint 配置文件：
npm install --save-dev @commitlint/config-conventional
配置
在项目根目录下创建 .commitlintrc.js 文件，并添加以下内容：
module.exports = {
extends: ['@commitlint/config-conventional']
};这里我们使用了 @commitlint/config-conventional 这个配置文件，它是 commitlint 内置的一种配置方式，可以用于基本的规则校验。
使用
现在，当你提交 Git 提交信息时，commitlint 会自动检测你的提交信息是否符合规范。
比如，如果你的提交信息不符合规范，会得到以下提示：
❯ git commit -m "test" ⧗ input: test ✖ subject may not be empty [subject-empty] ✖ type may not be empty [type-empty] ✖ 2 problems (2 errors, 0 warnings)
错误信息告诉我们，提交信息的主题不能为空，提交类型也不能为空。
下面是一些常用的提交类型和规范：
feat：新功能fix：修复问题docs：文档更新style：代码格式化、缺少分号等refactor：重构代码，没有新增功能或修复问题test：添加或修改测试代码chore：改变构建流程、工具、依赖库等
如果你需要自定义规范，可以在 .commitlintrc.js 中添加自己的校验规则。详细的配置方式可以参考官方文档。
示例代码
-- -------------------- ---- -------
-- ----------------
-------------- - -
-------- ------------------------------------
------ -
------------ --- --------- -------- ------ ------- -------- ----------- ------- ----------
-------------------- --- --------- ---
-
--这里我们增加了两个自定义的规则：
type-enum：强制提交类型必须是指定的几种之一。header-max-length：限制提交信息的主题长度不能超过 72 个字符。
总结
通过 commitlint，我们可以规范我们的 Git 提交信息，并保证代码仓库中的提交信息风格统一。当我们团队协作时，这个工具显得尤为重要。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/42901