# wang-nw-builder

**Repository Path**: consolelog/wang-nw-builder

## Basic Information

- **Project Name**: wang-nw-builder
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-20
- **Last Updated**: 2024-01-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# wang-nw-builder

这是一个NW.js的打包工具。

- [快速开始](#快速开始)
  - [安装依赖](#安装依赖)
  - [执行打包命令](#执行打包命令)
  - [启动客户端](#启动客户端)
- [可选项](#可选项)
  - [使用代码的方式进行打包](#使用代码的方式进行打包)
- [示例](#示例)

## 快速开始

### 安装依赖

```shell
npm i --save-dev wang-nw-builder
```

### 执行打包命令

执行下面的命令即可打包，默认情况下假设 `./dist` 目录下包含应用代码以及 `package.json` 文件:

```shell
npm run nwBuilder --srcDir=./dist
```

### 启动客户端

启动 `./out` 目录下的对应文件

## 可选项

| 选项          | 默认值                                | 可选项                                  | 示例                                               | 说明                                            |
|-------------|------------------------------------|--------------------------------------|--------------------------------------------------|-----------------------------------------------|
| srcDir      | ./dist                             |                                      | --srcDir=./dist                                  | 源代码保存目录。                                      |
| outDir      | ./out                              |                                      | --outDir=./out                                   | 打包成品输出目录。                                     |
| cacheDir    | ./cache                            |                                      | --cacheDir=./cache                               | 缓存保存目录。                                       |
| version     | latest                             | latest、stable、lts，以及精确版本号，例如: 0.82.0 | --version=latest                                 | nwjs版本号。                                      |
| flavor      | normal                             | normal、sdk                           | --flavor=normal                                  | 打包后的类型。normal一般用于生产环境；sdk是带控制台的，一般用于开发环境。     |
| platform    | win                                | win、osx、linux                        | --platform=win                                   | 操作系统平台。非osx系统打包osx文件可能会出问题，建议osx的应用单独在osx系统打包 |
| arch        | x64                                | x64、ia32、arm64                       | --arch=x64                                       | 操作系统架构。新款苹果m2 CPU使用arm64。                     |
| logLevel    | info                               | info、debug                           | --logLevel=info                                  | 日志级别。info指的是仅输出少量日志，debug就是输出详细日志。            |
| downloadUrl | https://npmmirror.com/mirrors/nwjs |                                      | --downloadUrl=https://npmmirror.com/mirrors/nwjs | 文件下载地址。                                       |

### 使用代码的方式进行打包

代码的方式允许我们以可编程的方式进行打包，大大增加了打包的灵活性，其可选项和上文一样。

示例:

```typescript
import {nwBuilder} from "wang-nw-builder";

nwBuilder({
  srcDir: './test/src',
  version: 'latest',
  flavor: 'normal',//"normal" | "sdk"
  platform: 'osx',//"win" | "osx" | "linux"
  arch: 'x64',//"x64" | "arm64" | "ia32"
  logLevel: 'debug',//"info" | "debug"
  cacheDir: './cache',
  outDir: './out',
  downloadUrl: 'https://npmmirror.com/mirrors/nwjs',
});
```

## 示例

https://gitee.com/consolelog/wang-nw-builder-example.git