xsteadfastx/protoc-gen-go-value-scan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: formatting

Browse Source
This commit is contained in:
Marvin Preuss 2022-12-13 13:38:47 +00:00
parent 493cc21d7e
commit 0004e1e57c
1 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -19,6 +19,11 @@ message Foo {
string bar = 1; string bar = 1;
string zonk = 2; string zonk = 2;
} }
message ExcludeThis {
string bar = 1;
string zonk = 2;
}
``` ```
and creates this go code and creates this go code
@ -57,15 +62,7 @@ func (x *Foo) Scan(value interface{}) error {
} }
``` ```
## Configuration with this `buf.gen.yaml`
| Option | Meaning | Default |
| ------------------ | -------------------------------------------------------------------------------------- | ------- |
| `use_proto_names` | UseProtoNames uses proto field name instead of lowerCamelCase name in JSON field names | `true` |
| `emit_unpopulated` | EmitUnpopulated specifies whether to emit unpopulated fields | `true` |
| `exclude` | Takes a message identifier. Can be multiple identifier delimited by `,` | none |
### Example
```yaml ```yaml
version: v1 version: v1
@ -79,3 +76,11 @@ plugins:
opt: opt:
- paths=source_relative,use_proto_names=false,emit_unpopulated=true,exclude=git.wobcom.de/smartmetering/protoc-gen-go-value-scan/test/go/foo/v1.ExcludeThis - paths=source_relative,use_proto_names=false,emit_unpopulated=true,exclude=git.wobcom.de/smartmetering/protoc-gen-go-value-scan/test/go/foo/v1.ExcludeThis
``` ```
## Configuration
| Option | Meaning | Default |
| ------------------ | -------------------------------------------------------------------------------------- | ------- |
| `use_proto_names` | UseProtoNames uses proto field name instead of lowerCamelCase name in JSON field names | `true` |
| `emit_unpopulated` | EmitUnpopulated specifies whether to emit unpopulated fields | `true` |
| `exclude` | Takes a message identifier. Can be multiple identifier delimited by `,` | none |