https://github.com/pseudomuto/protokit
A starter kit for building protoc plugins. Rather than write your own, you can just use an existing one.
https://github.com/pseudomuto/protokit
protobuf protobuf-parser protoc protoc-plugin
Last synced: 5 months ago
JSON representation
A starter kit for building protoc plugins. Rather than write your own, you can just use an existing one.
- Host: GitHub
- URL: https://github.com/pseudomuto/protokit
- Owner: pseudomuto
- License: mit
- Created: 2018-02-17T01:13:49.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-08-01T17:52:43.000Z (over 3 years ago)
- Last Synced: 2025-10-05T00:44:56.127Z (5 months ago)
- Topics: protobuf, protobuf-parser, protoc, protoc-plugin
- Language: Go
- Size: 126 KB
- Stars: 81
- Watchers: 2
- Forks: 33
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# protokit
[![CI][github-svg]][github-ci]
[![codecov][codecov-svg]][codecov-url]
[![GoDoc][godoc-svg]][godoc-url]
[![Go Report Card][goreport-svg]][goreport-url]
A starter kit for building protoc-plugins. Rather than write your own, you can just use an existing one.
See the [examples](examples/) directory for uh...examples.
## Getting Started
```golang
package main
import (
"github.com/golang/protobuf/proto"
"github.com/golang/protobuf/protoc-gen-go/plugin"
"github.com/pseudomuto/protokit"
_ "google.golang.org/genproto/googleapis/api/annotations" // Support (google.api.http) option (from google/api/annotations.proto).
"log"
)
func main() {
// all the heavy lifting done for you!
if err := protokit.RunPlugin(new(plugin)); err != nil {
log.Fatal(err)
}
}
// plugin is an implementation of protokit.Plugin
type plugin struct{}
func (p *plugin) Generate(in *plugin_go.CodeGeneratorRequest) (*plugin_go.CodeGeneratorResponse, error) {
descriptors := protokit.ParseCodeGenRequest(req)
resp := new(plugin_go.CodeGeneratorResponse)
for _, d := range descriptors {
// TODO: YOUR WORK HERE
fileName := // generate a file name based on d.GetName()
content := // generate content for the output file
resp.File = append(resp.File, &plugin_go.CodeGeneratorResponse_File{
Name: proto.String(fileName),
Content: proto.String(content),
})
}
return resp, nil
}
```
Then invoke your plugin via `protoc`. For example (assuming your app is called `thingy`):
`protoc --plugin=protoc-gen-thingy=./thingy -I. --thingy_out=. rpc/*.proto`
[github-svg]: https://github.com/pseudomuto/protokit/actions/workflows/ci.yaml/badge.svg?branch=master
[github-ci]: https://github.com/pseudomuto/protokit/actions/workflows/ci.yaml
[codecov-svg]: https://codecov.io/gh/pseudomuto/protokit/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/pseudomuto/protokit
[godoc-svg]: https://godoc.org/github.com/pseudomuto/protokit?status.svg
[godoc-url]: https://godoc.org/github.com/pseudomuto/protokit
[goreport-svg]: https://goreportcard.com/badge/github.com/pseudomuto/protokit
[goreport-url]: https://goreportcard.com/report/github.com/pseudomuto/protokit