8000 README: Update executable documentation · zendesk/googlejavaformat-action@a2dfb4e · GitHub
[go: up one dir, main page]
Skip to content

Commit a2dfb4e

Browse files
axel-opaxel-op
authored
README: Update executable documentation
1 parent 7956d16 commit a2dfb4e

File tree

1 file changed

+35
-38
lines changed

1 file changed

+35
-38
lines changed

‎README.md

Lines changed: 35 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -87,44 +87,41 @@ The arguments to pass to the Google Java Format executable.
8787
By default, only `--replace` is used.
8888

8989
```console
90-
-i, -r, -replace, --replace
91-
Send formatted output back to files, not stdout.
92-
93-
--assume-filename, -assume-filename
94-
File name to use for diagnostics when formatting standard input (default is <stdin>).
95-
96-
--aosp, -aosp, -a
97-
Use AOSP style instead of Google Style (4-space indentation).
98-
99-
--fix-imports-only
100-
Fix import order and remove any unused imports, but do no other formatting.
101-
102-
--skip-sorting-imports
103-
Do not fix the import order. Unused imports will still be removed.
104-
105-
--skip-removing-unused-imports
106-
Do not remove unused imports. Imports will still be sorted.
107-
108-
--skip-reflowing-long-strings
109-
(JDK 11+) Do not reflow string literals that exceed the column limit.
110-
111-
--skip-javadoc-formatting
112-
(JDK 11+) Do not reformat javadoc.
113-
114-
--dry-run, -n
115-
Prints the paths of the files whose contents would change if the formatter were run normally.
116-
117-
--set-exit-if-changed
118-
Return exit code 1 if there are any formatting changes.
119-
120-
--length, -length
121-
Character length to format.
122-
123-
--lines, -lines, --line, -line
124-
Line range(s) to format, like 5:10 (1-based; default is all).
125-
126-
--offset, -offset
127-
Character offset to format (0-based; default is all).
90+
Options:
91+
-i, -r, -replace, --replace
92+
Send formatted output back to files, not stdout.
93+
--aosp, -aosp, -a
94+
Use AOSP style instead of Google Style (4-space indentation).
95+
--fix-imports-only
96+
Fix import order and remove any unused imports, but do no other formatting.
97+
--skip-sorting-imports
98+
Do not fix the import order. Unused imports will still be removed.
99+
--skip-removing-unused-imports
100+
Do not remove unused imports. Imports will still be sorted.
101+
--skip-reflowing-long-strings
102+
Do not reflow string literals that exceed the column limit.
103+
--skip-javadoc-formatting
104+
Do not reformat javadoc.
105+
--dry-run, -n
106+
Prints the paths of the files whose contents would change if the formatter were run normally.
107+
--set-exit-if-changed
108+
Return exit code 1 if there are any formatting changes.
109+
--lines, -lines, --line, -line
110+
Line range(s) to format, like 5:10 (1-based; default is all).
111+
--offset, -offset
112+
Character offset to format (0-based; default is all).
113+
--length, -length
114+
Character length to format.
115+
--help, -help, -h
116+
Print this usage statement.
117+
--version, -version, -v
118+
Print the version.
119+
@<filename>
120+
Read options and filenames from file.
121+
122+
The --lines, --offset, and --length flags may be given more than once.
123+
The --offset and --length flags must be given an equal number of times.
124+
If --lines, --offset, or --length are given, only one file may be given.
128125
```
129126

130127
Note:

0 commit comments

Comments
 (0)
0