在conventional-changelog中扩展提交信息的技术实践

conventional-changelog是一个流行的生成变更日志的工具，它遵循约定式提交规范。在实际项目开发中，我们经常需要扩展默认的提交信息，比如添加GitHub用户登录名等额外信息。本文将详细介绍如何在conventional-changelog中实现这一需求。

问题背景

在Lerna-Lite项目中，开发者需要从GitHub GraphQL API获取提交信息，并将GitHub用户登录名添加到变更日志中。在conventional-changelog的旧版本中，可以通过修改writerOpts.commitPartial和transform函数来实现这一需求。但随着版本升级，提交对象变为不可变，原有的扩展方式不再适用。

技术实现方案

核心思路

1. 保留原始transform函数的引用
2. 执行原始transform函数获取处理后的提交对象
3. 扩展提交对象，添加自定义属性
4. 返回扩展后的提交对象

具体实现代码

// 获取预设配置
const preset = 'conventional-changelog-conventionalcommits';
const config = await getChangelogConfig(preset, rootPath);

// 覆盖writerOpts的transform函数
// 保留原始transform函数引用，先执行原始函数再执行自定义扩展
const originalTransform = config.writer?.transform;
writerOpts.transform = (commit, context, options) => {
    // 执行原始transform函数
    const transCommit = originalTransform?.(commit, context, options) || null;

    // 添加自定义属性（如用户登录名）
    if (transCommit) {
        return { ...transCommit, userLogin: 'user1' };
    }
    return transCommit;
};

// 生成变更日志
const changelogStream = conventionalChangelogCore(
    options,
    context,
    gitRawCommitsOpts,
    undefined,
    writerOpts
);

关键点解析

1. 版本兼容性：conventional-changelog-writer v10存在不终止的问题，建议使用v11及以上版本。

2. transform函数位置：自定义transform函数需要设置在writerOpts（第三个参数）中，而不是conventionalChangelogCore的第一个参数。

3. 执行顺序：必须先执行原始transform函数，再执行自定义扩展逻辑，确保预设的所有转换都已应用。

4. 不可变对象处理：通过对象展开运算符(...)创建新对象，避免直接修改原始提交对象。

实际应用效果

通过上述方法，可以在变更日志中显示扩展后的提交信息，例如：

feat: 添加新功能 (@user1)
fix: 修复某个bug (@user2)

这种格式既保持了约定式提交的规范性，又增加了开发者识别信息，提高了变更日志的可读性和实用性。

总结

在conventional-changelog中扩展提交信息需要理解其处理流程和版本差异。关键在于正确处理transform函数的执行顺序和不可变对象的扩展方式。本文介绍的方法不仅适用于添加GitHub用户信息，也可以应用于其他需要扩展提交信息的场景，具有很好的通用性和实用性。