在开发一个团队项目时，代码规范和代码风格的一致性是非常重要的。而在代码版本控制和管理中，commit message 更是起到非常重要的作用。为了规范化项目的 commit message，我们可以使用一个 npm 包——commitlint-config-awesome。
commitlint-config-awesome 是什么?
commitlint-config-awesome 是一个已经定义好的规则配置，它使用 commitlint 这个验证 commit message 规则的工具来保证我们项目中的代码提交信息（commit message）符合一定的规范。commitlint-config-awesome包含了大多数常用的 commit message 规则。比如：模块名、编号、描述、M大写等等。
commitlint-config-awesome 用法
进入你的项目目录，安装 commitlint 和 commitlint-config-awesome 这两个依赖。在终端里输入以下命令：
--- ------- ---------- --------------- ------------------------------- -------------------------
安装好后，我们还需要定义一条 commit message 格式规则。打开 package.json 文件，添加一个 commitlintConfig 属性：
------------------- -
---------- -----------------------------
-commitlint-config-awesome 默认使用了 @commitlint/config-conventional 规则，因此我们不用再次定义。如果你只想使用 commitlint-config-awesome 中的某些规则，也可以自行在该属性中配置。
之后，我们只需要按照配置好的格式来书写 commit message 信息，例如：
--------- ------ --
以上的示例 commit message 包含了以下信息：
- feat(ui)：特性（feature） + 模块名
- 添加登录页面：描述信息
- #1：编号
commit message 格式规范
下面是 commit message 的格式规范：
---------------- ------ ---- ------ ------ ------ ------ ------ --- -----------------
commit message 的各个部分确认含义如下：
- type：必须存在。表示一次提交的类型，常用的有 feat、fix、docs 等。
- scope：表示改动的范围，例如：ui、service、model 等。
- 描述信息：必须存在。简短明了的描述信息，最好不要超过 50 个字符。
- 编号：可选。该次提交对应的 issue 编号。
- 描述信息：可选。对该次提交做详细描述。
结语
commitlint-config-awesome 这个 npm 包的使用方法非常简单，它可以帮助我们统一 commit message 规范，提高项目的开发效率和质量。在实际项目中，我也建议大家使用该 npm 包来规范化我们的 commit message ，让我们的代码更加规范易读，为团队的合作提供支持。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/5eedc5f4b5cbfe1ea0612224