npm 包 @commitlint/execute-rule 使用教程

阅读时长 3 分钟读完

简介

在前端开发中,版本控制是非常重要的一环。而 Git 是最常用的版本控制工具之一。在 Git 中,每次提交代码时都需要填写自己的 commit message。为了更好地管理提交信息,规范化 commit message 是很有必要的。@commitlint/execute-rule 就是一个在 Git 中规范 commit message 的工具。本文将会介绍 @commitlint/execute-rule 的使用。

安装

我们首先需要安装 @commitlint/execute-rule 这个 npm 包。使用命令行工具在项目根目录下输入以下命令即可完成安装:

配置

完成安装之后,我们需要在项目的根目录下创建一个名为 commitlint.config.js 的文件,并填写以下内容:

-- -------------------- ---- -------
-------------- - -
  ------ -
    ------------ --- --------- -
      ------- ------ ------- -------- ----------- ------- -------- --------
    ---
    -------------------- --- ---------
    --------------- --- --------
  -
-
展开代码

这个配置文件包含了三个 rule,type-enum、subject-full-stop 和 subject-case。

其中,type-enum 规定了提交信息中应包含的 type (分类),如 feat、fix、docs 等。这里我们列举了一些比较常用的 type。always 表示提交信息中必须包含 type,2 表示错误等级为 error。

subject-full-stop 规定了提交信息中不应该包含句号。never 表示不应该包含,0 表示错误等级为 warning。

subject-case 规定了提交信息中 subject (主题)的大小写。never 表示不需要大小写限制,0 表示错误等级为 warning。

当然,你也可以按照自己的需求定义自己的规则。

使用

配置完成之后,我们就可以开始使用 @commitlint/execute-rule。在 Git 提交信息中按照我们规定的格式填写提交信息即可。

这里是一个符合规则的提交信息示例:

如果你想查看 commit message 是否符合规定,可以使用以下命令:

如果有错误,命令行会输出错误信息。如果正确,则不输出任何信息。

总结

@commitlint/execute-rule 可以很好地帮助开发者规范自己的 commit message。这样,当多人协同开发时,可以更加方便地查看每个人的提交记录,了解每个人的代码贡献。同时,也可以更加方便地回滚代码。如果你还没有使用类似的工具,建议你尝试使用它。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/110707