mlugg
048396053b
Notably, this gets us `@actions/github` 6.0.1, which is necessary for `github.context.runAttempt` (so I have also updated `package.json` accordingly). On that note... great job following semver, GitHub! Between this and the non-breaking major version change on `@actions/cache`, I'm starting to feel like nobody on the Actions team understands how software versioning works.
36 lines
1.6 KiB
Markdown
36 lines
1.6 KiB
Markdown
# @bufbuild/protoplugin
|
|
|
|
This package helps you create your own code generator plugin using the
|
|
Protobuf-ES plugin framework.
|
|
|
|
**Protobuf-ES** is a complete implementation of [Protocol Buffers](https://protobuf.dev) in TypeScript, suitable for
|
|
web browsers and Node.js.
|
|
|
|
In addition to a full Protobuf runtime library, it provides the [`protoc-gen-es`](https://www.npmjs.com/package/@bufbuild/protoc-gen-es)
|
|
code generator, which uses a plugin framework to generate base types from
|
|
your Protobuf schema. It is fully compatible with both `buf` and `protoc` compilers.
|
|
|
|
And now, you can write your own **Protobuf-ES** compatible plugins using this same
|
|
plugin framework with the `@bufbuild/protoplugin` package.
|
|
|
|
With `@bufbuild/protoplugin`, you can generate your own TypeScript code tailored
|
|
to your project or needs. You also have various options for producing
|
|
JavaScript and TypeScript declaration files:
|
|
|
|
- Exercise full control by writing your own JavaScript and declaration file
|
|
generators in addition to TypeScript.
|
|
|
|
- Generate TypeScript files only and let the framework generate JavaScript and
|
|
declaration files automatically using our internal TypeScript compiler.
|
|
|
|
- Generate TypeScript files only and bring your own TypeScript compiler, using
|
|
it to generate JavaScript and declaration files with your own version of
|
|
TypeScript and your own compiler options.
|
|
|
|
With `@bufbuild/protoplugin`, you have all the tools at your disposal to produce
|
|
ECMAScript-compliant code.
|
|
|
|
## Usage
|
|
|
|
Get started now with our [plugin documentation](https://github.com/bufbuild/protobuf-es/blob/main/MANUAL.md#writing-plugins).
|