vitalif-js
/
prettier
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add exit code information to cli docs (#6049) 

* Update docs 👍

Add information regarding exit codes to the cli docs

* Markdown fix 🚧

Docs linting fixes

* Remove extraneous whitespace
master
James George 2019-04-16 17:10:11 +05:30 committed by Jed Fox
parent 91797439d9
commit ed15b6d04e
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/cli.md
View File

@ -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`.