Skip to content

Commit

Permalink
Add exit code information to cli docs (#6049)
Browse files Browse the repository at this point in the history
* Update docs 👍

Add information regarding exit codes to the cli docs

* Markdown fix 🚧

Docs linting fixes

* Remove extraneous whitespace
  • Loading branch information
jamesgeorge007 authored and j-f1 committed Apr 16, 2019
1 parent 9179743 commit ed15b6d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@ Applying this practice will minimise the number of times the CI fails because of

If you need to pipe the list of unformatted files to another command, you can use [`--list-different`](cli.md#list-different) flag instead of `--check`.

### Exit codes

| Code | Information |
| ---- | ----------------------------------- |
| 0 | Everything formatted properly |
| 1 | Something wasn't formatted properly |
| 2 | Something's wrong with Prettier |

## `--debug-check`

If you're worried that Prettier will change the correctness of your code, add `--debug-check` to the command. This will cause Prettier to print an error message if it detects that code correctness might have changed. Note that `--write` cannot be used with `--debug-check`.
Expand Down

0 comments on commit ed15b6d

Please sign in to comment.