style: add assist_tools_IntelliJ_plugin docs and move ts_IntelliJ_plugin docs

Signed-off-by: zhaojunxia <zhaojunxia@kaihong.com>
This commit is contained in:
zhaojunxia 2023-04-07 11:57:57 +08:00
parent cf30942127
commit bab915878a
58 changed files with 339 additions and 74 deletions

View File

@ -136,4 +136,4 @@ ts工具框架由C++语法解释器和代码生成器两部分组成。C++语法
具体的插件开发步骤,可以左键单击以下链接了解:
[IntelliJ插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/napi_IntelliJ_plugin/docs/ts/DEVELOP_ZH.md)
[IntelliJ插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/hdc/ts/ts_IntelliJ_plugin/docs/ts/DEVELOP_ZH.md)

View File

@ -95,4 +95,4 @@ Ts接口生成工具支持两种入口分别是可执行程序、IntelliJ插
具体的插件使用步骤,可以左键单击以下链接了解:
[IntelliJ插件使用说明](https://gitee.com/openharmony/napi_generator/tree/master/napi_IntelliJ_plugin/docs/ts/INSTRUCTION_ZH.md)
[IntelliJ插件使用说明](https://gitee.com/openharmony/napi_generator/tree/master/hdc/ts/ts_IntelliJ_plugin/docs/ts/INSTRUCTION_ZH.md)

View File

@ -39,7 +39,7 @@ ASSIST统一入口工具可以将各北向工具统一起来用户只需
具体的工具使用步骤,可以左键单击以下链接了解:
[工具使用说明](暂无)
[工具使用说明](https://gitee.com/openharmony/napi_generator/tree/master/hdc/assist/assist_tools_IntelliJ_plugin/docs/INSTRUCTION_ZH.md)
## 开发说明
@ -55,7 +55,7 @@ ASSIST统一入口工具可以将各北向工具统一起来用户只需
开发者可以根据如下的步骤来完成对工具IntelliJ插件的开发
[工具开发说明](暂无)
[工具开发说明](https://gitee.com/openharmony/napi_generator/tree/master/hdc/assist/assist_tools_IntelliJ_plugin/docs/DEVELOP_ZH.md)
## 相关仓

View File

@ -0,0 +1,59 @@
# ASSIST_TOOLS工具IntelliJ插件开发说明
若当前工具功能不满足开发者需求开发者需增强工具能力则可基于已有源码进行工具二次开发编译打包生成自定义的IntelliJ插件。
## IntelliJ插件打包说明
### 环境说明
系统建议Windows 10
### 开发步骤
#### 环境准备
1.下载并安装IDEA Community、JDK11配置好环境。IDEA Community版本可以左键单击以下链接下载。
[下载链接](https://www.jetbrains.com/idea/download/)
2.打开IDEA Community应用程序。
依次点击项目File>Open 选择napi_generator/hdc/assist/assist_tools_IntelliJ_plugin项目文件夹。
![](../../figures/IntelliJ_env_config_open_proj.png)
3.项目打开完成点击File>Project Structure,在出现的界面中点击Project,下图的SDK选择JDK 11Language level也选择版本11选择或者新建complier output目录为项目文件下的out目录。
![](../../figures/IntelliJ_env_proj_structure.png)
4.Project Settings > Modules 新建Modules。点击上方“-”删除原有的Modules然后点击“+”选择 New Module。
![](../../figures/IntelliJ_env_Proj_Module.png)
5.在New Module对话框中选择IntelliJ Platform Plugin。若Module SDK中无可选SDK请在Module SDK 下拉框中点击 Add IntelliJ Platform Plugin SDK 选择IDEA Community安装目录点击OK,在Select Internal Java Platform 选择 JAVA SDK 11213版本只支持 11)点击New Module对话框中Next。
![](../../figures/IntelliJ_env_Proj_Module_New.png)
6.Content root选择~/napi_generator/napi_IntelliJ_plugin文件夹module name填写generator。点击Finish若出现提示已存在是否覆盖的提示请点“Yes”完成配置。
![](../../figures/IntelliJ_env_module_root.png)
7.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)
8.在SDKs->IntelliJ IDEA Community 2021.3.3->Classpath下导入程序需要的依赖napi_generator.jar包和ts_generator.jar包
![](../../figures/IntelliJ_env_config_SDKs_Classpath.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框中点击okjar包生成完成后在工具右下角提示jar包生成成功且包含jar包存放位置。
![](../../figures/IntelliJ_env_built_jar.png)
![](../../figures/IntelliJ_env_select_moudles.png)
![](../../figures/IntelliJ_env_built_jar_success.png)

View File

@ -0,0 +1,71 @@
# ASSIST_TOOLS工具IntelliJ插件使用说明
## 简介
Assist_tools工具目前支持一种入口即IntelliJ插件本文主要介绍IntelliJ插件使用说明。IntelliJ插件下载路径如下选择generator.jar下载。
[下载链接1](暂无)
[下载链接2](暂无)
[下载链接3](暂无)
## IntelliJ插件使用方法
### 依赖
系统建议Windows 10
开发工具DevEco Studio
### 使用指导
1.新建或打开项目工程,以下以新建项目工程为例。
File->New->Create Project。
![](../../figures/DevEco_step_newFile.png)
Ability Template选择Empty Ability,单击Next。
![](../../figures/DevEco_step_firstNext.png)
填写Project name、Save location,其它选项可不修改单击Finish,新的工程就创建好了。
![](../../figures/DevEco_step_finish.png)
2.安装插件File->Settings->Plugins->Installed->Install Plugin from Disk...选择下载的generator.jar安装成功之后重启IDE。
![](../../figures/DevEco_step_pluginsOk.png)
![](../../figures/DevEco_step_napiPlugins.png)
3.点击Tools->Assist Tools工具弹出统一入口窗口
![](../../figures/DevEco_step_assist.png)
![](../../figures/DevEco_step_assist_frame.png)
4.点击NAPI然后点击Next工具弹出Generate Napi Frame弹窗。接口文件文本框填写.d.ts文件路径生成框架路径文本框填写生成框架存放路径编译脚本路径填写生成CMakeList.txt文件输出路径number目的类型此处选择char启用import功能不选择待转换.d.ts文件未引用其它文件点击ok执行结束后将会在输出路径下生成napi框架文件。
![](../../figures/DevEco_step_assist_napiGenerate.png)
![](../../figures/DevEco_step_assist_napiGenerateSuccess.png)
5.点击H2Ts若不启用工具链则直接点击Next工具弹出Generate Ts Frame弹窗。文件路径文本框填写.h文件路径输出目录选择文本框填写生成.d.ts文件存放路径点击ok执行结束后将会在输出路径下生成ts框架文件。
![](../../figures/DevEco_step_assist_tsGenerate.png)
![](../../figures/DevEco_step_assist_tsGenerateSuccess.png)
若启用工具链点击启用工具链按钮选择启用工具链所需的工具至少选择两个工具点击Next将会弹出Generate Ts Farme弹窗文件路径文本框填写.h文件路径输出目录选择文本框填写生成.d.ts文件存放路径点击Next将会生成.d.ts文件接着会弹出Generate Napi Frame弹窗弹窗中自动填入.h文件生成的.d.ts文件路径点击ok执行结束后将会在输出路径下生成napi框架文件。
![](../../figures/DevEco_step_assist_importToolChain.png)
![](../../figures/DevEco_step_assist_tsNapiGenerate.png)
![](../../figures/DevEco_step_assist_tsNapiGenerate2.png)
![](../../figures/DevEco_step_assist_napiGenerateSuccess.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 274 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 274 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

View File

@ -0,0 +1,131 @@
# TS框架生成工具IntelliJ插件说明
## 简介
ts(type-script)接口生成工具它可以根据定义在c++头文件中的接口生成type-script语言的ts接口文件。目前工具支持可执行文件、IntelliJ插件两种入口本文主要介绍IntelliJ插件使用说明。
## 目录
├── ts # TS框架代码生成工具
│ ├── ... # 其它文件
│ ├── ts_IntelliJ_plugin # IntelliJ插件代码
│ │ ├── docs # IntelliJ插件说明
│ │ ├── resources # IntelliJ插件说明
│ │ ├── src # IntelliJ插件源码
│ │ └── README_zh # IntelliJ插件说明
## 约束
系统建议Windows 10
依赖版本JDK 11
开发工具DevEco stdio、IDEA Community 2021.3.3
## 使用方法
### 使用对象
系统开发者、应用Native开发者
### 使用场景
1) 系统框架层新增子系统,需对应用层提供接口。
2) 系统框架层子系统能力增强后,需对应用层提供新接口。
3) 应用层引入C++三方库需增加OpenHarmony应用层接口。
### 工具使用
插件下载路径如下选择generator.jar下载。
[下载链接1]( http://ftpkaihongdigi.i234.me:5000/sharing/PC6uOorrM)
[下载链接2]( http://ftp.kaihong.com:5000/sharing/PC6uOorrM)
[下载链接3]( http://ftp.kaihongdigi.com:5000/sharing/PC6uOorrM)
具体的工具使用步骤,可以左键单击以下链接了解:
[工具使用说明](https://gitee.com/openharmony/napi_generator/tree/master/hdc/ts/ts_IntelliJ_plugin/docs/INSTRUCTION_ZH.md)
### 工具输出
根据使用者指定的.h文件工具会输出对应的ts接口文件。为了方便使用者快速上手工具可供测试的test.h文件样例如下
```
#include < string >
#include < vector >
using namespace std;
class TestA {
public:
char16_t string1;
void add(string v, long double v1[]);
};
double count(double v, double v1[]);
namespace Space {
class TestBB {
public:
short string4;
bool ifExist(bool v, bool v1[]);
};
uint32_t max(uint32_t v, uint32_t v1[]);
}
```
在window环境下的根据输入文件test.h,生成的输出文件,如下所示:![](../figures/h-2-ts-succ.png)
其中生成的"test.d.ts"文件,定义了应用开发接口,如下所示:
```c++
declare class TestA {
string1: string;
add(v: string, v1: Array<number>): void;
}
declare namespace Space {
function max(v: number, v1: Array<number>): number;
class TestBB {
string4: number;
ifExist(v: boolean, v1: Array<boolean>): boolean;
}
}
declare function count(v: number, v1: Array<number>): number;
export default Space;
```
## 开发说明
### 对象
工具的开发者
### 开发场景
若当前工具的功能已经不能满足开发者的全部需求,则开发者可以基于已有的源码对工具进行二次开发,来增强工具的能力,编译打包生成自定义的可执行文件和插件。
### 开发步骤
开发者可以根据如下的步骤来完成对工具IntelliJ插件的开发
[工具开发说明](https://gitee.com/openharmony/napi_generator/tree/master/hdc/ts/ts_IntelliJ_plugin/docs/DEVELOP_ZH.md)
## 版本说明
当前版本已支持的特性和待开发的特性,如下所示:
[已支持特性](https://gitee.com/openharmony/napi_generator/blob/master/docs/ts/ts_Gen-1.0.md)
[待支持特性](https://gitee.com/openharmony/napi_generator/blob/master/docs/ts/ROADMAP_ZH.md)
## FAQ
对于常见问题解决方法指导如下:
[FAQ](https://gitee.com/openharmony/napi_generator/tree/master/docs/ts/FAQ.md)
## 相关仓
暂无

View File

@ -25,39 +25,43 @@
[下载链接](https://www.jetbrains.com/idea/download/)
3.打开IDEA Community应用程序。
依次点击项目File>Open 选择napi_generator/napi_IntelliJ_plugin项目文件夹。
依次点击项目File>Open 选择napi_generator/hdc/ts/ts_IntelliJ_plugin项目文件夹。
![](../../../figures/IntelliJ_env_config_open_proj.png)
![](../../figures/IntelliJ_env_config_open_proj.png)
4.项目打开完成点击File>Project Structure,在出现的界面中点击Project,下图的SDK选择JDK 11Language level也选择版本11选择或者新建complier output目录为项目文件下的out目录。
![](../../../figures/IntelliJ_env_proj_structure.png)
![](../../figures/IntelliJ_env_proj_structure.png)
5.Project Settings > Modules 新建Modules。点击上方“-”删除原有的Modules然后点击“+”选择 New Module。
![](../../../figures/IntelliJ_env_Proj_Module.png)
![](../../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 11213版本只支持 11)点击New Module对话框中Next。
![](../../../figures/IntelliJ_env_Proj_Module_New.png)
![](../../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)
7.Content root选择~/napi_generator/hdc/ts/ts_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)
![](../../figures/IntelliJ_env_config_SDKs.png)
9.若完成以上步骤配置点击OK完成配置。Rebuild项目若IDEA不能点击右上角的运行点击Plugin后下三角选择Edit Configurations...选项Run/Debug Configurations框中Use classpath of moudle选择generator点击ok等待安装完成。
9.在SDKs->IntelliJ IDEA Community 2021.3.3->Classpath下导入程序需要的依赖napi_generator.jar包
![](../../../figures/IntelliJ_env_configurations.png)
![](../../figures/IntelliJ_env_config_SDKs_Classpath.png)
![](../../../figures/IntelliJ_env_run_debug.png)
10.若完成以上步骤配置点击OK完成配置。Rebuild项目若IDEA不能点击右上角的运行点击Plugin后下三角选择Edit Configurations...选项Run/Debug Configurations框中Use classpath of moudle选择generator点击ok等待安装完成。
10.点击Intellij IDEA工具右上角Built Project按钮等待工程built完成。
![](../../figures/IntelliJ_env_configurations.png)
![](../../../figures/IntelliJ_env_built_pro.png)
![](../../figures/IntelliJ_env_run_debug.png)
11.在IDEA Community中依次点击Build>Prepare All Plugin Modules for development"然后在Select Modules框中点击okjar包生成完成后在工具右下角提示jar包生成成功且包含jar包存放位置
11.点击Intellij IDEA工具右上角Built Project按钮等待工程built完成
![](../../../figures/IntelliJ_env_built_jar.png)
![](../../figures/IntelliJ_env_built_pro.png)
![](../../../figures/IntelliJ_env_select_moudles.png)
12.在IDEA Community中依次点击Build>Prepare All Plugin Modules for development"然后在Select Modules框中点击okjar包生成完成后在工具右下角提示jar包生成成功且包含jar包存放位置。
![](../../../figures/IntelliJ_env_built_jar_success.png)
![](../../figures/IntelliJ_env_built_jar.png)
![](../../figures/IntelliJ_env_select_moudles.png)
![](../../figures/IntelliJ_env_built_jar_success.png)

View File

@ -1,53 +1,53 @@
# Ts接口生成工具IntelliJ插件使用说明
## 简介
Ts接口生成工具目前支持两种入口分别是可执行程序、IntelliJ插件本文主要介绍IntelliJ插件使用说明。IntelliJ插件下载路径如下选择generator.jar下载。
[下载链接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插件使用方法
### 依赖
系统建议Windows 10
开发工具DevEco Studio
### 使用指导
1.新建或打开项目工程,以下以新建项目工程为例。
File->New->Create Project。
![](../../../figures/DevEco_step_newFile.png)
Ability Template选择Empty Ability,单击Next。
![](../../../figures/DevEco_step_firstNext.png)
填写Project name、Save location,其它选项可不修改单击Finish,新的工程就创建好了。
![](../../../figures/DevEco_step_finish.png)
2.安装插件File->Settings->Plugins->Installed->Install Plugin from Disk...选择下载的generator.jar安装成功之后重启IDE。
![](../../../figures/DevEco_step_pluginsOk.png)
![](../../../figures/DevEco_step_napiPlugins.png)
3.把需要转换的.h文件放在DevEco stdio新建项目的src目录下。
![](../../../figures/DevEco_step_ts.png)
4.选择.h文件,点击右键选择Generate Napi Frame工具弹出Generate Napi Frame弹窗,选择Ts-Gen页签。文件路径文本框填写.h文件路径输出目录选择文本框填写生成.d.ts文件存放路径点击ok。
![](../../../figures/DevEco_step_tsGenerate.png)
![](../../../figures/DevEco_step_ts_ok.png)
5.执行结束后会在out目录下生成.d.ts代码文件。
# Ts接口生成工具IntelliJ插件使用说明
## 简介
Ts接口生成工具目前支持两种入口分别是可执行程序、IntelliJ插件本文主要介绍IntelliJ插件使用说明。IntelliJ插件下载路径如下选择generator.jar下载。
[下载链接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插件使用方法
### 依赖
系统建议Windows 10
开发工具DevEco Studio
### 使用指导
1.新建或打开项目工程,以下以新建项目工程为例。
File->New->Create Project。
![](../../figures/DevEco_step_newFile.png)
Ability Template选择Empty Ability,单击Next。
![](../../figures/DevEco_step_firstNext.png)
填写Project name、Save location,其它选项可不修改单击Finish,新的工程就创建好了。
![](../../figures/DevEco_step_finish.png)
2.安装插件File->Settings->Plugins->Installed->Install Plugin from Disk...选择下载的generator.jar安装成功之后重启IDE。
![](../../figures/DevEco_step_pluginsOk.png)
![](../../figures/DevEco_step_napiPlugins.png)
3.把需要转换的.h文件放在DevEco stdio新建项目的src目录下。
![](../../figures/DevEco_step_ts.png)
4.选择.h文件,点击右键选择Generate Ts Frame工具弹出Generate Ts Frame弹窗,选择Ts-Gen页签。文件路径文本框填写.h文件路径输出目录选择文本框填写生成.d.ts文件存放路径点击ok。
![](../../figures/DevEco_step_tsGenerate.png)
![](../../figures/DevEco_step_ts_ok.png)
5.执行结束后会在输出目录下生成.d.ts代码文件。