diff --git a/README_zh.md b/README_zh.md index 21846d91b8adec8fa349e614fb8dd3fb7ddfc319..009fc797364b52885000954f29f86fb29e53b4f1 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,8 +1,32 @@ # API声明文件公共仓 -- [简介](#section11660541593) - ## 简介 -JavaScript API 公共仓,用来提交 API d.ts 声明文件。 +JS/TS API 公共仓,用来提交 API d.ts 声明文件以及API相关工具。 + +## 目录 + +``` +├─api +| ├─@internal +│ | ├─component +│ | | └─ets #基于TS扩展的声明式开发范式组件声明文件 +| | └─ets +| ├─config #基于JS扩展的类Web范式 +| ├─form #JS服务卡片 +| ├─@ohos.×××.d.ts #API声明文件 +| └─@system.×××.d.ts #标记为停止维护的接口 +├─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 da16a6f70e10f05a4ffb921cf84fb6076c77cd28..0000000000000000000000000000000000000000 --- 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 0000000000000000000000000000000000000000..65ac8bc9fa4ddce671f8fee5fd7620d0b8deeb37 --- /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