From f1890f2fe0c6222736e21bd03d898f497729ad97 Mon Sep 17 00:00:00 2001 From: wangqing Date: Sun, 9 Oct 2022 17:05:34 +0800 Subject: [PATCH 1/2] =?UTF-8?q?README=E6=96=87=E4=BB=B6=E6=95=B4=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: wangqing --- README_zh.md | 25 +++++++++++-- .../collect_application_api/README_EN.md | 16 --------- .../collect_application_api/README_zh.md | 36 +++++++++++++++++++ 3 files changed, 59 insertions(+), 18 deletions(-) delete mode 100644 build-tools/collect_application_api/README_EN.md create mode 100644 build-tools/collect_application_api/README_zh.md diff --git a/README_zh.md b/README_zh.md index 21846d91b8..b5740666ef 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,8 +1,29 @@ # API声明文件公共仓 -- [简介](#section11660541593) - ## 简介 JavaScript API 公共仓，用来提交 API d.ts 声明文件。 +## 目录 + +``` +├─api +| ├─@internal +│ | ├─component +│ | | └─ets #组件存放目录 +| | └─ets +| └─@ohos.×××.d.ts #API声明文件 +├─build-tools + ├─api_check_plugin #检查API规范的工具 + | ├─plugin + | ├─src + | └─test + └─collect_application_api #解析应用到的API的工具 + └─src + +``` + +## 相关仓 + +[interface-sdk_js](https://gitee.com/openharmony/interface_sdk-js/tree/master) + diff --git a/build-tools/collect_application_api/README_EN.md b/build-tools/collect_application_api/README_EN.md deleted file mode 100644 index da16a6f70e..0000000000 --- a/build-tools/collect_application_api/README_EN.md +++ /dev/null @@ -1,16 +0,0 @@ -COLLECT_APPLICATION_API - -Usage -1.Install - Install the npm dependencies(You must have node&npm installed): - $npm install - -2.Quick Start - In the src directory - $node format - -3.Directory Structure - ./sdk--- directory path of API files - ./application--- directory path of application - ./deps--- directory path of source code - ./src--- directory path of result \ No newline at end of file diff --git a/build-tools/collect_application_api/README_zh.md b/build-tools/collect_application_api/README_zh.md new file mode 100644 index 0000000000..64742b0514 --- /dev/null +++ b/build-tools/collect_application_api/README_zh.md @@ -0,0 +1,36 @@ +# 应用API解析工具 + +## 简介 + +该工具主要用于解析应用中使用到的API，最终生成一个表格。 + +## 目录 + +``` +├─sdk #存放API文件的目录 +├─application #存放被解析的应用 +├─deps #存放typescript源码 +└─src #存放源码以及生成的表格 +``` + +## 使用方法 + +### 目录配置 + +新建sdk文件夹，放置api文件； + +新建application文件夹，放置被解析的应用； + +新建deps文件夹，放置typescript源码。 + +### 安装 + +需要安装npm依赖环境：$npm install。 + +### 使用工具 + +进入src目录下：$node format。 + +## 相关文件夹 + +[collect_application_api](https://gitee.com/openharmony/interface_sdk-js/tree/master/build-tools/collect_application_api) \ No newline at end of file -- Gitee From 49d90bde1a6e26305ccfc02f9a7d8de82ab40cd0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=8E=8B=E9=9D=92?= Date: Mon, 10 Oct 2022 14:38:27 +0800 Subject: [PATCH 2/2] =?UTF-8?q?README=E6=96=87=E4=BB=B6=E6=95=B4=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 王青 --- README_zh.md | 9 ++++++--- build-tools/collect_application_api/README_zh.md | 2 +- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README_zh.md b/README_zh.md index b5740666ef..009fc79736 100644 --- a/README_zh.md +++ b/README_zh.md @@ -2,7 +2,7 @@ ## 简介 -JavaScript API 公共仓，用来提交 API d.ts 声明文件。 +JS/TS API 公共仓，用来提交 API d.ts 声明文件以及API相关工具。 ## 目录 @@ -10,9 +10,12 @@ JavaScript API 公共仓，用来提交 API d.ts 声明文件。 ├─api | ├─@internal │ | ├─component -│ | | └─ets #组件存放目录 +│ | | └─ets #基于TS扩展的声明式开发范式组件声明文件 | | └─ets -| └─@ohos.×××.d.ts #API声明文件 +| ├─config #基于JS扩展的类Web范式 +| ├─form #JS服务卡片 +| ├─@ohos.×××.d.ts #API声明文件 +| └─@system.×××.d.ts #标记为停止维护的接口 ├─build-tools ├─api_check_plugin #检查API规范的工具 | ├─plugin diff --git a/build-tools/collect_application_api/README_zh.md b/build-tools/collect_application_api/README_zh.md index 64742b0514..65ac8bc9fa 100644 --- a/build-tools/collect_application_api/README_zh.md +++ b/build-tools/collect_application_api/README_zh.md @@ -2,7 +2,7 @@ ## 简介 -该工具主要用于解析应用中使用到的API，最终生成一个表格。 +该工具可用于解析应用中使用的API，并汇总成表格，提供给应用开发者 ## 目录 -- Gitee