conventional-changelog-recommended-bump v10 自定义预设配置指南

conventional-changelog-recommended-bump 是一个用于根据 Git 提交历史自动推荐版本号变更的工具。在 v10 版本中，API 发生了重大变化，特别是关于自定义预设的配置方式。本文将详细介绍如何在 v10 版本中正确配置自定义预设。

新旧版本 API 对比

在 v9 版本中，开发者可以直接通过 options 对象传递完整的配置参数，包括自定义模板和解析选项。这种方式虽然直观，但灵活性不足。

v10 版本采用了更模块化的设计，通过 Bumper 类的链式调用提供了更细粒度的控制。主要变化包括：

1. 移除了直接的 options 参数
2. 引入了 commits()、tag() 和 bump() 方法链
3. 将配置分散到各个方法中

v10 版本配置方法

要使用自定义预设，现在需要通过 Bumper 类的实例方法进行配置：

new Bumper()
  .commits({
    path: '...' // 指定提交路径
  }, parserOpts) // 传递解析选项
  .tag({
    prefix: '...' // 指定标签前缀
  })
  .bump(whatBump) // 执行版本推荐

关键配置项详解

commits() 方法

commits() 方法接受两个参数：

1. 第一个参数是 GetCommitsParams 对象，可以配置：

   • path: 指定要分析的提交路径
   • from: 起始提交
   • to: 结束提交

2. 第二个参数是 parserOpts，用于配置提交信息的解析选项，包括：

   • headerPattern: 提交头部的正则模式
   • breakingHeaderPattern: 破坏性变更的正则模式
   • noteKeywords: 注释关键词
   • revertPattern: 回退模式

tag() 方法

tag() 方法用于配置版本标签相关选项，可以传递：

• prefix: 标签前缀（适用于 monorepo 场景）
• skipUnstable: 是否跳过不稳定版本

bump() 方法

bump() 方法执行实际的版本推荐计算，可以传递 whatBump 函数来自定义推荐逻辑。

实际应用示例

以下是一个完整的配置示例，展示了如何自定义 breakingHeaderPattern：

const bumper = new Bumper();

const result = bumper
  .commits(
    {}, 
    {
      breakingHeaderPattern: /^(\w*)(?:\((.*)\))?!: (.*)$/ // 自定义破坏性变更模式
    }
  )
  .tag({
    prefix: 'pkg-' // 自定义标签前缀
  })
  .bump((commits) => {
    // 自定义版本推荐逻辑
    if (commits.some(commit => commit.notes.some(note => note.title === 'BREAKING CHANGE'))) {
      return { level: 0 }; // 主版本
    }
    return { level: 1 }; // 次版本
  });

迁移建议

从 v9 迁移到 v10 时，建议：

1. 将原来的 options 对象拆解到各个方法中
2. 特别注意 parserOpts 现在作为 commits() 的第二个参数传递
3. 原来的 lernaPackage 配置可以通过 tag() 方法的 prefix 参数实现

通过这种新的配置方式，v10 版本提供了更灵活、更清晰的 API 设计，虽然迁移需要一些工作，但长期来看更易于维护和扩展。