Changesets项目中TypeScript变更日志格式化器的实现挑战

背景介绍

Changesets是一个流行的版本控制和变更管理工具，它允许开发者通过定义变更集(changeset)来管理项目版本更新和变更日志生成。在项目中，开发者可以自定义变更日志的格式以满足特定需求。

问题描述

许多开发者尝试按照官方文档实现TypeScript格式的变更日志格式化器时遇到了困难。典型的实现方式是通过创建一个TypeScript文件来覆盖默认的格式化行为，例如修改getReleaseLine方法以排除提交SHA信息。

然而，当开发者配置好changelog路径指向.ts文件并运行changeset version命令时，会遇到"Cannot use import statement outside a module"的错误。这表明Changesets默认不支持直接使用TypeScript编写的格式化器。

解决方案分析

1. 使用JSDoc注释的JavaScript方案

对于需要类型提示但不想处理TypeScript编译的开发者，可以采用纯JavaScript配合JSDoc注释的方案：

/** @type {import('@changesets/types').GetReleaseLine} */
async function getReleaseLine(changesets, type, changelogOpts) {
  return '自定义格式内容'
}
 
/** @type {import('@changesets/types').GetDependencyReleaseLine} */
async function getDependencyReleaseLine(changesets, dependenciesUpdated) {
  return '依赖更新内容'
}

module.exports = {
  getReleaseLine,
  getDependencyReleaseLine
}

这种方法既保持了代码的简洁性，又能在支持JSDoc的编辑器中获得类型提示。

2. TypeScript转译代理方案

对于坚持使用TypeScript的开发者，可以通过创建一个代理文件来间接加载TypeScript格式化器：

// changelog-formatter-proxy.js
require("tsx/cjs");
require("./changelog-formatter.ts");

然后在changeset配置中指向这个代理文件。这种方法利用了tsx等工具在运行时转译TypeScript代码的能力。

技术决策考量

Changesets维护团队明确表示不会内置对TypeScript格式化器的支持，这一决策基于以下考虑：

1. 工具复杂度：支持TypeScript需要引入额外的转译工具(Babel/SWC/esbuild等)，增加项目复杂度和维护负担。

2. 依赖管理：不同转译工具的版本兼容性问题可能导致难以预料的行为。

3. 包体积：转译工具的加入会显著增加安装包的大小。

4. 维护成本：作为开源项目，维护者需要平衡功能丰富性和维护可持续性。

最佳实践建议

1. 对于简单定制，优先考虑使用JavaScript+JSDoc方案
2. 复杂逻辑确实需要TypeScript时，采用代理文件模式
3. 保持格式化器代码简洁，避免复杂依赖
4. 在团队内部文档中记录自定义格式化器的实现方式

总结

虽然Changesets不直接支持TypeScript格式的变更日志格式化器，但开发者仍有多种方式实现类型安全的自定义格式化。理解工具的设计哲学和限制条件，选择适合项目需求的解决方案，是有效使用Changesets的关键。