本教程将详细介绍如何使用 npm 包 @commitlint/core 来规范你的代码提交信息。本文将会从以下几个方面探讨：
- 什么是 @commitlint/core？
- 安装和配置 @commitlint/core
- 使用 @commitlint/core 规范代码提交信息
- 实战示例展示
什么是 @commitlint/core？
在开发过程中，我们需要提交很多代码变更。而代码提交信息通常包含了相关变更的详细信息，而每个团队有着规范化的提交信息的发布方式。针对这个问题，社区开发了一个名为 @commitlint/core 的 npm 包。
@commitlint/core 是用于检查代码修改日志信息的工具，它可以帮助开发者检查代码提交信息是否符合团队规范，从而提高团队协作效率，减少提交信息错误等问题。
安装和配置 @commitlint/core
在开始使用 @commitlint/core 之前，需要在项目中安装和配置它：
在项目中，通过 npm 安装 @commitlint/core：
npm install @commitlint/core --save-dev
在项目中，新建 .commitlintrc.js 文件，该文件用于定义提交信息规范。接下来，将要进行详细配置。
module.exports = {
rules: {
'type-enum': [2, 'always', ['feat', 'fix', 'docs', 'style', 'refactor', 'test', 'revert']],
'subject-full-stop': [0, 'never'],
'subject-case': [0, 'never']
}
};上述代码实现了以下规范：
- 提交信息的开头必须是 feature、fix、docs、style、refactor、test、revert 中的一项
- 提交信息描述结束时不需要添加句号
- 提交信息描述中不需要使用首字母大写
当然，你可以按照团队的规范进行自定义配置。
使用 @commitlint/core 规范代码提交信息
现在你已经安装和配置好了 @commitlint/core，接下来，你可以使用 commitlint 进行规范代码的提交。
在使用 commitlint 前，需要先确保你的 Git 环境正常工作。
$ git init $ echo 'foo' > foo $ git add foo $ git commit -m 'foo'
以上命令将在你的项目中初始化 git 环境，并向 git 中提交一个 commit。
实战示例展示
假设你有一个名为 foo 的项目，你已经按照上述步骤安装和配置好了 @commitlint/core，现在你需要创建一个新的提交。
git commit -m "修改比例计算"
此时，你会发现 commitlint 抛出了一个错误提示：
⧗ input: 修改比例计算 ✖ subject may not be empty [subject-empty]
此时，你需要修改提交信息中的有关描述，改为符合项目规范的格式，例如：
git commit -m "feat: 增加比例计算的功能"
此时，你会发现 commitlint 不再抛出错误提示，说明你已经成功通过了规范的提交信息。
除此之外，你还可以通过以上语法检查每个提交信息是否符合团队规范。
总结
本篇文章详细介绍了 @commitlint/core 的使用方法，让你可以更好地规范代码提交信息，提高团队效率，减少代码提交信息错误等问题。使用 commitlint 还可以结合 husky 等工具来使得提交信息更加规范化，从而更好地协作工作。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/110693