Google Git
Sign in
chromium / external / github.com / protocolbuffers / txtpbfmt / refs/heads/test_314498398
commit4de814c7a6a8ff057afd1250e1c707c20e8e22e0[log] [tgz]
authorkaue <[email protected]>Wed Jun 03 10:05:14 2020
committertxtpbfmt team <[email protected]>Wed Jun 03 12:22:57 2020
tree6d02fcbd0d19a591deb87181752f68f3ea880247
parent295016e84c812f206cdea8e3fa1c98fa56273416 [diff]
Move new files to their own folder to fix package error.

PiperOrigin-RevId: 314498398
3 files changed
tree: 6d02fcbd0d19a591deb87181752f68f3ea880247
  1. ast/
  2. cmd/
  3. docs/
  4. parser/
  5. unquote/
  6. go.mod
  7. go.sum
  8. LICENSE
  9. 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.