GitHub Actions TypeScript项目迁移至ESM模块的实践指南

前言

随着JavaScript生态系统的演进，ES Modules (ESM) 已成为现代JavaScript开发的标准模块系统。本文将详细介绍如何将一个基于GitHub Actions的TypeScript项目从CommonJS迁移到ESM模块系统，解决迁移过程中遇到的各种技术挑战。

迁移步骤详解

基础配置修改

首先需要在package.json中明确指定模块类型：

{
  "type": "module"
}

这个简单的配置变更将触发一系列后续调整需求。

模块导入路径调整

在ESM模式下，所有相对路径导入必须包含明确的文件扩展名。这意味着需要修改所有.ts文件中的导入语句：

// 修改前
import { run } from './main'

// 修改后
import { run } from './main.js'

ESLint配置优化

为了解决ESLint的模块解析问题，需要安装额外的解析器并调整配置：

1. 安装TypeScript解析器：

npm install -D eslint-import-resolver-typescript

2. 更新ESLint配置：

settings:
  import/resolver:
    typescript:
      alwaysTryTypes: true
      project: './.github/linters/tsconfig.json'

Jest测试框架适配

Jest对ESM的支持需要特殊处理：

1. 安装必要的依赖：

npm install -D ts-jest-resolver

2. 配置Jest使用TypeScript解析器：

{
  "jest": {
    "resolver": "ts-jest-resolver"
  }
}

3. 测试文件中需要显式导入Jest：

import { jest } from '@jest/globals'

模块模拟的特殊处理

在ESM环境下，Jest的模拟机制有所不同：

// 动态导入以确保模拟生效
jest.mock('@actions/core', () => {
  const actual = jest.requireActual('@actions/core')
  return {
    ...actual,
    getInput: jest.fn()
  }
})

const core = await import('@actions/core')

常见问题解决方案

第三方ESM模块集成

当使用如@octokit/graphql等纯ESM模块时，确保：

1. 使用最新版本的依赖
2. 检查依赖的文档是否有特殊的使用说明
3. 在测试中正确模拟这些模块

TypeScript配置调整

可能需要更新tsconfig.json以支持ESM模块解析：

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

最佳实践建议

1. 渐进式迁移：对于大型项目，考虑逐步迁移而非一次性全部转换
2. 版本控制：确保所有团队成员使用相同版本的Node.js和工具链
3. 文档记录：详细记录项目特定的ESM配置，方便新成员快速上手
4. 持续集成：在CI配置中明确指定Node.js版本和必要的实验性标志

结语

将GitHub Actions TypeScript项目迁移到ESM模块系统虽然会面临一些挑战，但通过系统性的配置调整和工具链适配，完全可以实现平滑过渡。本文提供的解决方案已在多个实际项目中验证有效，希望能为开发者提供有价值的参考。随着工具链的不断完善，ESM将成为TypeScript项目更加自然的选择。