openharmony/napi_generator
1
0
Fork 0
mirror of https://gitee.com/openharmony/napi_generator synced 2024-11-23 16:30:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

style: add napi and ts tool download path

Browse Source 
Signed-off-by: chenxun <chenxun@kaihong.com>
This commit is contained in:
chenxun 2023-01-30 16:30:49 +08:00
parent 259d8a161f
commit 0afea7b0df
11 changed files with 147 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/INSTRUCTION_ZH.md
View File

@ -1,15 +1,18 @@
# NAPI框架生成工具使用说明
## 简介
NAPI框架生成工具支持三种入口，分别是可执行程序、VS Code插件、IntelliJ插件，使用者可以根据自己的需要选择合适的工具。可执行文件、IntelliJ插件、VS Code插件下载路径如下，选择napi_generator_outputs.zip下载。
NAPI框架生成工具支持三种入口，分别是可执行程序、VS Code插件、IntelliJ插件，使用者可以根据自己的需要选择合适的工具。可执行文件、IntelliJ插件、VS Code插件下载路径如下：
[下载链接](http://ftp.kaihongdigi.com:5000/fsdownload/mKjfCmPjk/generator_outputs_NAPI_0930)
[下载链接1]( http://ftpkaihongdigi.i234.me:5000/sharing/PC6uOorrM)
[下载链接2]( http://ftp.kaihong.com:5000/sharing/PC6uOorrM)
[下载链接3]( http://ftp.kaihongdigi.com:5000/sharing/PC6uOorrM)
下载文件说明如下：
│ │ |── generator.jar # IntelliJ插件
│ │ |── gnapi-0.0.1.vsix # VS Code插件
│ │ |── header_parser.exe # python脚本可执行程序
│ │ |── napi_generator-linux # Linux可执行程序
│ │ |── napi_generator-win.exe # Windows可执行程序
│ │ └── napi_generator-macos # Mac可执行程序
@ -45,7 +48,7 @@ napi_generator的可执行程序方式和插件方式都具有预检查的功能
#### Linux
1.将待转换的.d.ts文件、napi_generator-linux放在同级目录下。若.d.ts文件中声明了basic.d.ts文件，将basic.d.ts文件放置在待转换.d.ts文件上一级目录；若除此之外还声明其他.d.ts文件，将此类文件放置在待转换.d.ts文件同级目录。此处新建out文件夹，用于存放生成框架代码。整体目录文件如下：
1.将待转换的.d.ts文件、napi_generator-linux放在同级目录下。若.d.ts文件中声明了basic.d.ts文件，将basic.d.ts文件放置在待转换.d.ts文件上一级目录；若除此之外还声明其它.d.ts文件，将此类文件放置在待转换.d.ts文件同级目录。此处新建out文件夹，用于存放生成框架代码。整体目录文件如下：
harmony@Ubuntu-64:~/service$ ls
napi_generator-linux @ohos.napitest.d.ts out
@ -60,7 +63,7 @@ napi_generator的可执行程序方式和插件方式都具有预检查的功能
-i, 可选参数，默认false，待转换.d.ts文件中引用非basic.d.ts的ts文件时打开开关；
-o, 可选参数，默认为当前目录，指定生成框架代码输出路径；
-n, 可选参数，默认为uint32_t，指定生成框架代码中number类型全部为指定类型。
备注：-f与-d两个参数只选其中一个参数即可。
3.运行成功后会在out目录下生成框架代码文件，如下所示：
@ -70,7 +73,7 @@ napi_generator的可执行程序方式和插件方式都具有预检查的功能
#### Windows
1.将待转换的.d.ts文件、napi_generator-win.exe放在同级目录下。若.d.ts文件中声明了basic.d.ts文件，将basic.d.ts文件放置在待转换.d.ts文件上一级目录；若除此之外还声明其他.d.ts文件，将此类文件放置在待转换.d.ts文件同级目录。此处新建out文件夹，用于存放生成框架代码。整体目录文件如下：
1.将待转换的.d.ts文件、napi_generator-win.exe放在同级目录下。若.d.ts文件中声明了basic.d.ts文件，将basic.d.ts文件放置在待转换.d.ts文件上一级目录；若除此之外还声明其它.d.ts文件，将此类文件放置在待转换.d.ts文件同级目录。此处新建out文件夹，用于存放生成框架代码。整体目录文件如下：
E:\demo\napi>dir /B
@ohos.napitest.d.ts
@ -87,7 +90,7 @@ napi_generator的可执行程序方式和插件方式都具有预检查的功能
-i, 可选参数，默认false，待转换.d.ts文件中引用非basic.d.ts的ts文件时打开开关；
-o, 可选参数，默认为当前目录，指定生成框架代码输出路径；
-n, 可选参数，默认为uint32_t，指定生成框架代码中number类型全部为指定类型。
备注：-f与-d两个参数只选其中一个参数即可。
3.运行成功后会在out目录下生成框架代码文件，如下所示：

2
docs/ROADMAP_ZH.md
View File

@ -25,7 +25,7 @@
</td>
<tr id="row119944512385"><td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.2.3.1.1 "><p id="p919862210573"><a name="p919862210573"></a><a name="p919862210573"></a>文件</p>
</td>
<td class="cellrowborder" valign="top" width="74.22999999999999%" headers="mcps1.2.3.1.2 "><a name="ul12374158862"></a><a name="ul12374158862"></a><ul id="ul12374158862">><li>优化VSCode插件用户界面</li></ul>
<td class="cellrowborder" valign="top" width="74.22999999999999%" headers="mcps1.2.3.1.2 "><a name="ul12374158862"></a><a name="ul12374158862"></a><ul id="ul12374158862"><li>优化VSCode插件用户界面</li></ul>
</td>
</tr>
</tr>

16
docs/ts/DEVELOP_ZH.md
View File

@ -54,9 +54,13 @@ ts工具框架由C++语法解释器和代码生成器两部分组成。C++语法
**2 生成header_parser程序**
2.1 安装python库 CppHeaderParser，在以下链接中下载CppHeaderParser并替换本地Python文件夹中CppHeaderParser(/usr/local/lib/python3.8/dist-packages/CppHeaderParser)目录下的全部文件
2.1 安装python库 CppHeaderParser，在header_parser/src_code中下载CppHeaderParser.zip，解压后替换本地Python文件夹中CppHeaderParser(如 /usr/local/lib/python3.8/dist-packages/CppHeaderParser)目录下的全部文件
[CppHeaderParser]()
[下载链接1](http://ftpkaihongdigi.i234.me:5000/sharing/kBG1c7CvT)
[下载链接2](http://ftp.kaihong.com:5000/sharing/kBG1c7CvT)
[下载链接3](http://ftp.kaihongdigi.com:5000/sharing/kBG1c7CvT)
2.2 安装 pyinstaller
@ -108,9 +112,13 @@ ts工具框架由C++语法解释器和代码生成器两部分组成。C++语法
**2.生成header_parser程序**
2.1 安装python库 CppHeaderParser，在以下链接中下载CppHeaderParser并替换本地Python文件夹中CppHeaderParser(C:\Python310\Lib\site-packages\CppHeaderParser)目录下的全部文件
2.1 安装python库 CppHeaderParser，在header_parser/src_code中下载CppHeaderParser.zip，解压后替换本地Python文件夹中CppHeaderParser(如 C:\Python310\Lib\site-packages\CppHeaderParser)目录下的全部文件
[CppHeaderParser]()
[下载链接1](http://ftpkaihongdigi.i234.me:5000/sharing/kBG1c7CvT)
[下载链接2](http://ftp.kaihong.com:5000/sharing/kBG1c7CvT)
[下载链接3](http://ftp.kaihongdigi.com:5000/sharing/kBG1c7CvT)
2.2 安装 pyinstaller

25
docs/ts/INSTRUCTION_ZH.md
View File

@ -1,17 +1,28 @@
# Ts接口生成工具使用说明
## 简介
Ts接口生成工具支持两种入口，分别是可执行程序、IntelliJ插件，使用者可以根据自己的需要选择合适的工具。可执行文件、IntelliJ插件下载路径如下，选择napi_generator_outputs.zip下载。
Ts接口生成工具支持两种入口，分别是可执行程序、IntelliJ插件，使用者可以根据自己的需要选择合适的工具。可执行文件、IntelliJ插件下载路径如下。
[下载链接](http://ftp.kaihongdigi.com:5000/fsdownload/mKjfCmPjk/generator_outputs_NAPI_0930)
[下载链接1](http://ftpkaihongdigi.i234.me:5000/sharing/kBG1c7CvT)
[下载链接2](http://ftp.kaihong.com:5000/sharing/kBG1c7CvT)
[下载链接3](http://ftp.kaihongdigi.com:5000/sharing/kBG1c7CvT)
下载文件说明如下：
│ │ |── generator.jar # IntelliJ插件
│ │ |── header_parser.exe # python脚本可执行程序
│ │ |── napi_generator-linux # Linux可执行程序
│ │ |── napi_generator-win.exe # Windows可执行程序
│ │ └── napi_generator-macos # Mac可执行程序
│ │ |── generator.jar # IntelliJ插件
│ │ |── header_parser
│ │ |── |── linux
│ │ |── |── |── header_parser # Linux下python脚本可执行程序
│ │ |── |── windows
│ │ |── |── |── header_parser.exe # Windows下python脚本可执行程序
│ │ |── |── src_code
│ │ |── |── |── CppHeaderParser.zip # CppHeaderParser源码
│ │ |── |── readme.txt # readme.txt
│ │ |── napi_generator-linux # Linux可执行程序
│ │ |── napi_generator-win.exe # Windows可执行程序
│ │ └── napi_generator-macos # Mac可执行程序
## 工具介绍

10
napi_IntelliJ_plugin/README_zh.md
View File

@ -35,9 +35,13 @@ NAPI框架代码生成工具，它可以根据用户指定路径下的ts(typescr
### 工具使用
插件下载路径如下，选择napi_generator_outputs.zip下载。
插件下载路径如下，选择napi_generator.jar下载。
[下载链接](http://ftp.kaihongdigi.com:5000/fsdownload/mKjfCmPjk/generator_outputs_NAPI_0930)
[下载链接1]( http://ftpkaihongdigi.i234.me:5000/sharing/PC6uOorrM)
[下载链接2]( http://ftp.kaihong.com:5000/sharing/PC6uOorrM)
[下载链接3]( http://ftp.kaihongdigi.com:5000/sharing/PC6uOorrM)
具体的工具使用步骤，可以左键单击以下链接了解：
@ -79,7 +83,7 @@ bool TestClass1::if_callback(std::string &v1, std::string &out) {
......
}
```
### 集成方法
为了实现工具生成的接口被其他子系统或者应用调用，需将生成的代码编译集成到OpenHarmony系统中，编译生成动态库。

6
napi_IntelliJ_plugin/docs/napi/DEVELOP_ZH.md
View File

@ -14,7 +14,11 @@
1.下载napi工具可执行程序，并放置在napi_generator/napi_IntelliJ_plugin/resources/cmds目录下对应系统的文件夹下，下载链接如下：
[下载链接](暂无)
[下载链接1]( http://ftpkaihongdigi.i234.me:5000/sharing/PC6uOorrM)
[下载链接2]( http://ftp.kaihong.com:5000/sharing/PC6uOorrM)
[下载链接3]( http://ftp.kaihongdigi.com:5000/sharing/PC6uOorrM)
2.下载并安装IDEA Community、JDK11配置好环境。IDEA Community版本可以左键单击以下链接下载。

14
napi_IntelliJ_plugin/docs/napi/INSTRUCTION_ZH.md
View File

@ -2,9 +2,13 @@
## 简介
IntelliJ插件下载路径如下，选择napi_generator_outputs.zip中generator.jar下载。
IntelliJ插件下载路径如下，选择napi_generator.jar下载。
[下载链接](http://ftp.kaihongdigi.com:5000/fsdownload/mKjfCmPjk/generator_outputs_NAPI_0930)
[下载链接1]( http://ftpkaihongdigi.i234.me:5000/sharing/PC6uOorrM)
[下载链接2]( http://ftp.kaihong.com:5000/sharing/PC6uOorrM)
[下载链接3]( http://ftp.kaihongdigi.com:5000/sharing/PC6uOorrM)
## IntelliJ插件使用方法
@ -26,7 +30,7 @@ Ability Template选择Empty Ability,单击Next。
![](../../../figures/DevEco_step_firstNext.png)
填写Project name、Save location,其他选项可不修改，单击Finish,新的工程就创建好了。
填写Project name、Save location,其它选项可不修改，单击Finish,新的工程就创建好了。
![](../../../figures/DevEco_step_finish.png)
@ -36,11 +40,11 @@ Ability Template选择Empty Ability,单击Next。
![](../../../figures/DevEco_step_applyPlugins.png)
3.把待转换的.d.ts文件放在DevEco stdio新建项目的src目录下。若.d.ts文件中声明了basic.d.ts文件，将basic.d.ts文件放置在待转换.d.ts文件上一级目录；若除此之外还声明其他.d.ts文件，将此类文件放置在待转换.d.ts文件同级目录。
3.把待转换的.d.ts文件放在DevEco stdio新建项目的src目录下。若.d.ts文件中声明了basic.d.ts文件，将basic.d.ts文件放置在待转换.d.ts文件上一级目录；若除此之外还声明其它.d.ts文件，将此类文件放置在待转换.d.ts文件同级目录。
![](../../../figures/DevEco_step_napi.png)
4.选择.d.ts文件,点击右键选择 Generate Napi Frame，工具弹出Generate Napi Frame弹窗，选择Napi-Gen页签。接口文件文本框填写.d.ts文件路径；生成框架路径文本框填写生成框架存放路径；编译脚本路径填写生成CMakeList.txt文件输出路径；number目的类型此处选择char；启用import功能不选择（待转换.d.ts文件未引用其他文件）；点击ok。
4.选择.d.ts文件,点击右键选择 Generate Napi Frame，工具弹出Generate Napi Frame弹窗，选择Napi-Gen页签。接口文件文本框填写.d.ts文件路径；生成框架路径文本框填写生成框架存放路径；编译脚本路径填写生成CMakeList.txt文件输出路径；number目的类型此处选择char；启用import功能不选择（待转换.d.ts文件未引用其它文件）；点击ok。
![](../../../figures/DevEco_step_napiGenerate.png)

63
napi_IntelliJ_plugin/docs/ts/DEVELOP_ZH.md Normal file
View File

@ -0,0 +1,63 @@
# TS工具IntelliJ插件开发说明
若当前工具功能不满足开发者需求，开发者需增强工具能力，则可基于已有源码进行工具二次开发，编译打包生成自定义的IntelliJ插件。
## IntelliJ插件打包说明
### 环境说明
系统：建议Windows 10
### 开发步骤
#### 环境准备
1.下载napi_generator-win.exe可执行程序与header_parser.exe可执行程序，放置在napi_generator/napi_IntelliJ_plugin/resources/cmds/win目录下。其中header_parser.exe在header_parser/windows/下，下载地址如下：
[下载链接1](http://ftpkaihongdigi.i234.me:5000/sharing/kBG1c7CvT)
[下载链接2](http://ftp.kaihong.com:5000/sharing/kBG1c7CvT)
[下载链接3](http://ftp.kaihongdigi.com:5000/sharing/kBG1c7CvT)
2.下载并安装IDEA Community、JDK11配置好环境。IDEA Community版本可以左键单击以下链接下载。
[下载链接](https://www.jetbrains.com/idea/download/)
3.打开IDEA Community应用程序。
依次点击项目File>Open 选择napi_generator/napi_IntelliJ_plugin项目文件夹。
![](../../../figures/IntelliJ_env_config_open_proj.png)
4.项目打开完成，点击File>Project Structure,在出现的界面中点击Project,下图的SDK选择JDK 11，Language level也选择版本11，选择或者新建complier output目录为项目文件下的out目录。
![](../../../figures/IntelliJ_env_proj_structure.png)
5.Project Settings > Modules 新建Modules。点击上方“-”删除原有的Modules，然后点击“+”选择 New Module。
![](../../../figures/IntelliJ_env_Proj_Module.png)
6.在New Module对话框中，选择IntelliJ Platform Plugin。若Module SDK中无可选SDK，请在Module SDK 下拉框中点击 Add IntelliJ Platform Plugin SDK 选择IDEA Community安装目录，点击OK,在Select Internal Java Platform 选择 JAVA SDK 11（213版本只支持 11)，点击New Module对话框中Next。
![](../../../figures/IntelliJ_env_Proj_Module_New.png)
7.Content root选择~/napi_generator/napi_IntelliJ_plugin文件夹，module name填写generator。点击Finish，若出现提示已存在是否覆盖的提示，请点“Yes”完成配置。
![](../../../figures/IntelliJ_env_module_root.png)
8.Modules配置完成后，若在SDKs中无相应JDK和Plugin SDK,请点击+号分别添加 Add Java JDK和Add Intellij PlantForm Plugin SDK,Java JDK为java11的安装目录，Plugin SDK为 IDEA Community 2021.3.3的安装目录。
![](../../../figures/IntelliJ_env_config_SDKs.png)
9.若完成以上步骤配置，点击OK完成配置。Rebuild项目，若IDEA不能点击右上角的运行，点击Plugin后下三角选择Edit Configurations...选项，Run/Debug Configurations框中Use classpath of moudle选择generator，点击ok，等待安装完成。
![](../../../figures/IntelliJ_env_configurations.png)
![](../../../figures/IntelliJ_env_run_debug.png)
10.点击Intellij IDEA工具右上角Built Project按钮，等待工程built完成。
![](../../../figures/IntelliJ_env_built_pro.png)
11.在IDEA Community中依次点击Build>Prepare All Plugin Modules for development"，然后在Select Modules框中点击ok，jar包生成完成后在工具右下角提示jar包生成成功，且包含jar包存放位置。
![](../../../figures/IntelliJ_env_built_jar.png)
![](../../../figures/IntelliJ_env_select_moudles.png)
![](../../../figures/IntelliJ_env_built_jar_success.png)

10
napi_IntelliJ_plugin/docs/ts/INSTRUCTION_ZH.md
View File

@ -2,9 +2,13 @@
## 简介
IntelliJ插件下载路径如下，选择napi_generator_outputs.zip中generator.jar下载。
IntelliJ插件下载路径如下，选择generator.jar下载。
[下载链接](http://ftp.kaihongdigi.com:5000/fsdownload/mKjfCmPjk/generator_outputs_NAPI_0930)
[下载链接1](http://ftpkaihongdigi.i234.me:5000/sharing/kBG1c7CvT)
[下载链接2](http://ftp.kaihong.com:5000/sharing/kBG1c7CvT)
[下载链接3](http://ftp.kaihongdigi.com:5000/sharing/kBG1c7CvT)
## IntelliJ插件使用方法
@ -26,7 +30,7 @@ Ability Template选择Empty Ability,单击Next。
![](../../../figures/DevEco_step_firstNext.png)
填写Project name、Save location,其他选项可不修改，单击Finish,新的工程就创建好了。
填写Project name、Save location,其它选项可不修改，单击Finish,新的工程就创建好了。
![](../../../figures/DevEco_step_finish.png)

10
napi_vs_plugin/README_zh.md
View File

@ -32,9 +32,13 @@ NAPI框架代码生成工具，它可以根据用户指定路径下的ts(typescr
### 工具使用
插件下载路径如下，选择napi_generator_outputs.zip下载。
插件下载路径如下，选择gnapi-0.0.1.vsix下载。
[下载链接](http://ftp.kaihongdigi.com:5000/fsdownload/mKjfCmPjk/generator_outputs_NAPI_0930)
[下载链接1]( http://ftpkaihongdigi.i234.me:5000/sharing/PC6uOorrM)
[下载链接2]( http://ftp.kaihong.com:5000/sharing/PC6uOorrM)
[下载链接3]( http://ftp.kaihongdigi.com:5000/sharing/PC6uOorrM)
具体的工具使用步骤，可以左键单击以下链接了解：
@ -76,7 +80,7 @@ bool TestClass1::if_callback(std::string &v1, std::string &out) {
......
}
```
### 集成方法
为了实现工具生成的接口被其他子系统或者应用调用，需将生成的代码编译集成到OpenHarmony系统中，编译生成动态库。

12
napi_vs_plugin/docs/napi/INSTRUCTION_ZH.md
View File

@ -1,9 +1,13 @@
# NAPI框架生成工具VSCode插件使用说明
## 简介
VS Code插件下载路径如下，选择napi_generator_outputs.zip中gnapi-0.0.1.vsix下载。
VS Code插件下载路径如下，选择gnapi-0.0.1.vsix下载。
[下载链接](http://ftp.kaihongdigi.com:5000/fsdownload/mKjfCmPjk/generator_outputs_NAPI_0930)
[下载链接1]( http://ftpkaihongdigi.i234.me:5000/sharing/PC6uOorrM)
[下载链接2]( http://ftp.kaihong.com:5000/sharing/PC6uOorrM)
[下载链接3]( http://ftp.kaihongdigi.com:5000/sharing/PC6uOorrM)
## VS Code插件使用方法
@ -25,11 +29,11 @@ visual studio code 版本需1.62.0及以上。
![](../../../figures/pic-plug-in-gnapi.png)
4.在VS Code中找到需要转换的.d.ts文件，若.d.ts文件中声明了basic.d.ts文件，将basic.d.ts文件放置在待转换.d.ts文件上一级目录；若除此之外还声明其他.d.ts文件，将此类文件放置在待转换.d.ts文件同级目录。例如：
4.在VS Code中找到需要转换的.d.ts文件，若.d.ts文件中声明了basic.d.ts文件，将basic.d.ts文件放置在待转换.d.ts文件上一级目录；若除此之外还声明其它.d.ts文件，将此类文件放置在待转换.d.ts文件同级目录。例如：
![](../../../figures/pic-plug-in-select-d-ts.png)
5.选择.d.ts文件,点击右键选择 Generate Napi Frame，工具弹出Generate Napi Frame弹窗，选择Napi-Gen页签。接口文件文本框填写.d.ts文件路径；生成框架路径文本框填写生成框架存放路径；编译脚本路径默认填写；number目的类型此处选择float；启用import功能不选择（待转换.d.ts文件未引用其他文件）；点击ok。
5.选择.d.ts文件,点击右键选择 Generate Napi Frame，工具弹出Generate Napi Frame弹窗，选择Napi-Gen页签。接口文件文本框填写.d.ts文件路径；生成框架路径文本框填写生成框架存放路径；编译脚本路径默认填写；number目的类型此处选择float；启用import功能不选择（待转换.d.ts文件未引用其它文件）；点击ok。
![](../../../figures/pic-plug-in-gen-c++.png)