深入解析actions/typescript-action项目中的ESM与Rollup兼容性问题

背景介绍

在GitHub Actions生态系统中，actions/typescript-action是一个广泛使用的TypeScript项目模板。近期该项目进行了重大更新，将代码从CommonJS模块系统迁移到了ESM（ECMAScript Modules）标准，并引入了Rollup作为打包工具。这一变更虽然带来了现代JavaScript开发的优势，但也引发了一些兼容性问题，特别是在Windows环境下运行时出现的"require is not defined"错误。

问题本质分析

当项目从CommonJS迁移到ESM后，最大的变化之一就是移除了对require函数的原生支持。在ESM规范中，模块导入必须使用import语法。然而，项目中仍然存在一些依赖（如@actions/glob）及其子依赖（如minimatch）继续使用CommonJS风格的require语句。

Rollup在打包过程中会尝试将这些require调用转换为静态导入，但由于Windows系统的路径处理特殊性，当这些转换后的代码在Windows环境下执行时，就会出现"require is not defined"的错误。

技术细节剖析

Rollup的转换机制

Rollup通过@rollup/plugin-commonjs插件处理CommonJS模块。默认情况下，该插件会将require语句包裹在try-catch块中，例如：

try {
  const crypto = require('node:crypto');
  random = (max) => crypto.randomInt(0, max);
} catch {
  random = (max) => Math.floor(Math.random(max));
}

这种处理方式理论上提供了回退机制，但实际上在纯ESM环境中，require函数根本不存在，导致try块必定失败。

Windows环境下的特殊问题

问题在Windows环境下尤为突出，因为一个关键依赖minimatch的旧版本中包含如下代码：

var path = (function () { 
  try { return require('path') } 
  catch (e) {}
})() || {
  sep: '/'
};

在Windows系统中，路径分隔符应为反斜杠\，而上述代码的回退值却是正斜杠/，这导致了路径处理错误。

解决方案探讨

临时解决方案

目前可行的临时解决方案是通过package.json的overrides字段强制使用更新版本的minimatch：

{
  "overrides": {
    "@actions/glob": {
      "minimatch": "^10.0.1"
    }
  }
}

这个方案可以解决立即的问题，但需要等待@actions/toolkit官方更新其依赖关系。

Rollup配置调整

另一个探索方向是调整Rollup配置，通过设置ignoreTryCatch: false来避免生成包含require的try-catch块：

commonjs({ ignoreTryCatch: false })

这种配置会强制Rollup将require调用完全转换为静态导入，但需要注意这可能导致导入语句被提升到文件顶部，超出原有的try-catch作用域。

最佳实践建议

1. 依赖管理：定期检查并更新项目依赖，特别是那些仍然使用CommonJS规范的库。

2. 跨平台测试：在Windows环境下充分测试ESM模块的兼容性，确保路径处理等平台相关功能正常工作。

3. 渐进式迁移：对于大型项目，考虑采用渐进式迁移策略，逐步替换或更新依赖项。

4. 回退机制：在必须使用require的场景下，确保提供可靠的跨平台回退方案。

总结

actions/typescript-action项目向ESM的迁移代表了JavaScript生态系统的演进方向，但同时也带来了兼容性挑战。通过理解Rollup的转换机制和Windows环境的特殊性，开发者可以更好地应对这些挑战。随着生态系统的成熟和相关依赖的更新，这些问题将逐步得到解决。在此期间，采用适当的临时解决方案和配置调整可以帮助项目平稳过渡。