mirror of
https://gitee.com/openharmony/napi_generator
synced 2024-11-23 08:20:01 +00:00
modify napi tool reademe
Signed-off-by: zhaojunxia <zhaojunxia@kaihongdigi.com>
This commit is contained in:
zhaojunxia
parent
470ebadcfe
commit
9717934c4c
123
DEVELOP_ZH.md
Normal file
123
DEVELOP_ZH.md
Normal file
@ -0,0 +1,123 @@
|
||||
#工具开发说明
|
||||
|
||||
##工具开发
|
||||
### 可执行文件开发说明
|
||||
1.安装typescript：在napi_generator目录下和napi_generator/src目录下分别都执行命令npm i typescript
|
||||
|
||||
2.安装stdio：在napi_generator目录下执行命令npm i stdio
|
||||
|
||||
3.安装pkg : 在napi_generator目录下执行命令sudo npm i -g pkg
|
||||
|
||||
4.打包三个版本 : 执行命令pkg .
|
||||
|
||||
执行以上步骤后，即可在gen目录下生成Windows、linux、mac系统下的可执行程序:napi_generator-win.exe、napi_generator-linux、napi_generator-macos。
|
||||
|
||||
### VS插件开发说明
|
||||
|
||||
#### Linux
|
||||
|
||||
1. 在napi_generator/src这个目录下执行命令npm i typescript。
|
||||
|
||||
```
|
||||
joey@joey-virtual-machine:~/code/napi_tool_myself/napi_generator/src$ npm i typescript
|
||||
npm WARN gnapi@0.0.1 No repository field.
|
||||
npm WARN gnapi@0.0.1 No license field.
|
||||
npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.3.2 (node_modules/fsevents):
|
||||
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.3.2: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
|
||||
|
||||
+ typescript@4.5.5
|
||||
added 267 packages from 238 contributors in 33.185s
|
||||
|
||||
39 packages are looking for funding
|
||||
run `npm fund` for details
|
||||
|
||||
joey@joey-virtual-machine:~/code/napi_tool_myself/napi_generator/src$
|
||||
```
|
||||
|
||||
2. 在napi_generator/src这个目录下执行命令npm i vsce。
|
||||
|
||||
```
|
||||
joey@joey-virtual-machine:~/code/napi_tool_myself/napi_generator/src$ npm i vsce
|
||||
|
||||
> keytar@7.9.0 install /home/joey/code/napi_tool_myself/napi_generator/src/node_modules/keytar
|
||||
> prebuild-install || npm run build
|
||||
|
||||
npm WARN gnapi@0.0.1 No repository field.
|
||||
npm WARN gnapi@0.0.1 No license field.
|
||||
npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.3.2 (node_modules/fsevents):
|
||||
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.3.2: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
|
||||
|
||||
+ vsce@2.6.7
|
||||
added 103 packages from 191 contributors in 39.489s
|
||||
|
||||
64 packages are looking for funding
|
||||
run `npm fund` for details
|
||||
|
||||
joey@joey-virtual-machine:~/code/napi_tool_myself/napi_generator/src$
|
||||
```
|
||||
|
||||
3. 在napi_generator/src这个目录下执行命令npx vsce package，每个选项都选择y，然后回车，最终会在当前目录下打包生成一个插件gnapi-0.0.1.vsix。
|
||||
|
||||
```
|
||||
joey@joey-virtual-machine:~/code/napi_tool_myself/napi_generator/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 2189 files, out of which 1184 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/joey/code/napi_tool_myself/napi_generator/src/gnapi-0.0.1.vsix (2189 files, 13.61MB)
|
||||
joey@joey-virtual-machine:~/code/napi_tool_myself/napi_generator/src$
|
||||
|
||||
```
|
||||
#### Windows
|
||||
|
||||
1. 在napi_generator/src这个目录下执行命令npm i typescript。
|
||||
|
||||
```
|
||||
D:\napi_tool_myself\napi_generator\src>npm i typescript npm WARN gnapi@0.0.1 No repository field. npm WARN gnapi@0.0.1 No license field. npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.3.2 (node_modules\fsevents): npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.3.2: wanted {"os":"darwin","arch":"any"} (current: {"os":"win32","arch":"x64"}) + typescript@4.5.5 updated 1 package and audited 373 packages in 2.729s 64 packages are looking for funding run `npm fund` for details found 1 moderate severity vulnerability run `npm audit fix` to fix them, or `npm audit` for details D:\napi_tool_myself\napi_generator\src>
|
||||
```
|
||||
|
||||
2. 在napi_generator/src这个目录下执行命令npm i vsce。
|
||||
|
||||
```
|
||||
D:\napi_tool_myself\napi_generator\src>npm i vsce > keytar@7.9.0 install D:\napi_tool_myself\napi_generator\src\node_modules\keytar > prebuild-install || npm run build npm WARN gnapi@0.0.1 No repository field. npm WARN gnapi@0.0.1 No license field. npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.3.2 (node_modules\fsevents): npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.3.2: wanted {"os":"darwin","arch":"any"} (current: {"os":"win32","arch":"x64"}) + vsce@2.6.7 added 103 packages from 191 contributors and audited 373 packages in 21.128s 64 packages are looking for funding run `npm fund` for details found 1 moderate severity vulnerability run `npm audit fix` to fix them, or `npm audit` for details D:\napi_tool_myself\napi_generator\src>
|
||||
```
|
||||
|
||||
3. 在napi_generator/src这个目录下执行命令npx vsce package，每个选项都选择y，然后回车，最终会在当前目录下打包生成一个插件gnapi-0.0.1.vsix。
|
||||
```
|
||||
D:\napi_tool_myself\napi_generator\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 2189 files, out of which 1184 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: D:\napi_tool_myself\napi_generator\src\gnapi-0.0.1.vsix (2189 files, 13.79MB) D:\napi_tool_myself\napi_generator\src>
|
||||
```
|
||||
|
||||
### IntelliJ插件开发说明
|
||||
|
||||
1.通过IntelliJ IDEA打开generator目录下的代码
|
||||
|
||||
|
||||
|
||||
2.执行IntelliJ IDEA工具右上角的run
|
||||
|
||||
|
||||
|
||||
3.IntelliJ IDEA会自动拉起一个应用程序
|
||||
|
||||
|
||||
|
||||
4.选择.d.ts文件,右键选择generate.d.ts选项，生成文件
|
||||
|
||||
|
||||
|
||||
5.执行结束后会在目录下生成对应的文件
|
||||
|
||||
|
||||
|
||||
##工具测试
|
||||
进行工具二次开发后，本地可进行单元测试、特性测试确保工具的可用性。
|
||||
|
||||
单元测试方法如下：
|
||||
https://gitee.com/openharmony-sig/napi_generator/blob/master/test/unittest/README_ZH.md
|
||||
|
||||
特性测试方法如下：
|
||||
https://gitee.com/openharmony-sig/napi_generator/blob/master/test/storytest/README_ZH.md
|
||||
@ -21,7 +21,7 @@
|
||||
│ │ | |── generate # 生成器
|
||||
│ │ | └── tools # 公共模块代码，包括消息体校验、文件读写、正则表达式转换等
|
||||
| | └── generator #IntelliJ IDEA插件代码
|
||||
| ├── examples # 工具需要的ts文件样例
|
||||
| ├── examples # 工具需要的文件样例
|
||||
│ └── README # 工具使用指导
|
||||
|
||||
```
|
||||
|
||||
Loading…
Reference in New Issue
Block a user