|
8 | 8 | 1. 此准备工作仅需运行一次
|
9 | 9 |
|
10 | 10 | 2. 在 [Node.js](https://nodejs.org/en/) 站点下载 Node.js 并安装
|
11 |
| - |
| 11 | + |
12 | 12 | 1. 建议版本 >= 14
|
13 | 13 | 2. 不建议安装奇数版本,如 13、15、17,奇数版本由于没有充分的进行测试,为不稳定版本
|
14 | 14 |
|
15 | 15 | 3. 安装 Node.js 之后,打开命令提示符,依次输入:
|
16 |
| - |
| 16 | + |
17 | 17 | ```bash
|
18 | 18 | node -v
|
19 | 19 | npm --version
|
20 | 20 | ```
|
21 |
| - |
| 21 | + |
22 | 22 | 此操作会输出两个版本号,表示安装成功,如果没有版本号输出请重新安装 Node.js
|
23 | 23 |
|
24 | 24 | 4. 鉴于 `npm` 工具使用存在一些问题,推荐使用 `yarn` 工具,打开命令提示符,输入以下命令并等待安装完成:
|
25 |
| - |
| 25 | + |
26 | 26 | ```bash
|
27 | 27 | npm i -g yarn
|
28 | 28 | ```
|
29 | 29 |
|
30 |
| -5. 此文档中会提供 `npm` 和 `yarn` 两套命令,根据你使用的工具,只需执行其中一句即可 |
31 |
| - |
32 |
| -## 术语解释 |
33 |
| - |
34 |
| -1. 工具 - 指代此工具 |
35 |
| -2. 左文件夹(左目录) - 用于比较的原文件夹 |
36 |
| -3. 右文件夹(右目录) - 进行对比的文件夹 |
37 |
| -4. 报告文件夹(报告目录) - 报告文件输出的文件夹 |
| 30 | +5. **注**:此文档中会提供 `npm` 和 `yarn` 两套命令,根据你使用的工具,只需执行其中一句即可 |
38 | 31 |
|
39 | 32 | ## 使用方法
|
| 33 | +1. Windows 下打开命令提示符(`CMD.exe`),Linux / Unix / MacOS 下打开终端,使用 `cd` 命令切换到解压后的工具目录 |
40 | 34 |
|
41 |
| -1. 打开命令提示符(CMD.exe) |
42 |
| - |
43 |
| -2. 使用 `cd` 命令切换到解压后的工具目录 |
44 |
| - |
45 |
| - 1. Windows 中: |
46 |
| - |
47 | 35 | ```bash
|
48 |
| - cd /d <工具路径> |
49 |
| - ``` |
50 |
| - |
51 |
| - 2. Linux / Unix / MacOS 中: |
52 |
| - |
53 |
| - ```bash |
54 |
| - cd /d <工具路径> |
| 36 | + cd /d <工具路径> # Windows 命令 |
| 37 | + cd <工具路径> # Linux / Unix / MacOS 命令 |
55 | 38 | ```
|
56 | 39 |
|
57 |
| -3. 运行以下命令,等待依赖包安装完成: |
58 |
| - |
| 40 | +2. 运行以下命令,等待依赖包安装完成: |
| 41 | + |
59 | 42 | ```bash
|
60 | 43 | npm i
|
61 | 44 | yarn install
|
62 | 45 | ```
|
63 | 46 |
|
64 |
| -4. 运行以下命令,进行文件对比,生成报告 |
65 |
| - |
| 47 | +3. 运行以下命令,进行文件对比,生成报告 |
| 48 | + |
66 | 49 | ```bash
|
67 |
| - npm run compare -- -l <左文件夹路径> -r <右文件夹路径> -o <报告文件夹路径> |
68 |
| - yarn compare -l <左文件夹路径> -r <右文件夹路径> -o <报告文件夹路径> |
| 50 | + npm run compare -- ...参数 |
| 51 | + yarn compare ...参数 |
| 52 | +
|
69 | 53 | ```
|
| 54 | + 参数说明: |
| 55 | + |
| 56 | +| 参数标记 | 是否必填 | 默认值 | 说明 | |
| 57 | +| :--- | :---: | :--- | :--- | |
| 58 | +| `--lhs-queue`<br>`-n` | 否 | `10` | 计算左侧文件数字签名时,同时进行的任务数量,越多则执行越快,但消耗资源也会越多 | |
| 59 | +| `--lhs`<br>`-l` | 是 | | 左侧对比文件夹路径 | |
| 60 | +| `--rhs-queue`<br>`-m` | 否 | `10` | 计算右侧文件数字签名时,同时进行的任务数量,越多则执行越快,但消耗资源也会越多 | |
| 61 | +| `--rhs`<br>`-r` | 是 | | 右侧对比文件夹路径 | |
| 62 | +| `--output`<br>`-o` | 是 | | 报告生成的文件夹路径 | |
70 | 63 |
|
71 |
| -5. 报告文件生成在报告文件夹,如果报告文件不存在会自动生成,具体文件的作用请参照 【报告文件说明】 部分 |
| 64 | +4. 报告文件生成在报告文件夹,如果报告文件不存在会自动生成,具体文件的作用请参照「报告文件说明」部分 |
72 | 65 |
|
73 | 66 | ## 报告文件说明
|
74 | 67 |
|
|
0 commit comments