1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
# Text Proto Formatter - Configuration
<!--* freshness: { exempt: true } *-->
`txtpbfmt` provides several configuration options that customize the specifics
of the output format. These are configured by adding a comment line to top of
the proto file (before the first non-empty non-comment line) of the form:
`# txtpbfmt: [config-option]`
This doc describes each of these options.
## AllowTripleQuotedStrings
`# txtpbfmt: allow_triple_quoted_strings`
Permit usage of Python-style `"""` or `'''` delimited strings.
## AllowUnnamedNodesEverywhere
`# txtpbfmt: allow_unnamed_nodes_everywhere`
Allow unnamed nodes everywhere.
Default is to allow only top-level nodes to be unnamed.
## ExpandAllChildren
`# txtpbfmt: expand_all_children`
Expand all children irrespective of the initial state.
### Before formatting
[Example](examples/expand_all_children.IN.textproto)
### After formatting
[Example](examples/expand_all_children.OUT.textproto)
## PreserveAngleBrackets
`# txtpbfmt: preserve_angle_brackets`
Whether angle brackets used instead of curly braces should be preserved
when outputting a formatted textproto.
### Before formatting
[Example](examples/preserve_angle_brackets.IN.textproto)
### After formatting
[Example](examples/preserve_angle_brackets.OUT.textproto)
## RemoveDuplicateValuesForRepeatedFields
`# txtpbfmt: remove_duplicate_values_for_repeated_fields`
Remove lines that have the same field name and scalar value as another.
### Before formatting
[Example](examples/remove_duplicate_values_for_repeated_fields.IN.textproto)
### After formatting
[Example](examples/remove_duplicate_values_for_repeated_fields.OUT.textproto)
## SkipAllColons
`# txtpbfmt: skip_all_colons`
Skip colons whenever possible.
### Before formatting
[Example](examples/skip_all_colons.IN.textproto)
### After formatting
[Example](examples/skip_all_colons.OUT.textproto)
## SmartQuotes
`# txtpbfmt: smartquotes`
Use single quotes around strings that contain double but not single quotes.
### Before formatting
[Example](examples/smartquotes.IN.textproto)
### After formatting
[Example](examples/smartquotes.OUT.textproto)
## SortFieldsByFieldName
`# txtpbfmt: sort_fields_by_field_name`
Sort fields by field name.
### Before formatting
[Example](examples/sort_fields_by_field_name.IN.textproto)
### After formatting
[Example](examples/sort_fields_by_field_name.OUT.textproto)
## SortRepeatedFieldsByContent
`# txtpbfmt: sort_repeated_fields_by_content`
Sort adjacent scalar fields of the same field name by their contents.
### Before formatting
[Example](examples/sort_repeated_fields_by_content.IN.textproto)
### After formatting
[Example](examples/sort_repeated_fields_by_content.OUT.textproto)
## SortRepeatedFieldsBySubfield
`# txtpbfmt: sort_repeated_fields_by_subfield=[subfieldSpec]`
Sort adjacent message fields of the given field name by the contents of the given subfield.
`subfieldSpec` is of one of two forms
* `fieldName.subfieldName`, which will sort fields named `fieldName` by the value of their subfield named `subfieldName`.
* `subfieldName`, which will sort any field by its subfield named `subfieldName`
### Before formatting
[Example](examples/sort_repeated_fields_by_subfield.IN.textproto)
### After formatting
[Example](examples/sort_repeated_fields_by_subfield.OUT.textproto)
## WrapHTMLStrings
`# txtpbfmt: wrap_html_strings`
Whether strings that appear to contain HTML tags should be wrapped
(requires WrapStringsAtColumn to be set).
### Before formatting
[Example](examples/wrap_html_strings.IN.textproto)
### After formatting
[Example](examples/wrap_html_strings.OUT.textproto)
## WrapStringsAtColumn
`# txtpbfmt: wrap_strings_at_column=[column]`
Max columns for string field values. If zero, no string wrapping will occur.
Strings that may contain HTML tags will not be wrapped unless
`wrap_html_strings` is also specified.
### Before formatting
[Example](examples/wrap_strings_at_column.IN.textproto)
### After formatting
[Example](examples/wrap_strings_at_column.OUT.textproto)
|
