Go to file
胡瑞涛 3b0f08349f Merge branch 'master' of gitee.com:openharmony/napi_generator into master
Signed-off-by: 胡瑞涛 <huruitao@kaihong.com>
2024-07-10 09:04:12 +00:00
.gitee add pull request template 2023-09-07 01:44:54 -07:00
docs refactor directory 2024-05-15 18:12:59 +08:00
examples codecheck 2024-07-10 15:11:38 +08:00
figures modify intelliJ plugin docs 2024-01-12 14:16:46 +08:00
release-notes add threadsafe func readme 2024-01-24 00:55:32 -08:00
src Merge branch 'master' of gitee.com:openharmony/napi_generator into master 2024-07-10 09:04:12 +00:00
test 重构超大深度函数 2024-07-10 09:53:02 +08:00
.clang-format feat: napi-tool format the c++ file with clang-format 2023-01-11 15:40:05 +08:00
.gitattributes modify exe 2022-03-04 17:21:27 +08:00
.gitignore feat: modify mutiple file entry and fix some problem 2022-06-13 10:13:50 +08:00
FAQ.md style: modify napi faq doc and ensemble doc 2023-05-16 09:53:03 +08:00
LICENSE Adjust directory structure 2022-02-10 10:28:10 +08:00
OAT.xml add native gen tool 2024-04-07 14:27:00 +08:00
package.json feat: napi-tool format the c++ file with clang-format 2023-01-11 15:40:05 +08:00
README_zh.md style: modify invalid download links 2023-12-04 11:48:34 +08:00
README.md refactor directory 2024-05-15 18:12:59 +08:00

Readme

简介

napi_generator仓包含以下工具NAPI框架代码生成工具dts2cpp可以根据用户指定路径下的ts(typescript)接口文件一键生成NAPI框架代码、业务代码框架、GN文件等。TS接口生成工具h2dts可以根据定义在c++头文件中的接口生成type-script语言的ts接口文件。GN脚本生成工具cmake2gn它可以根据三方库的CMakeLists.txt文件编译转换生成BUILD.gn脚本文件。SERVICE框架生成工具h2sa它可以根据一个定义远程方法的.h头文件生成整个Service框架的代码包含Ability注册、proxy/stub类实现、MessageParcel数据包构造、Service子系统编译及开机自启动相关配置文件。NATIVE生成工具h2dtscpp它可以根据定义在c++头文件中的接口生成type-script语言的ts接口文件、NAPI框架代码、和自动化测试用例代码。dts2ets工具它可以根据用户指定路径下的ts(typescript)接口文件生成ets页面代码。API扫描工具它可以扫描三方库中包含OpenHarmony源码不包含的接口并输出result.xlsx文档。

目录

├── napi_generator                                      # 工具集
│   ├── docs                                            # 工具索引文档
│   │   ├── readme.md                                   # 所有工具 readme 索引
│   │   ├── develop.md                                  # 工具设计文档索引
│   │   ├── usage.md                                    # 工具使用文档索引 
│   │   ├── log
│   │   │   ├── meeting.md                              # 会议纪要
│   │   │   ├── release-notes.md                        # 工具版本说明和规划索引      
│   ├── src                                             # 工具源码
│   │   ├── cli                                         # 脚手架源码               
│   │   |   ├── cmake2gn                                # gn脚本生成工具
│   │   |   |   ├── docs
│   │   |   |   |   ├── figures                         # 文档图片资源
│   │   |   |   |   ├── guide                           # 开发文档
│   │   |   |   |   ├── usage                           # 使用文档
│   │   |   |   |   ├── release-notes                   # 版本说明文档
│   │   |   |   ├── src                                 # 源码
│   │   |   |   ├── README_ZH.md
│   │   |   |── dts2cpp                                 # napi框架生成工具
│   │   |   |   ├── docs
│   │   |   |   |   ├── figures                         # 文档图片资源
│   │   |   |   |   ├── guide                           # 开发文档
│   │   |   |   |   ├── usage                           # 使用文档
│   │   |   |   |   ├── release-notes                   # 版本说明文档
│   │   |   |   |   ├── requirement                     # roadmap.md
│   │   |   |   ├── src                                 # 源码
│   │   |   |   ├── README_ZH.md
│   │   |   |── dts2ets                                 # ets页面生成工具
│   │   |   |   ├── appCodeGen                          # 源码
│   │   |   |── h2dts                                   # ts生成工具
│   │   |   |   ├── docs
│   │   |   |   |   ├── figures                         # 文档图片资源
│   │   |   |   |   ├── guide                           # 开发文档
│   │   |   |   |   ├── usage                           # 使用文档
│   │   |   |   |   ├── release-notes                   # 版本说明文档
│   │   |   |   |   ├── requirement                     # roadmap.md
│   │   |   |   ├── src                                 # 源码
│   │   |   |   ├── examples                            # 工具输入示例.h文件
│   │   |   |   ├── README_ZH.md
│   │   |   |── h2dtscpp                                # native生成工具
│   │   |   |   ├── docs
│   │   |   |   |   ├── figures                         # 文档图片资源
│   │   |   |   |   ├── guide                           # 开发文档
│   │   |   |   |   ├── usage                           # 使用文档
│   │   |   |   ├── src                                 # 源码
│   │   |   |   ├── README_ZH.md
│   │   |   |── h2sa                                    # service生成工具
│   │   |   |   ├── docs
│   │   |   |   |   ├── figures                         # 文档图片资源
│   │   |   |   |   ├── guide                           # 开发文档
│   │   |   |   |   ├── usage                           # 使用文档
│   │   |   |   |   ├── release-notes                   # 版本说明文档
│   │   |   |   |   ├── requirement                     # roadmap.md
│   │   |   |   ├── src                                 # 源码
│   │   |   |   ├── examples                            # 工具输入示例.h文件
│   │   |   |   ├── README_ZH.md
│   │   ├── intellij_plugin
│   │   |   ├── cmake2gn                                # gn脚本生成工具
│   │   |   |   |   ├── gn_IntelliJ_plugin              # IntelliJ插件
│   │   |   |── dts2cpp                                 # napi框架生成工具
│   │   |   |   |   ├── napi_IntelliJ_plugin            # IntelliJ插件
│   │   |   |── h2dts                                   # ts生成工具
│   │   |   |   |   ├── ts_IntelliJ_plugin              # IntelliJ插件
│   │   |   |── h2dtscpp                                # native生成工具
│   │   |   |   |   ├── native_IntelliJ_plugin          # IntelliJ插件
│   │   |   |── h2sa                                    # service生成工具
│   │   |   |   |   ├── service_IntelliJ_plugin         # IntelliJ插件
│   │   |   |── assist                                  # 统一入口插件
│   │   |   |   |   ├── assist_tools_IntelliJ_plugin    # IntelliJ插件
│   │   ├── vscode_plugin
│   │   |   ├── cmake2gn                                # gn脚本生成工具
│   │   |   |   |   ├── gn_vs_plugin                    # vs插件
│   │   |   |── dts2cpp                                 # napi框架生成工具
│   │   |   |   |   ├── napi_vs_plugin                  # vs插件
│   │   |   |── h2dts                                   # ts生成工具
│   │   |   |   |   ├── ts_vs_plugin                    # vs插件
│   │   |   |── h2sa                                    # service生成工具
│   │   |   |   |   ├── service_vs_plugin               # vs插件
│   │   |   |── assist                                  # 统一入口插件
│   │   |   |   |   ├── assist_tools_vs_plugin          # vs插件
│   │   ├── tool 
│   │   |   |── api                                     # api扫描工具
│   │   |   |   ├── api_scan_IntelliJ_plugin            # api扫描工具IntelliJ插件
│   │   |   |   ├── api_scan_vs_plugin                  # api扫描工具vs插件
│   │   |   |   ├── docs                                # 文档
│   │   |   |   ├── figures                             # 文档图片资源
│   │   |   |   ├── src                                 # api扫描工具源码
│   │   |   |   ├── FAQ.md                              
│   │   |   |   ├── README_ZH.md
│   ├── test                                            
│   │   ├── dts2cpp                                     # dts2cpp工具使用example
│   │   |   |── ts  
│   │   |   |── README.md  
│   │   ├── storytest                                   # dts2cpp工具st
│   │   ├── unittest                                    # dts2cpp工具ut
│   │   ├── debug_entry.js
│   │   ├── README_zh.md
│   ├── sample                                          # 样例
│   │   ├── napitutorials         
│   └── README.md                                       # readme             

工具介绍

所有工具相关文档介绍如下所示: readme索引 usage索引 develop索引 release-notes索引