Golang protobuf doesn't support custom tags to generated structs. This script injects custom tags to generated protobuf files, useful for things like validation struct tags.
-
For OS X:
brew install protobuf -
go support for protobuf:
go get -u github.com/golang/protobuf/{proto,protoc-gen-go} -
go get github.com/syncore/protoc-go-inject-tagor download the binaries from releases page.
Add a comment with syntax // @inject_tag: custom_tag:"custom_value"
before fields to add custom tag to in .proto files.
Example:
// file: test.proto
syntax = "proto3";
package pb;
message IP {
// @inject_tag: valid:"ip"
string Address = 1;
}
Generate with protoc command as normal.
protoc --go_out=. test.proto
Run protoc-go-inject-tag with generated file test.pb.go.
protoc-go-inject-tag -input=./test.pb.go
The custom tags will be injected to test.pb.go.
type IP struct {
// @inject_tag: valid:"ip"
Address string `protobuf:"bytes,1,opt,name=Address,json=address" json:"Address,omitempty" valid:"ip"`
}
To skip the tag for the generated XXX_* fields, use
-XXX_skip=yaml,xml flag.
To enable verbose logging, use -verbose
To remove @inject_tag comment from .pb.go after inject done, use -with_clean
To inject tags into all .pb.go files in the current directory (and its sub-directories), use
-dirs=.
To inject tags into a directory of .pb.go files (including its sub-directories), provide a tilde separated list of directories
-dirs=dir1~dir2~"another dir"