在本教程中,我们将学习如何将 Node.js 项目打包为独立的可执行文件(.exe 文件),以便可以将其轻松地分发给没有 Node.js 环境的用户。为实现这个目标,我们将使用一个名为 `pkg` 的工具。
`pkg` 是一个开源 Node.js 应用打包工具,它可以将您的 Node.js 项目编译成无需 Node.js 运行时即可运行的可执行文件。`pkg` 支持跨平台打包,您可以为 Windows、macOS 和 Linux 生成可执行文件。
### Step 1: 安装 Node.js 与 NPM
确保您的计算机已安装了 Node.js。您可以在此链接下载 Node.js:https://nodejs.org/en/download/。安装完成后,请打开命令提示符或终端,输入以下命令检查是否成功安装:
```bash
node -v
npm -v
```
如果看到 Node.js 和 NPM 的版本,则安装成功。
### Step 2: 创建一个 Node.js 项目
在一个新文件夹中创建一个 Node.js 项目。您可以使用 `npm init` 命令来完成这个操作。填写相关信息并完成设置。例如:
```bash
mkdir my-node-project
cd my-node-project
npm init
```
根据提示填写详细信息。
### Step 3: 安装 `pkg`
在您的项目根目录下,执行以下命令安装 `pkg`:
```bash
npm install -g pkg
```
### Step 4: 编辑 `package.json`
为了方便使用`pkg`命令,我们可以在 `package.json` 中添加一个 `scripts` 字段。用文本编辑器打开 `package.json` 并修改为以下内容:
```json
{
"name": "my-node-project",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"build": "pkg ."
},
"author": "",
"license": "ISC",
"dependencies": {}
}
```
我们添加了 `build` 命令以方便地使用 `pkg`。
### Step 5: 编写您的应用程序
在项目根目录下,创建一个名为 `index.js` 的文件并编写您的 Node.js 代码。例如:
```javascript
const fs = require('fs');
fs.writeFileSync('output.txt', '这是一个Node.js项目打包为EXE文件的示例程序!');
console.log('输出文件 "output.txt" 已生成。');
```
### Step 6: 打包项目为 .exe 文件
现在您已准备好打包项目。使用以下命令开始打包过程:
```bash
npm run build
```
打包完成后,您将在项目目录中看到以下三个文件之一(取决于您的操作系统):
- `my-node-project-win.exe`
- `my-node-project-macos`
- `my-node-project-linux`
您可以将这些文件分发给没有安装 Node.js 的用户。
### 结论
现在,您已了解了如何将 Node.js 项目打包为 .exe 文件,以便轻松地在没有 Node.js 环境的计算机上运行。`pkg` 是一个功能强大的工具,可以帮助您更轻松地将您的 Node.js 项目部署到各种平台。