GitHub Actions TypeScript模板中实现前后置脚本的最佳实践

背景介绍

在GitHub Actions的TypeScript项目开发中，开发者经常需要实现一些前置准备或后置清理的逻辑。标准的TypeScript Action模板默认只支持单个入口文件，这在实际开发中往往无法满足复杂场景的需求。

问题分析

传统解决方案是通过修改package.json中的构建脚本，为每个钩子单独配置构建命令。这种方法虽然可行，但会导致严重的代码重复问题。例如，当同时构建主脚本和后置脚本时，最终生成的dist目录中会出现两份几乎完全相同的代码，这不仅增加了包体积，也降低了构建效率。

技术方案对比

NCC构建方案

使用@vercel/ncc工具的传统构建方式存在明显缺陷：

1. 每个脚本需要独立构建命令
2. 生成的代码存在大量重复
3. 构建配置复杂且难以维护

Rollup替代方案

相比NCC，Rollup提供了更优雅的解决方案：

1. 支持多入口配置
2. 自动处理依赖共享
3. 生成代码更加精简
4. 构建配置更加清晰

实现建议

1. 项目结构调整：建议将不同阶段的逻辑拆分到单独的TS文件中，如main.ts、pre.ts和post.ts。

2. Rollup配置：使用Rollup的多入口配置能力，确保公共依赖只打包一次。典型配置应包括：

   • 明确指定各入口文件
   • 配置输出格式为CommonJS
   • 设置正确的输出目录结构

3. 类型声明处理：由于Rollup对声明文件处理较为严格，建议暂时关闭声明映射功能，待后续工具链完善后再考虑添加。

注意事项

1. 本地测试时，前置钩子(pre)可能无法正常工作，这是GitHub Actions本身的限制。

2. 构建过程中要注意处理许可证文件等资源文件的复制。

3. 对于复杂的依赖关系，可能需要额外配置Rollup插件来处理特殊情况。

总结

对于需要多阶段执行的GitHub Actions TypeScript项目，推荐使用Rollup替代NCC作为构建工具。这种方案不仅能解决代码重复问题，还能提供更清晰的构建配置和更优化的输出结果。随着GitHub Actions对ESM支持程度的提高，未来这类构建方案将会更加完善。

开发者在实际实施时，应根据项目具体需求选择合适的构建策略，并注意测试各阶段的执行情况，确保Action的整体可靠性。