简介
在开发过程中，我们通常使用版本控制工具来管理我们的代码，比如 Git。而 Git 重要的一个功能就是能够让我们提交 commit 来记录我们每一次对代码的修改。那么如何规范化我们的 commit 格式，让不同的开发人员都能够在阅读 commit 信息时快速了解到该次修改内容呢？
在实际的开发中，通常我们需要遵循一定的规范来书写 commit message，比如 Angular 的规范 或者 Conventional Commits 规范。这样做的好处在于可以让 commit 信息更加清晰、易于阅读，同时也方便了版本发布、CHANGELOG 自动生成等操作。
而 @commitlint/travis-cli 就提供了一个用于验证 commit message 格式的工具。
安装
可以使用 npm 进行安装，命令如下：
npm install @commitlint/travis-cli --save-dev
使用
首先，在项目根目录下创建 commitlint.config.js 文件，并编写 commit message 格式校验规则，示例代码如下：
module.exports = {
extends: ['@commitlint/config-conventional'],
rules: {
'scope-enum': [2, 'always', ['core', 'cli', 'docs', 'test']]
}
}在这个示例中，我们引用了 @commitlint/config-conventional 包，它提供了 Conventional Commits 规范下的校验规则。我们也可以自定义校验规则，比如在这个示例中，我们自定义了规则 scope-enum，该规则指定了 commit message 的 scope 值只能为 'core'、'cli'、'docs' 或 'test' 中的一个。
接下来，在项目的 package.json 文件中添加 precommit 钩子，用于在提交 commit message 时进行校验。我们可以通过 husky 来安装 precommit 钩子，命令如下：
npx husky install
添加 precommit 配置：
{
"husky": {
"hooks": {
"pre-commit": "commitlint-travis"
}
}
}在执行 git commit 命令时，commitlint-travis 会对 commit message 进行校验，根据校验结果返回相应的状态码。
如果需要排除某些文件或目录的 commit message 格式校验，可以在根目录下创建 .commitlintrc.js 文件，并配置 exclude 属性，示例代码如下：
module.exports = {
extends: ['@commitlint/config-conventional'],
rules: {
'scope-enum': [2, 'always', ['core', 'cli', 'docs', 'test']]
},
excludes: ['dist/**/*']
};在这个示例中，我们指定了 dist 目录下的所有文件不进行 commit message 格式校验。
总结
@commitlint/travis-cli 是一个用于验证 commit message 格式的工具，它可以帮助我们规范化 commit message，并且可以方便版本发布、CHANGELOG 自动生成等操作。本篇文章通过介绍 @commitlint/travis-cli 的安装和使用，希望可以帮助读者更好地使用该工具来提高自己的开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/110789