README
¶
Text Proto Formatter
txtpbfmt parses, edits and formats text proto files in a way that preserves comments.
This saves development (read/edit/review) time and enables automated edits.
How to format existing text proto files?
Install:
$ go install github.com/protocolbuffers/txtpbfmt/cmd/txtpbfmt@latest
Format files in-place:
$ ${GOPATH}/bin/txtpbfmt [FILES]
Write formatted input to stdout:
$ ${GOPATH}/bin/txtpbfmt < [FILE]
What does it do?
Main features:
Configurable features:
- Fields on
parser.Config - Corresponding
# txtpbfmt: featurenames onparser.addToConfig - Examples on config.md
Is there an API to edit text proto files while preserving comments?
Yes, see ast.go.
How to disable it?
You can disable formatting for a whole file by adding a comment with "# txtpbfmt: disable" to the top of the file (before the first non-empty non-comment line), eg:
# File overview ...
# txtpbfmt: disable
content: { ... }
Which file extension should I use for my text proto files?
The .textproto extension is the most used extension inside Google (the second
most popular choice is .textpb).
Which tools support it? How to format on save?
Currently there is no open source integration with any editor.
See also
Directories
¶
| Path | Synopsis |
|---|---|
|
Package ast provides data structure representing textproto syntax tree.
|
Package ast provides data structure representing textproto syntax tree. |
|
cmd
|
|
|
txtpbfmt
The fmt command applies standard formatting to text proto files and preserves comments.
|
The fmt command applies standard formatting to text proto files and preserves comments. |
|
Package parser edits text proto files, applies standard formatting and preserves comments.
|
Package parser edits text proto files, applies standard formatting and preserves comments. |
|
Package unquote provides a function to unquote txtpb-formatted quoted string literals.
|
Package unquote provides a function to unquote txtpb-formatted quoted string literals. |
Click to show internal directories.
Click to hide internal directories.