Yarn Berry 中 Git 依赖包的 prepack 脚本执行问题解析

问题背景

在使用 Yarn Berry 包管理器时，开发者发现从 Git 仓库安装的依赖包没有执行预定义的 prepack 脚本。prepack 脚本是 Yarn 生命周期脚本的一部分，按照文档说明，它应该在 yarn pack 命令执行时自动运行，而 yarn pack 又会在从 Git 安装依赖时被调用。

技术细节分析

1. prepack 脚本的作用
   prepack 是 Yarn 包生命周期中的一个重要阶段，主要用于在打包前执行必要的构建步骤。典型用例包括：

   • 编译 TypeScript 代码
   • 生成文档
   • 运行测试确保打包前的代码质量

2. Git 依赖的特殊性
   当从 Git 仓库安装依赖时，Yarn 会执行以下流程：

   • 克隆仓库
   • 运行 yarn pack 创建压缩包
   • 将压缩包安装到项目中 理论上，这个过程应该触发 prepack 脚本的执行。

3. 空目录处理机制
   通过深入分析发现，Yarn 和 npm 的打包机制有一个共同特点：它们不会将空目录包含在最终的压缩包中。这意味着如果 prepack 脚本只创建目录而不生成文件，这些目录不会出现在安装后的依赖中。

解决方案验证

1. 有效 prepack 脚本示例
   确保 prepack 脚本不仅创建目录，还要在其中生成至少一个文件：

   {
     "scripts": {
       "prepack": "mkdir -p dist && echo '构建成功' > dist/build.txt"
     }
   }
   

2. 实际案例验证
   在 react-native-google-auth 库的实际测试中，虽然开发者最初认为 prepack 没有执行，但详细检查后发现：

   • lib 目录及其内容确实被正确生成
   • 这些构建产物被包含在了最终的安装包中 这表明 prepack 脚本确实被执行了，只是由于对打包机制的理解不足导致了误判。

最佳实践建议

1. 明确构建输出
   在 prepack 脚本中确保生成可见的文件输出，便于验证脚本是否执行。

2. 调试技巧
   可以通过以下方式调试 prepack 问题：

   • 在脚本中添加日志输出
   • 使用 yarn pack --dry-run 预览打包内容
   • 检查 .yarn/cache 中的压缩包内容

3. 跨平台兼容性
   考虑到 Windows 和其他操作系统的差异，建议使用跨平台的脚本命令，或者通过 cross-env 等工具确保一致性。

总结

Yarn Berry 在处理 Git 依赖时确实会执行 prepack 脚本，但开发者需要注意打包机制的特殊性。理解这些底层行为有助于更有效地利用 Yarn 的生命周期脚本，确保构建流程的可靠性。对于复杂的构建需求，建议结合 Yarn 的工作区功能和现代构建工具来实现更精细的控制。