Go to file
2016-12-01 10:19:09 +01:00
contrib/homebrew Add Homebrew support #3 2016-11-06 20:20:11 +01:00
examples/dummy Add filename templating support (fix #5) 2016-11-09 18:39:29 +01:00
vendor/github.com bump funcmap@1.1.1 2016-12-01 10:19:09 +01:00
.gitignore Commit the output files 2016-11-06 17:32:34 +01:00
Dockerfile bump funcmap@1.1.1 2016-12-01 10:19:09 +01:00
encoder.go Add filename templating support (fix #5) 2016-11-09 18:39:29 +01:00
glide.lock bump funcmap@1.1.1 2016-12-01 10:19:09 +01:00
glide.yaml bump funcmap@1.1.1 2016-12-01 10:19:09 +01:00
LICENSE Initial commit 2016-11-04 21:44:49 +01:00
main.go Parse parameters (fix #4) 2016-11-07 08:45:02 +01:00
README.md Add usage documentation (fix #1) 2016-11-09 21:48:26 +01:00

protoc-gen-gotemplate

📂 protocol generator + golang text/template (protobuf)

Generic protocol buffer generator backed by Golang's text/template.


This is a generator plugin for the Google Protocol Buffers compiler (protoc).

The plugin can generate files based on a template directory using the Golang's text/template engine.

Usage

protoc-gen-gotemplate requires a template_dir directory (by default ./templates).

Every files ending with .tmpl will be processed and written in the destination folder, following the file hierarchy of the template_dir, and removing the .tmpl extension.


$> ls -R
input.proto     templates/doc.txt.tmpl      templates/config.json.tmpl
$> protoc --gotemplate_out=. input.proto
$> ls -R
input.proto     templates/doc.txt.tmpl      templates/config.json.tmpl
doc.txt         config.json

You can specify a custom template_dir or enable debug:

$> protoc --gotemplate_out=debug=true,template_dir=/path/to/template/directory:. input.proto

See examples.

Install

  • Install the Go compiler and tools from https://golang.org/doc/install
  • Install protobuf: go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
  • Install protoc-gen-gotemplate: go get -u github.com/moul/protoc-gen-gotemplate

License

MIT