Clone this repo:
  1. 74888fd Rollback of: Made the missing colon for scalar check less restrictive, and it now doesn't error for unexpected invalid textproto, such as `<nil>`. by Kauê Soares da Silveira · 4 weeks ago master
  2. dea0808 Made the missing colon for scalar check less restrictive, and it now doesn't error for unexpected invalid textproto, such as `<nil>`. by txtpbfmt team · 4 weeks ago
  3. 8830a50 Allow sorting by a user-specified field order. by txtpbfmt team · 4 weeks ago
  4. d629130 Internal change by txtpbfmt team · 4 weeks ago
  5. 32b15d3 Internal change by txtpbfmt team · 4 weeks ago

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.