-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,23 @@ | ||
# protoc-gen-goexample | ||
An example of a protoc plugin in go | ||
|
||
## Build | ||
``` | ||
go build . | ||
``` | ||
|
||
## Run the plugin | ||
``` | ||
protoc --plugin protoc-gen-goexample --goexample_out=output example.proto | ||
``` | ||
|
||
## Passing additional data to generators | ||
Parameters may be set for additional information | ||
``` | ||
protoc --plugin protoc-gen-goexample --goexample_out=param1=value1,param2=value2:output example.proto | ||
``` | ||
I believe an equivalent, cleaner, way to do this would be using the opt argument | ||
``` | ||
protoc --plugin ./protoc-gen-goexample --goexample_out=output --goexample_opt=param1=value1,param2=value2 example.proto | ||
``` | ||
Parameters shall apply to multiple files. See an example in generateCode for parsing comments. You might consider using annotations as comments to apply additional data at the message level, or field level, by adding annotations as leading comments. |