This a CLI tool for transforming of .proto files into typescript modules.
It will be at least 4 times faster than current best compiler.
protobufjs is currently used as a main compiler. But there are several problems with this tool.
It produces single large javascript file.
It does not have typings by default.
Types are introduced as external index.d.ts file.
What are the results of it? It is not easily tree-shakable.
Usually the case is that some messages in your project are "encode" only and some of the are "decode" only. But since they are highly coupled - you must load both encoding and decoding functions. This tool for each message creates separated folder with each necessary function placed in it's own place.
Also protobufjs uses JS to read, parse and compile .proto schemas to javascript. This tool is written in Rust. So as a result it will be much faster than protobufjs.
protos-ts ./proto --out ./out
./proto
proto
| Action.proto
| Commons
| Enums.proto
| Types.proto
out
| Action
| MyMessage
| decode.ts
| encode.ts
| Commons
| Enums.ts
| MyEnum.ts
| types.ts
| Development Task | Progress |
|---|---|
| Lexical Analyzer | Done |
| Syntactical Analyzer | Done |
| Proto Packages -> Package Tree | Done |
| Create name resolution mechanism | Done |
| Generation of interfaces | Done |
| Encoding of basic types | Done |
| Encoding of repeated basic types | Done |
| Encoding of enums | Done |
| Encoding of user defined messages | Done |
| Fix resolving algorithm | Done |
| Encoding of oneof messages | Done |
| Importing well-known types | Done |
| Decoding of basic types | Done |
| Decoding of enums | Done |
| Decoding of user defined messages | Done |
| Compile to WASM | In Progress |
| Full Coverage Tests | Open |
| Reach CLI experience | Open |
I didn't do it properly. But on my computer I've compared this implementation with official compiler; I've took protocol buffer files from my work project and compiled both of them several times and took minimum.
This compiler: 0.9s
official: 7s
Actually it is difficult to compare them because they do a different job.
Official protobuf.js compiler generates big large file. While this compiler produces hierarchy of different files. Therefore we have much more IO operations.
I've found that in my compiler 92% of the time is spent in IO operations to the harddrive.
collect file names 5.328ms
parsing files 44.7105ms
compiling files to typescript 33.6335ms
saving typescript files 1.0607062s
Full Time 1.1485477s