blob: 54fd787e29de4386cfaabd554525cca3d5bd39ae (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
# protokit
[![Travis Build Status][travis-svg]][travis-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`
[travis-svg]:
https://travis-ci.org/pseudomuto/protokit.svg?branch=master
"Travis CI build status SVG"
[travis-ci]:
https://travis-ci.org/pseudomuto/protokit
"protoc-gen-twagger at Travis CI"
[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
|
