无法使用pkg将Node.js应用打包为二进制可执行文件的问题求助

问题概述 #

我有一个仅包含index.js、xlsx_to_pdf.js、xlsx_extractor.js三个文件的Node.js应用，package.json依赖包括pdfkit、whatsapp-web.js（依赖puppeteer）等。执行npx pkg index.js时出现puppeteer目录无法打包、brotli字节码编译失败的警告；运行生成的index-win.exe时，抛出Cannot find module 'es-get-iterator/node.js'的错误。

问题原因 #

1. Puppeteer资源无法嵌入：pkg不能将puppeteer/.local-chromium这类大体积外部资源打包进二进制文件，必须单独分发。
2. 动态require未被捕获：部分依赖（如deep-equal）使用了非字面量的require调用，pkg的静态分析无法识别这些动态路径，导致相关模块未被打包。
3. brotli代码兼容性问题：brotli/build/encode.js包含pkg无法处理的代码逻辑，导致字节码编译失败，影响打包完整性。

针对pkg的解决步骤 #

1. 处理Puppeteer的Chromium依赖 #

• 方案一：在代码中手动指定系统已安装的Chrome/Chromium路径，跳过puppeteer自带的.local-chromium：

  const puppeteer = require('puppeteer');
  const browser = await puppeteer.launch({
    executablePath: 'C:/Program Files/Google/Chrome/Application/chrome.exe' // Windows示例路径
  });
  

• 方案二：按照pkg的警告提示，将node_modules/puppeteer/.local-chromium完整复制到可执行文件同目录下的puppeteer文件夹中，保持目录结构一致。

2. 强制包含缺失模块 #

在package.json中添加pkg字段，指定需要额外打包的模块资源：

{
  // ... 原有内容
  "pkg": {
    "assets": [
      "node_modules/es-get-iterator/**/*",
      "node_modules/deep-equal/**/*"
    ]
  }
}

3. 优化打包命令 #

• 明确指定打包目标，避免pkg自动推断出错：

  npx pkg index.js --target node14-win-x64
  

• 若brotli字节码问题持续，禁用字节码编译：

  npx pkg index.js --target node14-win-x64 --no-bytecode
  

替代打包工具推荐 #

如果pkg的问题无法彻底解决，可以尝试这些工具：

• nexe：对动态require的处理更灵活，支持自定义资源打包，适合复杂依赖场景。
• electron-packager：适合需要浏览器环境的应用（如依赖puppeteer的whatsapp-web.js），可将应用打包为带Chromium内核的桌面程序，无需额外处理浏览器依赖。

内容的提问来源于stack exchange，提问作者Milan Jain