• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# NAPI框架生成工具开发说明
2
3若当前工具功能不满足开发者需求，开发者需增强工具能力，则可基于已有源码进行工具二次开发，编译打包生成自定义的可执行文件和插件。
4
5## 工具开发
6
7### 可执行文件开发说明
8
9#### 环境说明
10
11系统：建议Ubuntu 20.04或者Windows 10
12
13#### 开发步骤
14
15##### Linux
16
171.安装typescript：在napi_generator/src/cli/dts2cpp/src目录下执行命令：
18
19	npm i typescript
20
212.安装stdio：在napi_generator/src/cli/dts2cpp目录下执行命令：
22
23	npm i stdio
24
253.安装pkg : 在napi_generator/src/cli/dts2cpp目录下执行命令：
26
27	sudo npm i -g pkg
28
294.集成cla&ng-format（可选步骤）：
30
31  如果需要工具自动格式化生成的C++代码，可执行此步骤。
32  将windows版的cla&ng-format.exe程序和linux版的cla&ng-format程序拷贝到napi_generator目录下。
33  cla&ng-format程序可从OpenHarmony编译环境获取：
34  windows版：OpenHarmony/prebuilts/cla&ng/ohos/windows-x86_64/llvm/bin/cla&ng-format.exe
35  Linux版：OpenHarmony/prebuilts/ming&w-w64/ohos/linux-x86_64/cla&ng-ming&w/bin/cla&ng-format
36
375.打包三个版本 : 执行命令：
38
39	pkg .
40
41执行以上步骤后，即可在napi_generator/src/cli/dts2cpp目录下生成Windows、linux、mac系统下的可执行程序:
42
43	napi_generator-win.exe、napi_generator-linux、napi_generator-macos
44
456.根据需求打包指定系统下的可执行文件。若想只打包windows系统下可执行文件，可执行命令：
46
47	pkg -t node14-win . -o napi_generator-win.exe
48
49若想只打包linux系统下可执行文件，可执行命令：
50
51	pkg -t node14-linux . -o napi_generator-linux
52
53若想只打包macos系统下可执行文件，可执行命令：
54
55	pkg -t node14-macos . -o napi_generator-macos
56
57备注：参数-t为指定系统，参数-o为指定可执行文件名称。
58
59
60##### Windows
61
621.安装typescript：使用管理员身份在napi_generator/src/cli/dts2cpp/src目录下执行命令：
63
64	npm i typescript
65
662.安装stdio：使用管理员身份在napi_generator/src/cli/dts2cpp目录下执行命令：
67
68	npm i stdio
69
703.安装pkg : 使用管理员身份在napi_generator/src/cli/dts2cpp目录下执行命令：
71
72	npm i -g pkg
73
744.集成cla&ng-format（可选步骤）：
75
76  如果需要工具自动格式化生成的C++代码，可执行此步骤。
77  将windows版的cla&ng-format.exe程序和linux版的cla&ng-format程序拷贝到napi_generator目录下。
78  cla&ng-format程序可从OpenHarmony编译环境获取：
79  windows版：OpenHarmony/prebuilts/cla&ng/ohos/windows-x86_64/llvm/bin/cla&ng-format.exe
80  Linux版：OpenHarmony/prebuilts/ming&w-w64/ohos/linux-x86_64/cla&ng-ming&w/bin/cla&ng-format
81
825.打包三个版本 : 使用管理员身份执行命令：
83
84	pkg .
85
86执行以上步骤后，即可在napi_generator/src/cli/dts2cpp目录下生成Windows、linux、mac系统下的可执行程序:
87
88	napi_generator-win.exe、napi_generator-linux、napi_generator-macos
89
906.根据需求打包指定系统下的可执行文件。若想只打包windows系统下可执行文件，可执行命令：
91
92	pkg -t node14-win . -o napi_generator-win.exe
93
94若想只打包linux系统下可执行文件，可执行命令：
95
96	pkg -t node14-linux . -o napi_generator-linux
97
98若想只打包macos系统下可执行文件，可执行命令：
99
100	pkg -t node14-macos . -o napi_generator-macos
101
102### DevEco Studio上使用的IntelliJ插件开发说明
103
104具体的插件开发步骤，可以左键单击以下链接了解：
105
106[DevEco Studio上使用的IntelliJ插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/src/intellij_plugin/dts2cpp/napi_IntelliJ_plugin/docs/guide/DEVELOP_ZH.md)
107
108## 工具测试
109  进行工具二次开发后，本地可进行单元测试、story特性测试确保工具的可用性。左键单击以下链接了解详情：
110
111  [单元测试](https://gitee.com/openharmony/napi_generator/blob/master/test/unittest/README_ZH.md)
112
113  [story测试](https://gitee.com/openharmony/napi_generator/blob/master/test/storytest/README_ZH.md)
114
115