ruby codegen: support generation of rbs files (#15633) #23061
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ruby codegen: support generation of rbs files (#15633)
this introduces support for a new protoc option,
--rbs_out
, which points to a directory where ruby type definition files, defined in the RBS format, are stored.rbs is the type signature syntax blessed by the ruby core team, used by static analysis tools such as steep, which integrates with VS Code, the
irb
console (for features such as autocompletion). and typeprof.It relies on type definitions written into
.rbs
files.The
protobuf
library already exposes type definitions in gem_rbs_collection, which is used to source type definitions for libraries which do not want, or can't maintain type definitions themselves.(
protobuf
could arguably import these into this repository, lmk if you're interested).This should fix gaps such as better IDE integration, such as the ones described
here.
The plan is to do roughly the same type of integration as was done for
.pyi
annotations, which also write to separate files: add the cli option and the rbs generator.protobuf classes in ruby rely on dynamic attribution of the base class, which makes what I'm trying to achieve a bit difficult. Ideally the type hierarchy could be specified statically in the ruby source code.