mransan / ocaml-protoc

A Protobuf Compiler for OCaml
https://mransan.github.io/ocaml-protoc/
MIT License
179 stars 33 forks source link

Expose pb options to ocaml types #234

Closed Lupus closed 8 months ago

Lupus commented 8 months ago

Bonus commit includes extracting enum value options out of the parser, they were just ignored previously 😊

A special plugin is introduced, which dumps internal representation of OCaml type tree as comments to resulting target .ml file. It server two purposes - (1) produces output for expect tests, as it dumps options associated with various types, and this ensures that options are parsed and transferred correctly between compilation stages; and (2) it serves as an aid for custom plugin developers, as looking at this dump is really helpful before writing any code to actually pattern match the OCaml type tree and generate something out of it.

I already have implemented a prototype-level plugin that generates validation rules out of PGV annotations, having protobuf options exposed along with OCaml type tree is a hard requirement for such kinds of plugins.

c-cube commented 8 months ago

Thank you, this is indeed going to be handy in tandem with expect tests!