@protobuf-ts/plugin-framework
Advanced tools
Readme
A framework to create protoc plugins in typescript.
The google protocol buffer compiler (protoc) has a plugin system. With a protoc plugin, it is possible to generate code for .proto files in any language, not just the ones supported directly by protoc.
A protoc plugin receives a CodeGeneratorRequest (a protobuf message)
via stdin and returns a CodeGeneratorResponse via stdout.
This framework aims to make it as easy as possible to write a protoc plugin in typescript. It has special support for generating typescript code, but can be used to generate code in other languages.
provides a symbol table that can be used to track generated types in any language
has special support for generating typescript code using the typescript compiler API. For example, it has a simple API to import objects from a package, or from the symbol table.
provides a base class for plugins that supports parameters, error handling, supported features and easy setup.
builds a tree of descriptors so that it is trivial to lookup the parent of a nested message, for example.
builds a lookup object to find the descriptor for a given type name
provides a string format object that can print a message field like it was typed by the user.
provides a source code comment lookup that can be used to easily find comments for a given element in a .proto
provides convenience methods to check if a field was declared optional or as a oneof member
Take a look at plugin-base.ts and descriptor-registry.ts.
@protobuf-ts/plugin uses this framework. Take a look at the source.
The directory google/protobuf/ contains the generated messages required for
a protoc plugin.
The files are generated by protoc from the .proto files google/protobuf/descriptor.proto and google/protobuf/compiler/plugin.proto from the official protobuf repository, version 3.12.3.
The resulting output files plugin.ts and descriptor.ts are copyrighted by google.
FAQs
framework to create protoc plugins
The npm package @protobuf-ts/plugin-framework receives a total of 139,847 weekly downloads. As such, @protobuf-ts/plugin-framework popularity was classified as popular.
We found that @protobuf-ts/plugin-framework demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
