在TypeScript中使用conventional-recommended-bump的正确方式

conventional-recommended-bump是一个基于约定式提交规范自动推荐版本号变更类型的工具，它能够分析Git提交历史并给出符合语义化版本控制(SemVer)的版本升级建议。本文将详细介绍如何在TypeScript项目中正确使用这个工具。

常见问题分析

许多开发者在TypeScript环境中使用conventional-recommended-bump时会遇到两个典型问题：

1. 模块导入错误：当尝试通过TypeScript导入时，系统提示"exports未定义"的错误
2. 函数调用异常：执行时出现"whatBump不是函数"的错误提示

这些问题通常源于对工具使用方式的理解不足或配置不当。

正确配置方案

1. 安装必要依赖

首先需要安装核心包和相应的预设配置：

npm install conventional-recommended-bump conventional-changelog-angular

2. TypeScript配置要点

确保你的TypeScript配置支持ES模块：

{
  "compilerOptions": {
    "module": "ESNext",
    "moduleResolution": "NodeNext"
  }
}

3. 实现代码示例

以下是完整的TypeScript实现示例：

import { Bumper } from 'conventional-recommended-bump';

async function getVersionRecommendation() {
  try {
    const bumper = new Bumper();
    await bumper.loadPreset('angular');
    const result = await bumper.bump();
    
    console.log('建议版本变更类型:', result.releaseType);
    console.log('原因:', result.reason);
    
    return result;
  } catch (error) {
    console.error('获取版本推荐失败:', error);
    throw error;
  }
}

getVersionRecommendation();

工作原理解析

conventional-recommended-bump的核心工作流程如下：

1. 加载预设：通过loadPreset方法加载特定的提交约定规范（如angular）
2. 分析提交历史：工具会扫描Git仓库的提交信息
3. 应用规则：根据预设中的whatBump函数确定版本变更类型
4. 返回建议：最终输出releaseType（major/minor/patch）和变更原因

高级用法

自定义分析规则

你可以覆盖预设中的whatBump函数来实现自定义版本控制策略：

const customWhatBump = (commits) => {
  // 实现自定义分析逻辑
  return {
    level: 2, // 0=patch, 1=minor, 2=major
    reason: '包含破坏性变更'
  };
};

bumper.bump({ whatBump: customWhatBump });

多包管理场景

在monorepo项目中，可以结合工具分析特定子包的变更：

import { promises as fs } from 'fs';

async function getPackageVersion(packagePath: string) {
  const pkg = JSON.parse(await fs.readFile(`${packagePath}/package.json`, 'utf-8'));
  return pkg.version;
}

最佳实践建议

1. 统一提交规范：确保团队遵循相同的提交消息格式
2. CI集成：将版本推荐作为CI流程的一部分
3. 版本策略文档化：记录团队约定的版本控制规则
4. 异常处理：对工具可能抛出的错误进行适当处理

通过正确配置和使用conventional-recommended-bump，团队可以实现自动化、规范化的版本管理流程，减少人为错误，提高发布效率。