interface_sdk-js/build-tools/api_diff/README_zh.md
wangqing 7a0481ed9c 差异报告输入格式变更为md文档
Signed-off-by: wangqing <wangqing136@huawei.com>
2023-03-07 16:03:01 +08:00

1.1 KiB
Raw Blame History

Api-Diff对比工具

简介

该工具可用于对比两个版本SDK里的API差异并汇总成表格提供给应用开发者

目录

├─diff合集      #存放md文档形式的diff报告
├─版本迭代合集   #存放由子系统自行填写的API变更
├─url.json     #SDK路径和新旧版本的配置文件
└─src          #存放源码以及生成的表格

使用方法

目录配置

新建名为"diff合集"的文件夹存放md文档形式的diff报告。

填写路径

  1. 在url.json文件中将新旧SDK的本地路径分别赋给oldDir和newDir变量路径写到windows即可例如D:ohos-sdk-windows_linux-full.tar_beta4*\ohos-sdk\*windows
  2. 在url.json文件中分别将新旧SDK的版本分别赋给oldVersion和newVersion变量例如3.2.5.6

安装

需要安装npm依赖环境在package.json同级目录下执行npm install。

使用工具

在package.json同级目录下执行npm run diff。

相关文件夹

api_diff