npm 包 @commitlint/config-lerna-scopes 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

在前端项目开发中，代码提交 message 格式的统一性非常重要，而 commitlint 是一个很好的工具帮助我们进行 commit message 格式的检查。@commitlint/config-lerna-scopes 是其中一个配置文件，它可以自动检查 Lerna 维护的多包仓库，确保各个包的提交信息符合规范。本文将详细介绍如何使用该 npm 包。

安装和配置

将 @commitlint/config-lerna-scopes 作为依赖安装到项目中：
```
npm install --save-dev @commitlint/config-lerna-scopes
```
安装 commitlint-config-lerna-scopes 作为默认配置文件
```
npm install --save-dev commitlint-config-lerna-scopes
```
在项目根目录添加 commitlint 配置文件 commitlint.config.js，填写如下内容：

module.exports = {
  extends: ['@commitlint/config-lerna-scopes'],
  rules: {
    // 可以根据需要添加自定义规则
  }
}

使用

在提交代码之前，需要在命令行中使用 git commit 附加-m 参数提交信息。使用 commitlint 来检查我们的提交信息是否符合规范。

提交信息的格式应该如下：

type(scope): message

type: 必须是 commitlint 的支持的一种类型，例如“feat”, “fix”, “docs”等
scope: 必须是 Lerna 二级目录中的某个值，如果存放了多个子目录，则必须对子目录进行分类并添加到 scope 中
message: 必须是所做的修改的简短描述，不超过 50 个字符

以下是一个符合要求的例子：

feat(component-A): add a new feature

如果提交信息不符合要求，则会提示失败，需要按照规范修改后再次提交。

综述

通过以上步骤，您可以使用 @commitlint/config-lerna-scopes npm 包来检查您在 Lerna 维护的多包仓库中的提交信息。这可以大大简化提交信息的管理，提高开发效率。同时，我们也应该注意代码提交的质量和格式，毕竟“好的开始是成功的一半”。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/138905