• 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目录下执行命令：
18
19	npm i typescript
20
212.安装stdio：在napi_generator目录下执行命令：
22
23	npm i stdio
24
253.安装pkg : 在napi_generator目录下执行命令：
26
27	sudo npm i -g pkg
28
294.打包三个版本 : 执行命令：
30
31	pkg .
32
33执行以上步骤后，即可在napi_generator目录下生成Windows、linux、mac系统下的可执行程序:
34
35	napi_generator-win.exe、napi_generator-linux、napi_generator-macos
36
375.根据需求打包指定系统下的可执行文件。若想只打包windows系统下可执行文件，可执行命令：
38
39	pkg -t node14-win . -o napi_generator-win.exe
40
41若想只打包linux系统下可执行文件，可执行命令：
42
43	pkg -t node14-linux . -o napi_generator-linux
44
45若想只打包macos系统下可执行文件，可执行命令：
46
47	pkg -t node14-macos . -o napi_generator-macos
48
49备注：参数-t为指定系统，参数-o为指定可执行文件名称。
50
51
52##### Windows
53
541.安装typescript：使用管理员身份在napi_generator/src目录下执行命令：
55
56	npm i typescript
57
582.安装stdio：使用管理员身份在napi_generator目录下执行命令：
59
60	npm i stdio
61
623.安装pkg : 使用管理员身份在napi_generator目录下执行命令：
63
64	npm i -g pkg
65
664.打包三个版本 : 使用管理员身份执行命令：
67
68	pkg .
69
70执行以上步骤后，即可在napi_generator目录下生成Windows、linux、mac系统下的可执行程序:
71
72	napi_generator-win.exe、napi_generator-linux、napi_generator-macos
73
745.根据需求打包指定系统下的可执行文件。若想只打包windows系统下可执行文件，可执行命令：
75
76	pkg -t node14-win . -o napi_generator-win.exe
77
78若想只打包linux系统下可执行文件，可执行命令：
79
80	pkg -t node14-linux . -o napi_generator-linux
81
82若想只打包macos系统下可执行文件，可执行命令：
83
84	pkg -t node14-macos . -o napi_generator-macos
85
86### VS插件开发说明
87
88具体的插件开发步骤，可以左键单击以下链接了解：
89
90[VS插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/napi_vs_plugin/docs/DEVELOP_ZH.md)
91
92### IntelliJ插件开发说明
93
94具体的插件开发步骤，可以左键单击以下链接了解：
95
96[IntelliJ插件开发说明](https://gitee.com/openharmony/napi_generator/blob/master/napi_IntelliJ_plugin/docs/DEVELOP_ZH.md)
97
98## 工具测试
99  进行工具二次开发后，本地可进行单元测试、story特性测试确保工具的可用性。左键单击以下链接了解详情：
100
101  [单元测试](https://gitee.com/openharmony/napi_generator/blob/master/test/unittest/README_ZH.md)
102
103  [story测试](https://gitee.com/openharmony/napi_generator/blob/master/test/storytest/README_ZH.md)
104
105