1.0.0 • Published 4 years ago

@xd-public/proto-to-ts v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
4 years ago

自动将pb转换成typescript里面类型文件(可以带着注释一起转换)

Proto注释规范

1、块级元素,比如message,enum, 这类的注释必须在mesaage或者enum定义的上一行

2、字段类型的注释,必须跟在后面

本工具基于libertyzhao/pb-to-ts 修改

更新

  • 增加命令行调用支持
  • 增加 service api 代码生成
  • 增加ejs模板支持
  • 增加配置文件支持
  • 增加转驼峰可配置选项

命令行参数

-i 指定输入目录 (proto文件所在的目录)
-o 指定输出目录 (存放生成的ts文件)
-t 指定ejs模板文件 (可选)
-p 转驼峰
-c 指定配置文件

测试

npm run build
node ./bin/protots.js -i example/protos -o example/output  

使用

protots -h                                                                                                                                                  (git)-[feature/service-interface] 
Usage: protots [options]

Proto => TS

Options:
  -v, --version              output the current version
  -i, --input [input]        protos directory
  -o, --output [output]      ts output directory
  -t, --template [template]  ejs template file
  -p, --hump [hump]          set hump
  -c, --config [config]      config file (default is protots.config.json)
  -h, --help                 display help for command

配置文件 (默认名字: protots.config.json)

{
    input: "./protos/",
    output: "./output/",
    templatePath: './myEjsTemplate.ejs',
    isHump: false
}
//使用默认模板
protots -i inputDir -o outputDir 
//使用自定义模板
protots -i inputDir -o outputDir -t ejsTempateFile