Conventional Changelog Writer 中自定义 transform 函数的正确用法

在 Conventional Changelog 生态系统中，conventional-changelog-writer 是一个核心组件，负责将提交信息转换为可读的变更日志格式。近期版本中，该组件对 transform 函数的行为进行了重要调整，开发者需要特别注意新的使用方式。

问题背景

在之前的版本中，开发者可以通过 writerOpts 中的 transform 函数直接修改提交对象（commit object）的属性。然而，最新版本中提交对象被设计为不可变（immutable）对象，直接修改属性会抛出"Cannot modify immutable object"错误。

解决方案

正确的做法是让 transform 函数返回一个新的对象，而不是直接修改传入的提交对象。这个新对象可以包含你想要修改的任何属性，且不需要包含原始提交对象的所有属性。

实现示例

以下是 transform 函数的正确实现方式：

module.exports = {
  writerOpts: {
    transform: (commit, context) => {
      // 返回新对象而不是修改原对象
      return {
        ...commit,
        header: `自定义前缀: ${commit.header}`,
        type: commit.type.toUpperCase()
      };
    }
  }
}

关键点说明

1. 不可变设计：新版本采用不可变对象设计模式，提高了代码的可靠性和可预测性。

2. 部分更新：返回的对象可以只包含需要修改的属性，其他属性会保持原样。

3. 性能考虑：虽然每次都要创建新对象，但现代JavaScript引擎对此有很好的优化。

最佳实践

1. 总是返回新对象而不是修改原对象
2. 使用展开运算符(...)来保留不需要修改的属性
3. 可以在transform中进行复杂的逻辑处理，但保持函数纯净

这种改变符合现代JavaScript的函数式编程趋势，虽然需要调整使用习惯，但能带来更好的代码可维护性和更少的副作用。