在团队协作开发中，代码规范和风格的统一是非常重要的。而在 Git 版本控制中，commit message 的规范化也是同样重要的一环。我们可以通过使用 npm 包 commitlint 来规范化 commit message。
本文将介绍 @weahead/commitlint-config 这个 npm 包的使用方法，帮助读者在团队协作中实现 commit message 规范化。
@weahead/commitlint-config 是什么？
@weahead/commitlint-config 是一个基于 commitlint 的配置库，它提供了一个预设的 commit message 规范。这个规范是团队中多年的沉淀，经过工程师们的实践和总结而来，它可以有效地规范化 commit message，使得团队成员可以更容易地理解和合作。
使用步骤
本模块用法与 commitlint 一致，不同之处仅在于需要将配置项 extends 更改为 @weahead/commitlint-config。
下面将介绍如何使用 @weahead/commitlint-config。
第一步：安装
在你的项目下安装 @weahead/commitlint-config：
npm install --save-dev @weahead/commitlint-config commitlint
第二步：添加配置文件
在你的项目下添加名为 commitlint.config.js 的文件，并写入以下代码：
module.exports = {
extends: ['@weahead/commitlint-config']
};第三步：规范 commit message
当项目中使用了 commitlint 配置并提交 commit message 时，commitlint 会自动检测 commit message 是否符合在上一步声明的规范。
例如：
git commit -m "feat: 添加新特性"
上述 commit message 符合规范，没有问题。如果提交的 commit message 不符合规范，commitlint 会提示错误信息：
git commit -m "添加新特性"
上述 commit message 不符合规范，会提示以下信息：
⧗ input: 添加新特性 ✖ subject may not be empty [subject-empty] ✖ type may not be empty [type-empty] ✖ found 2 problems, 0 warnings ...
提示信息非常友好，很容易就能发现不符合规范的地方。
规范的 commit message
下面介绍 @weahead/commitlint-config 规范的 commit message 的格式。
格式如下：
<type>(<scope>): <subject>
其中，type 和 subject 是必须的，scope 是可选的。
type 是提交的类型，它包括以下 7 种类型：
- feat: 新功能
- fix: 修复问题
- docs: 修改文档
- style: 格式或样式调整
- refactor: 代码重构
- test: 单元测试或集成测试
- chore: 其他杂事
scope 表示本次提交的影响范围，可以省略。下面是几种常见的 scope 写法：
app：表示修改的是与 app 相关的代码docs：表示修改了文档component_name：表示修改了某个具体组件的代码*：表示修改了很多不同的代码.：表示修改了整个项目的代码
subject 是本次提交的简短描述。
下面是一些符合规范的 commit message 的例子：
feat(LoginPage): 新增登录功能 fix(Button): 修复按钮样式问题 docs(README): 更新 README style: 修改样式格式 refactor: 优化代码结构 test(LoginPage): 添加测试用例 chore: 更新依赖
总结
@weahead/commitlint-config 科学而实用，它提供了团队协作开发中非常必要的 commit message 规范。本文通过详细介绍，帮助读者快速上手使用，如果遵循 commit message 规范，势必将提高团队协作效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/110876