style: modify api_scan, napi, ts, service docs about way to install vs plugin
Signed-off-by: zhaojunxia <zhaojunxia@kaihong.com>
zhaojunxia
@ -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/napi_IntelliJ_plugin/docs/ts/DEVELOP_ZH.md)
|
||||
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 67 KiB |
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 18 KiB |
@ -17,7 +17,7 @@ visual studio code 版本需1.62.0及以上。
|
||||
|
||||
|
||||
|
||||
2、 单击上面三个点的按钮，选择从VSIX安装选项，然后选择刚才生成的ApiScan-0.0.1.vsix插件文件，再单击安装。
|
||||
2、 在应用商店搜索api_scan插件，再单击安装。
|
||||
|
||||
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 49 KiB |
|
Before Width: | Height: | Size: 8.7 KiB After Width: | Height: | Size: 12 KiB |
@ -17,11 +17,11 @@ visual studio code 版本需1.62.0及以上。
|
||||
|
||||
|
||||
|
||||
2、 单击上面三个点的按钮，选择从VSIX安装选项，然后选择刚才生成的service-0.0.1.vsix插件文件，再单击安装。
|
||||
2、 在应用商店搜索service-gen插件，再单击安装。
|
||||
|
||||
|
||||
|
||||
3、 安装完成后就会在VS Code的插件管理器中能看到service这个插件了。
|
||||
3、 安装完成后就会在VS Code的插件管理器中能看到service-gen这个插件了。
|
||||
|
||||
|
||||
|
||||
@ -29,11 +29,11 @@ visual studio code 版本需1.62.0及以上。
|
||||
|
||||
|
||||
|
||||
5、 右键单击.h文件，选择“ Generate Service Frame”选项。
|
||||
5、 右键单击.h文件，选择“ Service Generate Frame”选项。
|
||||
|
||||
|
||||
|
||||
6、 工具打开 Generate Service Frame窗口，.h文件选择框默认填写被操作的.h文件的绝对路径；输出路径选择框默认填写.h文件所在文件夹路径，可修改为任意路径；serviceID默认填写9000，可修改为其他id，然后点击ok。
|
||||
6、 工具打开 Service Generate Frame窗口，.h文件选择框默认填写被操作的.h文件的绝对路径；输出路径选择框默认填写.h文件所在文件夹路径，可修改为任意路径；serviceID范围是1-16777215之间的整数，超出范围会提示错误，填入正确的serviceID，然后点击ok。
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,59 +0,0 @@
|
||||
# TS工具IntelliJ插件开发说明
|
||||
|
||||
若当前工具功能不满足开发者需求，开发者需增强工具能力，则可基于已有源码进行工具二次开发，编译打包生成自定义的IntelliJ插件。
|
||||
|
||||
## IntelliJ插件打包说明
|
||||
|
||||
### 环境说明
|
||||
|
||||
系统：建议Windows 10
|
||||
|
||||
### 开发步骤
|
||||
|
||||
#### 环境准备
|
||||
|
||||
1.下载napi_generator-win.exe可执行程序与header_parser.exe可执行程序，放置在napi_generator/napi_IntelliJ_plugin/resources/cmds/win目录下。其中下载地址如下：
|
||||
|
||||
[下载链接](http://ftp.kaihongdigi.com:5000/fsdownload/mKjfCmPjk/generator_outputs_NAPI_0930)
|
||||
|
||||
2.下载并安装IDEA Community、JDK11配置好环境。IDEA Community版本可以左键单击以下链接下载。
|
||||
|
||||
[下载链接](https://www.jetbrains.com/idea/download/)
|
||||
|
||||
3.打开IDEA Community应用程序。
|
||||
依次点击项目File>Open 选择napi_generator/napi_IntelliJ_plugin项目文件夹。
|
||||
|
||||
|
||||
|
||||
4.项目打开完成，点击File>Project Structure,在出现的界面中点击Project,下图的SDK选择JDK 11，Language level也选择版本11，选择或者新建complier output目录为项目文件下的out目录。
|
||||
|
||||
|
||||
5.Project Settings > Modules 新建Modules。点击上方“-”删除原有的Modules，然后点击“+”选择 New Module。
|
||||
|
||||
|
||||
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。
|
||||
|
||||
|
||||
7.Content root选择~/napi_generator/napi_IntelliJ_plugin文件夹，module name填写generator。点击Finish，若出现提示已存在是否覆盖的提示，请点“Yes”完成配置。
|
||||
|
||||
|
||||
8.Modules配置完成后，若在SDKs中无相应JDK和Plugin SDK,请点击+号分别添加 Add Java JDK和Add Intellij PlantForm Plugin SDK,Java JDK为java11的安装目录，Plugin SDK为 IDEA Community 2021.3.3的安装目录。
|
||||
|
||||
|
||||
9.若完成以上步骤配置，点击OK完成配置。Rebuild项目，若IDEA不能点击右上角的运行，点击Plugin后下三角选择Edit Configurations...选项，Run/Debug Configurations框中Use classpath of moudle选择generator，点击ok，等待安装完成。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
10.点击Intellij IDEA工具右上角Built Project按钮，等待工程built完成。
|
||||
|
||||
|
||||
|
||||
11.在IDEA Community中依次点击Build>Prepare All Plugin Modules for development"，然后在Select Modules框中点击ok，jar包生成完成后在工具右下角提示jar包生成成功，且包含jar包存放位置。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -21,11 +21,11 @@ visual studio code 版本需1.62.0及以上。
|
||||
|
||||
|
||||
|
||||
2.单击上面三个点的按钮，选择从VSIX安装选项，然后选择刚才生成的gnapi-0.0.1.vsix插件文件，再单击安装。
|
||||
2.在应用商店搜索NAPI插件，再单击安装。
|
||||
|
||||
|
||||
|
||||
3.安装完成后就会在VS Code的插件管理器中能看到gnapi这个插件了。
|
||||
3.安装完成后就会在VS Code的插件管理器中能看到napi-gen这个插件了。
|
||||
|
||||
|
||||
|
||||
|
||||
@ -17,11 +17,11 @@ visual studio code 版本需1.62.0及以上。
|
||||
|
||||
|
||||
|
||||
2.单击上面三个点的按钮，选择从VSIX安装选项，然后选择刚才生成的gnapi-0.0.1.vsix插件文件，再单击安装。
|
||||
2.在应用商店搜索NAPI插件，再单击安装。
|
||||
|
||||
|
||||
|
||||
3.安装完成后就会在VS Code的插件管理器中能看到gnapi这个插件了。
|
||||
3.安装完成后就会在VS Code的插件管理器中能看到napi-gen这个插件了。
|
||||
|
||||
|
||||
|
||||
@ -35,4 +35,3 @@ visual studio code 版本需1.62.0及以上。
|
||||
|
||||
6.执行结束后会在out目录下生成.d.ts代码文件。
|
||||
|
||||
|
||||
|
||||