Google Git
Sign in
chromium / external / github.com / protocolbuffers / txtpbfmt / refs/heads/test_267954610
commit91b5148b0328c588eef47cd0e5564480cc6fcee8[log] [tgz]
authorKauê Soares da Silveira <[email protected]>Tue Sep 10 12:09:39 2019
committerKaue Silveira <[email protected]>Tue Sep 10 22:04:32 2019
treef684a36220171e14d1fe41c30a38f28dd263976e
parentce9fb2b1df64d91cc586b46de28bd91fbbb1bb6c [diff]
Add README.md and open source parser tests.

PiperOrigin-RevId: 268201455
4 files changed
tree: f684a36220171e14d1fe41c30a38f28dd263976e
  1. ast/
  2. cmd/
  3. docs/
  4. parser/
  5. go.mod
  6. go.sum
  7. LICENSE
  8. README.md
README.md

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 get -u github.com/protocolbuffers/txtpbfmt/cmd/txtpbfmt

Format files in-place:

$ ${GOPATH}/bin/txtpbfmt [FILES]

Write formatted input to stdout:

$ ${GOPATH}/bin/txtpbfmt < [FILE]

What does it do?

Main features:

main features

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.