README_zh.md
1# Api-Diff对比工具
2
3## 简介
4
5该工具可用于对比两个版本SDK里的API差异，并汇总成表格，提供给应用开发者。
6
7## 目录
8
9```
10├─test #测试用例存放路径
11└─src #源码存放路径
12```
13
14## 使用方法
15
16### 安装
17
18需要安装npm依赖环境，在package.json同级目录下执行：npm install。
19
20### 使用工具
21
22查看工具命令行参数，在package.json同级目录下运行：
23
24```
25node .\src\entry\main.js diff -h
26Usage: diff [options]
27
28Compare the differences between the two SDKS
29
30Options:
31 -V, --version output the version number
32 --old <string> old sdk path
33 --new <string> new sdk path
34 --oldVersion <string> old sdk version
35 --newVersion <string> new sdk version
36 --output <string> output file path
37 --format <json, excel, changelog> output file format
38 --newPath <string> new interface_sdk-js path
39 --oldPath <string> old interface_sdk-js path
40 --changelogUrl <string> changelog url
41 -h, --help display help for command
42```
43
44生成diff报告，在package.json同级目录下运行：
45
46```
47node .\src\entry\main.js diff --old 旧版本sdk根目录/windows/ets --new 新版本sdk根目录/windows/ets --oldVersion 旧版本SDK版本号 --newVersion 新版本SDK版本号 --output 输出路径 --format 报告格式（报告格式可选择excel或者json）
48```
49
50如果需要跟每个版本的changelog进行合并，命令行中还需添加参数changelogUrl，
51
52获取changelogUrl：在gitee中打开changelog文件夹下名为allVersion.json的文件，点击查看原始数据，此时的网址链接即为changelogUrl。
53
54```
55node .\src\entry\main.js diff --old 旧版本sdk根目录/windows/ets --new 新版本sdk根目录/windows/ets --oldVersion 旧版本SDK版本号 --newVersion 新版本SDK版本号 --output 输出路径 --format 报告格式（报告格式可选择excel或者json）--changelogUrl 网址链接
56```
57
58生成changelog配置文件，在package.json同级目录下运行：
59
60```
61node .\src\entry\main.js diff --oldPath 旧版本interface_sdk-js根目录 --new 新版本旧版本interface_sdk-js根目录 --oldVersion 旧版本号 --newVersion 新版本号 --output 输出路径 --format changelog
62```