什么是 @commitlint/read？
@commitlint/read 是一个用于 Git 提交信息验证的工具。它可以帮助我们在提交代码时规范化我们的提交信息。
怎么使用 @commitlint/read？
使用 @commitlint/read 很简单，只需按照以下步骤即可。
步骤一：安装和初始化
首先，我们需要在我们的项目中安装 @commitlint/read。我们可以使用以下命令来完成安装：
--- ------- ---------- ------------------------------------------
安装成功后，我们需要初始化 @commitlint/read：
---- --------------- - --------- ------------------------------------- - --------------------
上面的命令将生成一个名为 commitlint.config.js 的文件，这是 @commitlint/read 的配置文件。现在我们已经完成了初始化配置。
步骤二：编写规范的提交信息
现在我们已经完成了 @commitlint/read 的初始化，接下来就是编写规范的提交信息了。为了通过提交信息验证，我们需要遵守以下规则：
- 标题必须以动词开头，使用第一人称现在时，比如：fix，add，update。
- 标题必须控制在 50 个字符以内。
- 描述信息可选，如果需要，使用一个空行分隔标题和描述信息。
- 描述信息必须控制在 72 个字符以内。
使用规范的提交信息可以提高项目的可维护性，也可以有效的协助我们来管理代码变更，并且对于另一个开发者来说也非常友好。
下面是一个规范的提交信息示例：
----- --- --- ------- ---- -- - ----------- ------- ----- --- -- -------- ----- -- ---- ---- ------ ---- ----- - ----- --- -- --- -------
在提交信息中，feat 是一个类型，表示这是一个新功能的提交。随后的 add new feature 是这个提交的主题。在主题下面，我们写了一个用于描述提交的文本块。
步骤三：运行验证
最后，我们需要运行 @commitlint/read 来验证我们的提交信息。在终端中运行以下命令：
---- ------ --- --- -------- - --- ----------
如果您的提交信息符合规范，则命令将返回成功。如果您的提交信息不符合规范，则您将收到一条错误消息。
总结
@commitlint/read 是一个很不错的工具，可以规范化提交信息，提高代码的可维护性，并为协作工作提供了一致的代码变更记录格式。
希望本篇教程能够帮助您更加高效的管理您的代码变更。
参考链接
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/94235