Pnpm 魔坑大揭秘：当你的代码不执行 Pre/Post-Scripts
2023-12-04 11:39:13
Pnpm 的隐形坑：Electron 开发者的噩梦
作为一种高速、高效的包管理工具，Pnpm 在开发者群体中备受推崇。然而，它的光鲜外表下却潜藏着 "默认不执行 Pre/Post-Scripts" 的隐形坑，这对于 Electron 桌面应用开发者来说尤为致命。
什么是 Pre/Post-Scripts？
Pre/Post-Scripts 是在安装或卸载依赖包时执行特定任务的脚本。它们通常用于编译代码、运行测试、生成文档或优化构建。这些脚本在软件开发中扮演着至关重要的角色。
Pnpm 的隐形坑
默认情况下，Pnpm 不会自动执行这些脚本。这意味着，如果在 package.json 文件中配置了 Pre/Post-Scripts，它们将不会被触发。这会导致一系列问题，包括依赖包无法正常安装、代码无法编译、测试无法运行、文档无法生成以及构建无法优化。
对于 Electron 开发者的痛点
对于 Electron 桌面应用开发者来说，Pnpm 的这个坑尤其危险。Electron 依赖于各种依赖包，包括 Electron 本身、Electron 模块、前端框架和库以及后端服务。如果不执行 Pre/Post-Scripts，可能会导致 Electron 无法正常安装、Electron 模块无法加载、前端框架和库无法使用以及后端服务无法启动。
踩坑实例
笔者曾在开发 Electron 桌面应用时不幸踩到了这个坑。当时，package.json 文件中配置了用于编译代码和运行测试的 Pre/Post-Scripts。但是，在使用 Pnpm 安装依赖包时，这些脚本并没有被触发。结果，代码无法编译，测试也无法运行。我花了很长时间才意识到问题出在 Pnpm 上。
解决方法
解决这个问题有两种方法：
- 修改 Pnpm 的配置，使其执行 Pre/Post-Scripts：
pnpm config set scripts-prepend-node-path true
- 在 package.json 文件中显式指定 Pre/Post-Scripts：
{
"scripts": {
"preinstall": "node ./preinstall.js",
"postinstall": "node ./postinstall.js"
}
}
避免踩坑指南
为了避免踩到这个坑，Electron 开发者可以遵循以下指南：
-
使用 npm 或 Yarn 安装依赖包：npm 和 Yarn 支持执行 Pre/Post-Scripts。
-
如果必须使用 Pnpm，请修改其配置或在 package.json 文件中显式指定 Pre/Post-Scripts。
-
在 CI/CD 流水线中，确保 Pre/Post-Scripts 被正确触发。
结论
Pnpm 的这个隐形坑虽然隐蔽，但开发者提高警惕即可避免踩坑。希望这篇文章能够帮助 Electron 开发者顺利构建他们的桌面应用。
常见问题解答
- 为什么 Pnpm 默认不执行 Pre/Post-Scripts？
为了提升安装速度，Pnpm 采用了默认不执行 Pre/Post-Scripts 的策略。
- 为什么 Electron 开发者特别容易踩到这个坑？
Electron 依赖于各种依赖包，如果不执行 Pre/Post-Scripts，可能会导致 Electron 及其相关依赖无法正常运行。
- 有哪些方法可以避免踩坑？
使用 npm 或 Yarn 安装依赖包、修改 Pnpm 的配置或在 package.json 文件中显式指定 Pre/Post-Scripts。
- 如何修复已经踩到的坑？
遵循上述解决方法，修改 Pnpm 的配置或在 package.json 文件中显式指定 Pre/Post-Scripts。
- 在 CI/CD 流水线中如何确保 Pre/Post-Scripts 被触发？
在流水线中配置相应的脚本或命令，以执行 Pre/Post-Scripts。
