pkg：将Node.js项目打包成可执行文件完全指南

pkg：将Node.js项目打包成可执行文件完全指南

pkg 项目地址: https://gitcode.com/gh_mirrors/pkg/pkg

项目基础介绍与编程语言

pkg 是一个广受欢迎的开源工具，由 ZEIT（现 Vercel）维护，其主要功能是将你的Node.js项目编译成独立的可执行文件。这意味着你可以在没有安装Node.js环境的设备上运行该应用。此工具非常适合那些希望分发不暴露源代码的应用程序、创建跨平台的快速演示版本或简化部署流程的开发者。pkg 使用的是JavaScript作为主要编程语言。

关键技术和框架

• Node.js: 应用的基础运行环境。
• V8引擎: 在底层，pkg 利用V8引擎来编译JavaScript代码，并将其嵌入到可执行文件中。
• Cross-platform support: 支持多平台编译，包括Linux、macOS和Windows。
• Binary compilation: 直接生成不同架构下的二进制文件，无需用户的Node.js和npm安装。

安装与配置详细步骤

准备工作

1. 确保环境: 确保你的系统已安装了最新版本的Node.js（推荐至少Node.js 14以上版本），因为pkg依赖于Node.js环境。
2. Git客户端: 安装Git，如果你打算克隆仓库进行查看或贡献。

步骤一：全局安装pkg

打开终端或命令提示符，运行以下命令以全局安装pkg：

npm install -g pkg

这一步会下载并安装pkg命令行工具。

步骤二：准备你的Node.js项目

• 创建一个新的Node.js项目或者使用现有的项目。
• 确保有一个入口文件，如index.js，这是pkg将打包为可执行文件的起点。
• 可选：在package.json中配置pkg特定的选项，例如指定打包的目标平台或自定义入口点等。

步骤三：使用pkg打包项目

导航至你的项目目录，然后运行pkg命令来打包应用。基本命令格式如下：

pkg index.js --target=node16 --platform=all --output=myapp

参数解释：

• index.js: 入口文件路径。
• --target=node16: 指定目标Node.js版本，可以是具体的版本号或latest。
• --platform=all: 打包所有支持的平台（或指定具体平台如linux, win, macos）。
• --output=myapp: 输出文件名前缀，生成的文件将是myapp_ _ .exe 或相应格式。

步骤四：测试可执行文件

打包完成后，会在当前目录下生成对应的可执行文件。根据你的操作系统，尝试运行生成的文件，验证是否能够正常启动。

注意事项

• 当打包私有依赖或非标准路径的资源时，可能需要在package.json的pkg配置中明确指定脚本和资产路径。
• 对于生产环境，考虑安全性需求，尤其是macOS上的代码签名要求。
• 跨平台打包可能需要额外的设置，比如在Linux上配置QEMU用于模拟其他架构。

至此，您已经成功学会了如何使用pkg将您的Node.js应用程序转换成可直接运行的跨平台可执行文件。祝开发愉快！

pkg 项目地址: https://gitcode.com/gh_mirrors/pkg/pkg