什么是 commitlint-config-yemiancheng
commitlint-config-yemiancheng 是一款基于 commitlint 的 npm 包，它提供了一套与前端技术相关的默认配置规则，帮助开发者在项目中使用更加规范的 commit message，从而提高代码质量和团队协作效率。
如何安装和使用 commitlint-config-yemiancheng
首先，在项目中安装 commitlint 和 commitlint-config-yemiancheng：
npm install --save-dev @commitlint/cli commitlint-config-yemiancheng
安装完成后，在项目的根目录下新建一个 .commitlintrc.js 文件，然后将以下代码添加到文件中：
module.exports = {
extends: ['yemiancheng'],
};通过上面的配置，我们将 commitlint-config-yemiancheng 作为了我们的规则集，后面的 yemiancheng 就是 npm 包的名称，也就是我们下面要介绍的具体规则配置。
最后，在 package.json 中添加以下命令：
{
"scripts": {
"commitmsg": "commitlint -e"
}
}通过这个命令，我们可以在每次 git commit 的时候自动校验 commit message 是否符合规范。
commitlint-config-yemiancheng 默认的规则配置
在上面的部分中，我们将 commitlint-config-yemiancheng 添加到了项目的配置文件中。那么它具体定义了哪些规则呢？下面是一些主要规则的详细介绍。
type-enum 规则
这个规则定义了 commit message 的第一个字段（也就是 type）必须是以下之一：
- feat：新功能
- fix：修复 bug
- docs：文档改动
- style：样式相关的改动（如空格、tab、格式化等）
- refactor：重构代码
- perf：性能相关的优化
- test：测试相关的改动
- build：构建相关的改动
- ci：持续集成相关的改动
- chore：其他不属于上述类型的改动
下面是示例代码：
-- -------------------- ---- ------- ----- --- --- ------- ---- --- - --- ----- ------ ------------- ------ --- - ---------- ----- --------- -------- ---- ----- ------- ----------- ----- --- ---- ----- ------ ------ ----- ------ --- ------ -- ------ ------ ------ --------- ----
subject-max-length 规则
这个规则定义了 commit message 的第二个字段（也就是 subject）的最大长度为 50 个字符。这个限制有助于保持信息的简洁性。
subject-case 规则
这个规则定义了 commit message 的第二个字段（也就是 subject）必须为小写字母。
body-max-line-length 规则
这个规则定义了 commit message 的第三个字段（也就是 body）的每行最大长度为 72 个字符。这个限制有助于保持信息的可读性。
footer-max-line-length 规则
这个规则定义了 commit message 的第四个字段（也就是 footer）的每行最大长度为 72 个字符。这个限制同样有助于保持信息的可读性。
总结
Commit Message 质量的高低，直接关系到代码库的可读性和可维护性。通过使用 commitlint-config-yemiancheng ，我们可以规范与我们前端技术相关的 commit message，使得团队协作更加高效，代码质量也会得到有效的提升。
如果你有类似的需求，可以试试 commitlint-config-yemiancheng ，相信它会为你的项目带来不错的效果。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6006733d890c4f7277583572