Skip to content

Commit 6049849

Browse files
committed
Update readme about output formats
1 parent 2772198 commit 6049849

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,10 +160,12 @@ To check whether files have been formatted (but not write directly to them), use
160160
It will take files as input, and output a diff to stdout instead of rewriting the file contents.
161161
If there are files which haven't been fully formatted, StyLua will exit with status code 1.
162162

163-
By default, we provide a custom Standard diff view, but this can be configured:
163+
There are different styles of output that are available:
164164

165+
- `--output-format=standard`: output a custom pretty diff (default)
165166
- `--output-format=unified`: output a unified diff, which can be consumed by tools like `patch` or `delta`
166-
- `--output-format=json`: output JSON representing the changes, useful for machine-readable output
167+
- `--output-format=json`: output JSON representing the changes, useful for machine-readable output (usable in non-check mode as well)
168+
- `--output-format=summary`: output a summary list of file paths that are incorrectly formatted
167169

168170
### `--verify`: Verifying formatting output
169171

0 commit comments

Comments
 (0)