add ts and assist vs plugin docs
Signed-off-by: zhaojunxia <zhaojunxia@kaihong.com>
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 18 KiB |
61
hdc/assist/assist_tools_vs_plugin/README_zh.md
Normal file
@ -0,0 +1,61 @@
|
||||
# ASSIST工具VS Code插件说明
|
||||
|
||||
## 简介
|
||||
|
||||
ASSIST统一入口工具,可以将各南向工具统一起来,用户只需下载统一入口工具,在统一入口工具中按需下载南向工具,实现对工具链的使用。目前工具支持IntelliJ插件和VS Code插件两种入口,本文主要介绍VS Code插件使用说明。
|
||||
|
||||
## 目录
|
||||
|
||||
|
||||
```
|
||||
├── assist
|
||||
│ ├── ... # 其它文件
|
||||
│ ├── assist_tools_vs_plugin # VS Code插件代码
|
||||
│ │ ├── docs # VS Code插件说明
|
||||
│ │ ├── package.json # package.json 文件
|
||||
│ │ ├── src # VS Code插件源码
|
||||
│ │ └── README_zh # VS Code插件说明
|
||||
```
|
||||
|
||||
## 约束
|
||||
|
||||
系统:建议Ubuntu 20.04或者Windows 10
|
||||
|
||||
依赖版本:VS Code 1.62.0
|
||||
|
||||
## 使用方法
|
||||
|
||||
### 工具使用
|
||||
|
||||
插件下载路径如下,选择AssistTools-0.0.1.vsix下载。
|
||||
|
||||
[下载链接1]( 暂无)
|
||||
|
||||
[下载链接2](暂无)
|
||||
|
||||
[下载链接3]( 暂无)
|
||||
|
||||
具体的工具使用步骤,可以左键单击以下链接了解:
|
||||
|
||||
[工具使用说明](https://gitee.com/openharmony/napi_generator/tree/master/hdc/assist/assist_tools_vs_plugin/docs/INSTRUCTION_ZH.md)
|
||||
|
||||
## 开发说明
|
||||
|
||||
### 对象
|
||||
|
||||
工具的开发者
|
||||
|
||||
### 开发场景
|
||||
|
||||
若当前工具的功能已经不能满足开发者的全部需求,则开发者可以基于已有的源码对工具进行二次开发,来增强工具的能力,编译打包生成自定义的插件。
|
||||
|
||||
### 开发步骤
|
||||
|
||||
开发者可以根据如下的步骤来完成对工具VS Code插件的开发:
|
||||
|
||||
[工具开发说明](https://gitee.com/openharmony/napi_generator/tree/master/hdc/assist/assist_tools_vs_plugin/docs/DEVELOP_ZH.md)
|
||||
|
||||
|
||||
## 相关仓
|
||||
|
||||
暂无
|
54
hdc/assist/assist_tools_vs_plugin/docs/DEVELOP_ZH.md
Normal file
@ -0,0 +1,54 @@
|
||||
# ASSIST_TOOLS工具VS Code插件开发说明
|
||||
|
||||
若当前工具功能不满足开发者需求,开发者需增强工具能力,则可基于已有源码进行工具二次开发,编译打包生成自定义的VS Code插件。
|
||||
|
||||
## VS Code插件打包说明
|
||||
|
||||
### Linux
|
||||
|
||||
1.在napi_generator/hdc/assist/assist_tools_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i
|
||||
|
||||
2.在napi_generator/hdc/assist/assist_tools_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i typescript
|
||||
|
||||
3.在napi_generator/hdc/assist/assist_tools_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i vsce
|
||||
|
||||
4.在napi_generator/hdc/assist/assist_tools_vs_plugin/src目录下执行命令:
|
||||
|
||||
npx vsce package
|
||||
|
||||
之后会在当前目录下打包生成一个插件AssistTools-0.0.1.vsix。结果如下:
|
||||
|
||||
kaihong1@ubuntu:~/napi/napi_generator_test0419/napi_generator/hdc/assist/assist_tools_vs_plugin/src$ npx vsce package
|
||||
This extension consists of 2166 files, out of which 1160 are JavaScript files. For performance reasons, you should bundle your extension: https://aka.ms/vscode-bundle-extension . You should also exclude unnecessary files by adding them to your .vscodeignore: https://aka.ms/vscode-vscodeignore
|
||||
DONE Packaged: /home/kaihong1/napi/napi_generator_test0419/napi_generator/hdc/assist/assist_tools_vs_plugin/src/AssistTools-0.0.1.vsix (2166 files, 3MB)
|
||||
|
||||
### Windows
|
||||
|
||||
1.在napi_generator/hdc/assist/assist_tools_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i
|
||||
|
||||
2.在napi_generator/hdc/assist/assist_tools_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i typescript
|
||||
|
||||
3.在napi_generator/hdc/assist/assist_tools_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i vsce
|
||||
|
||||
4.在napi_generator/hdc/assist/assist_tools_vs_plugin/src目录下执行命令:
|
||||
|
||||
npx vsce package
|
||||
|
||||
之后会在当前目录下打包生成一个插件AssistTools-0.0.1.vsix。结果如下:
|
||||
|
||||
E:\napi_generator_aboutTest\zjx_gjj_napi230401\napi_generator\hdc\assist\assist_tools_vs_plugin\src>npx vsce package
|
||||
This extension consists of 2167 files, out of which 1160 are JavaScript files. For performance reasons, you should bundle your extension: https://aka.ms/vscode-bundle-extension . You should also exclude unnecessary files by adding them to your .vscodeignore: https://aka.ms/vscode-vscodeignore
|
||||
DONE Packaged: E:\napi_generator_aboutTest\zjx_gjj_napi230401\napi_generator\hdc\assist\assist_tools_vs_plugin\src\AssistTools-0.0.1.vsix (2167 files, 3.18MB)
|
||||
|
61
hdc/assist/assist_tools_vs_plugin/docs/INSTRUCTION_ZH.md
Normal file
@ -0,0 +1,61 @@
|
||||
# ASSIST_TOOLS工具VS Code插件使用说明
|
||||
## 简介
|
||||
|
||||
VS Code插件下载路径如下:
|
||||
|
||||
[下载链接](暂无)
|
||||
|
||||
## VS Code插件使用方法
|
||||
|
||||
### 说明
|
||||
|
||||
visual studio code 版本需1.62.0及以上。
|
||||
|
||||
### 步骤
|
||||
|
||||
1、 打开VS Code,在左侧边栏中选择插件安装。
|
||||
|
||||
![](../../figures/pic-plug-in-search.png)
|
||||
|
||||
2、 在应用商店搜索assist_tools插件,再单击安装。
|
||||
|
||||
![](../../figures/pic-plug-in-select.png)
|
||||
|
||||
3、 安装完成后就会在VS Code的插件管理器中能看到 Kaihong Assist Tools 这个插件了。
|
||||
|
||||
![](../../figures/pic-plug-in-assist.png)
|
||||
|
||||
4、 右键单击任意文件或文件夹,选择“Kaihong Assist Tools”选项。
|
||||
|
||||
![](../../figures/pic-plug-in-assist-start.png)
|
||||
|
||||
5、 工具打开 Kaihong Assist Tools 窗口,选择是否启用工具链:
|
||||
|
||||
若不启用工具链,选择任意一个工具使用,如,使用API Scan工具,点击 API Scan 图标,再点击Ok, Kaihong Assist Tools将会下载并启动 API Scan工具,工具打开API Scan窗口,扫描项目路径框填写将要扫描项目的路径,结果输出路径框自动填写与扫描项目相同路径,使用者可以根据实际情况修改结果输出路径,然后点击ok。选择其它工具使用与选择 API Scan 工具类似。
|
||||
|
||||
![](../../figures/pic-plug-in-export_toolChain.png)
|
||||
|
||||
若启用工具链,用户根据需求选择工具组成工具链,Kaihong Assist Tools将会下载并启动工具链中的工具供用户使用,如:启用工具链选择“API Scan”,"GN","SERVICE","TS","NAPI"工具组成工具链,然后点击 Ok, Kaihong Assist Tools将会从插件市场下载所有选中的工具,并按照 API Scan -> GN -> SERVICE -> TS -> NAPI 顺序启用工具
|
||||
|
||||
![](../../figures/pic-plug-in-import_toolChain.png)
|
||||
|
||||
首先启用工具 API Scan, 填写相应参数完毕 API Scan 界面后点击Next, 扫描完成,并启动 GN 工具;
|
||||
|
||||
![](../../figures/pic-plug-in-import-api.png)
|
||||
|
||||
进入 GN 工具填写相应参数后点击Next , 生成build_tmp文件夹,build_tmp文件夹中包含BUILD.gn文件,并启动 SERVICE 工具;
|
||||
|
||||
![](../../figures/pic-plug-in-import-gn.png)
|
||||
|
||||
进入 SERVICE 工具填写相应参数后点击Next , 生成service框架代码文件,并启动 TS 工具;
|
||||
|
||||
![](../../figures/pic-plug-in-import-service.png)
|
||||
|
||||
进入 TS 工具填写相应参数后点击Next , 生成.d.ts文件,并启动 NAPI 工具, NAPI工具是工具链中最后一个工具,NAPI工具的输入参数可以是TS工具的输出,填写完相应参数后,点击 Ok, 生成napi框架代码。
|
||||
|
||||
![](../../figures/pic-plug-in-import-ts.png)
|
||||
|
||||
![](../../figures/pic-plug-in-import-napi.png)
|
||||
|
||||
|
||||
|
23
hdc/assist/assist_tools_vs_plugin/src/README.md
Normal file
@ -0,0 +1,23 @@
|
||||
# ASSIST_TOOLS工具使用说明
|
||||
|
||||
## 简介
|
||||
|
||||
ASSIST南向统一入口工具,可以将各南向工具统一起来,用户只需下载统一入口工具,在统一入口工具中按需下载南向工具,实现对工具链的使用。
|
||||
|
||||
## 约束
|
||||
|
||||
visual studio code 版本需1.62.0及以上。
|
||||
|
||||
## 操作简介
|
||||
|
||||
1.安装VS Code插件。
|
||||
|
||||
2.打开任意文件夹或文件,鼠标单击右键选择“Kaihong Assist Tools”插件。
|
||||
|
||||
3.若不启用工具链,则直接点击某一工具等待下载并启用;若启用工具链,选择工具组成工具链使用。
|
||||
|
||||
详细说明见[工具使用说明](https://gitee.com/openharmony/napi_generator/blob/master/hdc/assist/assist_tools_vs_plugin/docs/INSTRUCTION_ZH.md)
|
||||
|
||||
## 合作共建
|
||||
|
||||
[联系方式](https://www.kaihong.com/)
|
@ -3,6 +3,10 @@
|
||||
"displayName": "Kaihong Assist Tools",
|
||||
"description": "This is the Kaihong assistance tools unified entrance for OpenHarmony OS developer.",
|
||||
"version": "0.0.1",
|
||||
"keywords": [
|
||||
"assist_tools",
|
||||
"assist"
|
||||
],
|
||||
"engines": {
|
||||
"vscode": "^1.70.3"
|
||||
},
|
||||
|
BIN
hdc/assist/figures/pic-plug-in-assist-start.png
Normal file
After Width: | Height: | Size: 19 KiB |
BIN
hdc/assist/figures/pic-plug-in-assist.png
Normal file
After Width: | Height: | Size: 47 KiB |
BIN
hdc/assist/figures/pic-plug-in-export_toolChain.png
Normal file
After Width: | Height: | Size: 30 KiB |
BIN
hdc/assist/figures/pic-plug-in-import-api.png
Normal file
After Width: | Height: | Size: 6.6 KiB |
BIN
hdc/assist/figures/pic-plug-in-import-gn.png
Normal file
After Width: | Height: | Size: 20 KiB |
BIN
hdc/assist/figures/pic-plug-in-import-napi.png
Normal file
After Width: | Height: | Size: 15 KiB |
BIN
hdc/assist/figures/pic-plug-in-import-service.png
Normal file
After Width: | Height: | Size: 10 KiB |
BIN
hdc/assist/figures/pic-plug-in-import-ts.png
Normal file
After Width: | Height: | Size: 9.7 KiB |
BIN
hdc/assist/figures/pic-plug-in-import_toolChain.png
Normal file
After Width: | Height: | Size: 19 KiB |
BIN
hdc/assist/figures/pic-plug-in-search.png
Normal file
After Width: | Height: | Size: 38 KiB |
BIN
hdc/assist/figures/pic-plug-in-select.png
Normal file
After Width: | Height: | Size: 16 KiB |
@ -1,4 +1,4 @@
|
||||
# API扫描工具 问题反馈
|
||||
# SERVICE生成工具 问题反馈
|
||||
|
||||
## 问题反馈
|
||||
|
||||
|
BIN
hdc/ts/figures/pic-plug-in-h-c++.png
Normal file
After Width: | Height: | Size: 9.6 KiB |
BIN
hdc/ts/figures/pic-plug-in-h.png
Normal file
After Width: | Height: | Size: 38 KiB |
BIN
hdc/ts/figures/pic-plug-in-search.png
Normal file
After Width: | Height: | Size: 38 KiB |
BIN
hdc/ts/figures/pic-plug-in-select.png
Normal file
After Width: | Height: | Size: 15 KiB |
BIN
hdc/ts/figures/pic-plug-in-ts-gen.png
Normal file
After Width: | Height: | Size: 53 KiB |
130
hdc/ts/ts_vs_plugin/README_zh.md
Normal file
@ -0,0 +1,130 @@
|
||||
# TS生成工具VSCode插件说明
|
||||
|
||||
## 简介
|
||||
|
||||
TS(type-script)接口生成工具,它可以根据定义在c++头文件中的接口,生成type-script语言的TS接口文件。若某个服务实现方式为c++,且供应用层访问的接口已在.h文件中定义,此时,NAPI接口开发者使用此工具可一键生成对应的ts文件,进而将生成的TS文件作为NAPI框架生成代码工具的输入,生成NAPI框架代码。目前工具支持可执行文件、VS Code插件、IntelliJ插件三种入口,本文主要介绍VS Code插件使用指导。
|
||||
|
||||
## 目录
|
||||
|
||||
├── ts # TS框架生成工具
|
||||
│ ├── ... # 其它文件
|
||||
│ ├── ts_vs_plugin # VS Code插件代码
|
||||
│ │ ├── docs # VS Code插件说明
|
||||
│ │ ├── src # VS Code插件源码
|
||||
│ │ ├── package.json # package.json 文件
|
||||
│ │ └── README_zh.md # VS Code插件说明
|
||||
|
||||
## 约束
|
||||
|
||||
系统:建议Ubuntu 20.04或者Windows 10
|
||||
|
||||
依赖版本:VS Code 1.62.0
|
||||
|
||||
## 使用方法
|
||||
|
||||
### 使用对象
|
||||
|
||||
系统开发者、应用Native开发者
|
||||
|
||||
### 使用场景
|
||||
|
||||
1) 系统框架层新增子系统,需对应用层提供接口。
|
||||
2) 系统框架层子系统能力增强后,需对应用层提供新接口。
|
||||
3) 应用层引入C++三方库,需增加OpenHarmony应用层接口。
|
||||
|
||||
### 工具使用
|
||||
|
||||
插件下载路径如下,选择ts-gen-0.0.1.vsix下载。
|
||||
|
||||
[下载链接1](暂无)
|
||||
|
||||
[下载链接2](暂无)
|
||||
|
||||
[下载链接3](暂无)
|
||||
|
||||
具体的工具使用步骤,可以左键单击以下链接了解:
|
||||
|
||||
[工具使用说明](https://gitee.com/openharmony/napi_generator/tree/master/hdc/ts/ts_vs_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"文件,定义了应用开发接口,如下所示:
|
||||
|
||||
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;
|
||||
|
||||
## 开发说明
|
||||
|
||||
### 对象
|
||||
|
||||
工具的开发者
|
||||
|
||||
### 开发场景
|
||||
|
||||
若当前工具的功能已经不能满足开发者的全部需求,则开发者可以基于已有的源码对工具进行二次开发,来增强工具的能力,编译打包生成自定义的可执行文件和插件。
|
||||
|
||||
### 开发步骤
|
||||
|
||||
开发者可以根据如下的步骤来完成对工具VS Code插件的开发:
|
||||
|
||||
[工具开发说明](https://gitee.com/openharmony/napi_generator/tree/master/hdc/ts/ts_vs_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)
|
||||
|
||||
## 相关仓
|
||||
|
||||
暂无
|
70
hdc/ts/ts_vs_plugin/docs/DEVELOP_ZH.md
Normal file
@ -0,0 +1,70 @@
|
||||
# TS接口生成工具VSCode插件开发说明
|
||||
|
||||
若当前工具功能不满足开发者需求,开发者需增强工具能力,则可基于已有源码进行工具二次开发,编译打包生成自定义的VS Code插件。
|
||||
|
||||
## VS Code插件打包说明
|
||||
|
||||
### Linux
|
||||
|
||||
1.下载napi_generator-linux可执行程序与linux系统下header_parser.exe可执行程序,并放置在napi_generator/hdc/ts/ts_vs_plugin/src/目录下,下载链接如下:
|
||||
|
||||
[下载链接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.在napi_generator/hdc/ts/ts_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i
|
||||
|
||||
3.在napi_generator/hdc/ts/ts_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i typescript
|
||||
|
||||
4.在napi_generator/hdc/ts/ts_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i vsce
|
||||
|
||||
5.在napi_generator/hdc/ts/ts_vs_plugin/src目录下执行命令:
|
||||
|
||||
npx vsce package
|
||||
|
||||
之后会在当前目录下打包生成一个插件ts-gen-0.0.1.vsix。结果如下:
|
||||
|
||||
kaihong1@ubuntu:~/napi/napi_generator_test0419/napi_generator/hdc/ts/ts_vs_plugin/src$ npx vsce package
|
||||
This extension consists of 3212 files, out of which 1547 are JavaScript files. For performance reasons, you should bundle your extension: https://aka.ms/vscode-bundle-extension . You should also exclude unnecessary files by adding them to your .vscodeignore: https://aka.ms/vscode-vscodeignore
|
||||
DONE Packaged: /home/kaihong1/napi/napi_generator_test0419/napi_generator/hdc/ts/ts_vs_plugin/src/ts-gen-0.0.1.vsix (3370 files, 44.42MB)
|
||||
|
||||
### Windows
|
||||
|
||||
1.下载napi_generator-win.exe可执行程序与Windows系统下header_parser.exe可执行程序,并放置在napi_generator/napi_vs_plugin/src/目录下。
|
||||
|
||||
[下载链接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.在napi_generator/hdc/ts/ts_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i
|
||||
|
||||
3.在napi_generator/hdc/ts/ts_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i typescript
|
||||
|
||||
4.在napi_generator/hdc/ts/ts_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i vsce
|
||||
|
||||
5.在napi_generator/hdc/ts/ts_vs_plugin/src目录下执行命令:
|
||||
|
||||
npx vsce package
|
||||
|
||||
之后会在当前目录下打包生成一个插件ts-gen-0.0.1.vsix。结果如下:
|
||||
|
||||
E:\napi_generator_aboutTest\zjx_gjj_napi230401\napi_generator\hdc\ts\ts_vs_plugin\src>npx vsce package
|
||||
This extension consists of 3218 files, out of which 1547 are JavaScript files. For performance reasons, you should bundle your extension: https://aka.ms/vscode-bundle-extension . You should also exclude unnecessary files by adding them to your .vscodeignore: https://aka.ms/vscode-vscodeignore
|
||||
DONE Packaged: E:\napi_generator_aboutTest\zjx_gjj_napi230401\napi_generator\hdc\ts\ts_vs_plugin\src\ts-gen-0.0.1.vsix (3467 files, 42.3MB)
|
||||
|
37
hdc/ts/ts_vs_plugin/docs/INSTRUCTION_ZH.md
Normal file
@ -0,0 +1,37 @@
|
||||
# Ts接口生成工具VSCode插件使用说明
|
||||
## 简介
|
||||
|
||||
VS Code插件下载路径如下,选择napi_generator_outputs.zip中ts-gen-0.0.1.vsix下载。
|
||||
|
||||
[下载链接](暂无)
|
||||
|
||||
## VS Code插件使用方法
|
||||
|
||||
### 说明
|
||||
|
||||
visual studio code 版本需1.62.0及以上。
|
||||
|
||||
### 使用指导
|
||||
|
||||
1.打开VS Code,在左侧边栏中选择插件安装。
|
||||
|
||||
![](../../figures/pic-plug-in-search.png)
|
||||
|
||||
2. 在应用商店搜索ts-gen插件,再单击安装。
|
||||
|
||||
![](../../figures/pic-plug-in-select.png)
|
||||
|
||||
3.安装完成后就会在VS Code的插件管理器中能看到ts-gen这个插件了。
|
||||
|
||||
![](../../figures/pic-plug-in-ts-gen.png)
|
||||
|
||||
4.把需要转换的.h文件放到任意目录下。
|
||||
|
||||
![](../../figures/pic-plug-in-h.png)
|
||||
|
||||
5.选择.h文件,点击右键选择 Generate Ts Frame,工具弹出Generate Ts Frame弹窗。文件路径文本框填写.h文件路径;输出目录选择文本框填写生成.d.ts文件存放路径,点击ok。
|
||||
|
||||
![](../../figures/pic-plug-in-h-c++.png)
|
||||
|
||||
6.执行结束后会在out目录下生成.d.ts代码文件。
|
||||
|
25
hdc/ts/ts_vs_plugin/src/README.md
Normal file
@ -0,0 +1,25 @@
|
||||
# TS生成工具使用说明
|
||||
|
||||
## 简介
|
||||
|
||||
TS(type-script)接口生成工具,它可以根据定义在c++头文件中的接口,生成type-script语言的TS接口文件。若某个服务实现方式为c++,且供应用层访问的接口已在.h文件中定义,此时,NAPI接口开发者使用此工具可一键生成对应的ts文件,进而将生成的TS文件作为NAPI框架生成代码工具的输入,生成NAPI框架代码。
|
||||
|
||||
## 约束
|
||||
|
||||
visual studio code 版本需1.62.0及以上。
|
||||
|
||||
## 操作简介
|
||||
|
||||
1.安装VS Code插件。
|
||||
|
||||
2.打开任意文件夹或文件,鼠标单击右键选择“Generate Ts Frame”插件。
|
||||
|
||||
3.在窗口中填写相应参数。
|
||||
|
||||
详细说明见
|
||||
|
||||
[TS接口生成使用说明](https://gitee.com/openharmony/napi_generator/blob/master/hdc/ts/ts_vs_plugin/docs/INSTRUCTION_ZH.md)
|
||||
|
||||
## 合作共建
|
||||
|
||||
[联系方式](https://www.kaihong.com/)
|
@ -33,7 +33,7 @@ visual studio code 版本需1.62.0及以上。
|
||||
|
||||
![](../../../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弹窗。接口文件文本框填写.d.ts文件路径;生成框架路径文本框填写生成框架存放路径;编译脚本路径默认填写;number目的类型此处选择float;启用import功能不选择(待转换.d.ts文件未引用其它文件);点击ok。
|
||||
|
||||
![](../../../figures/pic-plug-in-gen-c++.png)
|
||||
|
||||
|
@ -1,74 +0,0 @@
|
||||
# TS接口生成工具VSCode插件开发说明
|
||||
|
||||
若当前工具功能不满足开发者需求,开发者需增强工具能力,则可基于已有源码进行工具二次开发,编译打包生成自定义的VS Code插件。
|
||||
|
||||
## VS Code插件打包说明
|
||||
|
||||
### Linux
|
||||
|
||||
1.下载napi_generator-linux可执行程序与linux系统下header_parser.exe可执行程序,并放置在napi_generator/napi_vs_plugin/src/目录下,下载链接如下:
|
||||
|
||||
[下载链接](http://ftp.kaihongdigi.com:5000/fsdownload/mKjfCmPjk/generator_outputs_NAPI_0930)
|
||||
|
||||
2.在napi_generator/napi_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i
|
||||
|
||||
3.在napi_generator/napi_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i typescript
|
||||
|
||||
4.在napi_generator/napi_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i vsce
|
||||
|
||||
5.在napi_generator/napi_vs_plugin/src目录下执行命令:
|
||||
|
||||
npx vsce package
|
||||
|
||||
每个选项都选择y,然后回车,最终会在当前目录下打包生成一个插件gnapi-0.0.1.vsix。结果如下:
|
||||
|
||||
harmony@Ubuntu-64:~/napi/napi_generator_5/napi_vs_plugin/src$ npx vsce package
|
||||
WARNING A 'repository' field is missing from the 'package.json' manifest file.
|
||||
Do you want to continue? [y/N] y
|
||||
WARNING Using '*' activation is usually a bad idea as it impacts performance.
|
||||
More info: https://code.visualstudio.com/api/references/activation-events#Start-up
|
||||
Do you want to continue? [y/N] y
|
||||
WARNING LICENSE.md, LICENSE.txt or LICENSE not found
|
||||
Do you want to continue? [y/N] y
|
||||
This extension consists of 3370 files, out of which 1627 are JavaScript files. For performance reasons, you should bundle your extension: https://aka.ms/vscode-bundle-extension . You should also exclude unnecessary files by adding them to your .vscodeignore: https://aka.ms/vscode-vscodeignore
|
||||
DONE Packaged: /home/harmony/napi/napi_generator_5/napi_vs_plugin/src/gnapi-0.0.1.vsix (3370 files, 44.42MB)
|
||||
|
||||
### Windows
|
||||
|
||||
1.下载napi_generator-win.exe可执行程序与Windows系统下header_parser.exe可执行程序,并放置在napi_generator/napi_vs_plugin/src/目录下。
|
||||
|
||||
2.在napi_generator/napi_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i
|
||||
|
||||
3.在napi_generator/napi_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i typescript
|
||||
|
||||
4.在napi_generator/napi_vs_plugin/src目录下执行命令:
|
||||
|
||||
npm i vsce
|
||||
|
||||
5.在napi_generator/napi_vs_plugin/src目录下执行命令:
|
||||
|
||||
npx vsce package
|
||||
|
||||
每个选项都选择y,然后回车,最终会在当前目录下打包生成一个插件gnapi-0.0.1.vsix。结果如下:
|
||||
|
||||
E:\napi_generator\napi_vs_plugin\src>npx vsce package
|
||||
WARNING A 'repository' field is missing from the 'package.json' manifest file.
|
||||
Do you want to continue? [y/N] y
|
||||
WARNING Using '*' activation is usually a bad idea as it impacts performance.
|
||||
More info: https://code.visualstudio.com/api/references/activation-events#Start-up
|
||||
Do you want to continue? [y/N] y
|
||||
WARNING LICENSE.md, LICENSE.txt or LICENSE not found
|
||||
Do you want to continue? [y/N] y
|
||||
This extension consists of 3467 files, out of which 1692 are JavaScript files. For performance reasons, you should bundle your extension: https://aka.ms/vscode-bundle-extension . You should also exclude unnecessary files by adding them to your .vscodeignore: https://aka.ms/vscode-vscodeignore
|
||||
DONE Packaged: E:\napi_generator\napi_vs_plugin\src\gnapi-0.0.1.vsix (3467 files, 42.3MB)
|
||||
|
@ -1,37 +0,0 @@
|
||||
# Ts接口生成工具VSCode插件使用说明
|
||||
## 简介
|
||||
|
||||
VS Code插件下载路径如下,选择napi_generator_outputs.zip中gnapi-0.0.1.vsix下载。
|
||||
|
||||
[下载链接](http://ftp.kaihongdigi.com:5000/fsdownload/mKjfCmPjk/generator_outputs_NAPI_0930)
|
||||
|
||||
## VS Code插件使用方法
|
||||
|
||||
### 说明
|
||||
|
||||
visual studio code 版本需1.62.0及以上。
|
||||
|
||||
### 使用指导
|
||||
|
||||
1.打开VS Code,在左侧边栏中选择插件安装。
|
||||
|
||||
![](../../../figures/pic-plug-in-search.png)
|
||||
|
||||
2.在应用商店搜索NAPI插件,再单击安装。
|
||||
|
||||
![](../../../figures/pic-plug-in-select.png)
|
||||
|
||||
3.安装完成后就会在VS Code的插件管理器中能看到napi-gen这个插件了。
|
||||
|
||||
![](../../../figures/pic-plug-in-gnapi.png)
|
||||
|
||||
4.把需要转换的.h文件放到任意目录下。
|
||||
|
||||
![](../../../figures/pic-plug-in-h.png)
|
||||
|
||||
5.选择.h文件,点击右键选择 Generate Napi Frame,工具弹出Generate Napi Frame弹窗,选择Ts-Gen页签。文件路径文本框填写.h文件路径;输出目录选择文本框填写生成.d.ts文件存放路径,点击ok。
|
||||
|
||||
![](../../../figures/pic-plug-in-h-c++.png)
|
||||
|
||||
6.执行结束后会在out目录下生成.d.ts代码文件。
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
## 简介
|
||||
|
||||
当前工具支持TS接口生成和NAPI框架代码生成:TS(type-script)接口生成工具,它可以根据定义在c++头文件中的接口,生成type-script语言的TS接口文件。若某个服务实现方式为c++,且供应用层访问的接口已在.h文件中定义,此时,NAPI接口开发者使用此工具可一键生成对应的ts文件,进而将生成的TS文件作为NAPI框架生成代码工具的输入,生成NAPI框架代码。串行使用ts接口生成工具、NAPI框架代码生成工具,形成工具链,达到降低NAPI接口开发难度,提高开发效率。
|
||||
NAPI框架代码生成工具,它可以根据用户指定路径下的ts(typescript)接口文件一键生成NAPI框架代码、业务代码框架、GN文件等。
|
||||
|
||||
## 约束
|
||||
|
||||
@ -12,13 +12,13 @@ visual studio code 版本需1.62.0及以上。
|
||||
|
||||
1.安装VS Code插件。
|
||||
|
||||
2.打开任意文件夹或文件,鼠标单击右键选择“Napi Generate Frame”插件。
|
||||
2.打开任意文件夹或文件,鼠标单击右键选择“Generate Napi Frame”插件。
|
||||
|
||||
3.在窗口中填写相应参数。
|
||||
|
||||
详细说明见
|
||||
1. [NAPI框架代码生成使用说明](https://gitee.com/openharmony/napi_generator/blob/master/napi_vs_plugin/docs/napi/INSTRUCTION_ZH.md)
|
||||
2. [TS接口生成使用说明](https://gitee.com/openharmony/napi_generator/blob/master/napi_vs_plugin/docs/ts/INSTRUCTION_ZH.md)
|
||||
|
||||
[NAPI框架代码生成使用说明](https://gitee.com/openharmony/napi_generator/blob/master/napi_vs_plugin/docs/napi/INSTRUCTION_ZH.md)
|
||||
|
||||
## 合作共建
|
||||
|
||||
|