lerna 配置发布时 commitlint,提交信息

发布时间 2023-08-22 19:49:08作者: optre

要在 Lerna 配置中添加发布时的 commitlint,你可以按照以下步骤进行操作:

  1. 首先,确保你已经在项目中安装了 commitlint。你可以使用以下命令进行安装:

    npm install --save-dev @commitlint/cli @commitlint/config-conventional
    
  2. 在你的 Lerna 项目的根目录下创建一个名为 .commitlintrc.js 的文件,并将以下内容添加到文件中:

    module.exports = {
      extends: ['@commitlint/config-conventional'],
    };
    

    这里使用了 @commitlint/config-conventional,它是一个常用的规范配置,但你也可以根据自己的需求进行定制。

  3. lerna.json 文件中添加一个 command 字段来指定发布时的命令,在该命令中使用 commitlint 检查提交信息。例如:

    {
      "version": "1.0.0",
      "command": {
        "publish": {
          "ignoreChanges": ["**/*.md"],
          "message": "chore(release): publish",
          "conventionalCommits": true,
          "exec": "npx commitlint --from $LERNA_PACKAGE_NAME"
        }
      },
      ...
    }
    

    在上面的例子中,command.publish.exec 字段设置为 npx commitlint --from $LERNA_PACKAGE_NAME,这将运行 commitlint 命令来检查提交信息。$LERNA_PACKAGE_NAME 是一个环境变量,它会被替换为当前正在发布的包的名称。

  4. 最后,当你使用 lerna publish 命令发布时,将会自动执行 commitlint 检查提交信息是否符合规范。如果不符合规范,发布操作将会被中止,并显示相应的错误信息。

这样,你就可以在 Lerna 配置的发布过程中应用 commitlint 来检查提交信息了。记得根据实际需求进行调整和定制。