Skip to content

Commit

Permalink
Add section to README for exit codes (refs #75).
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidAnson committed Feb 8, 2020
1 parent a1713b7 commit b0dfa3d
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,15 @@ If it is not provided, `markdownlint-cli` looks for file `.markdownlint.json`/`.
The algorithm is described in details on [rc package page][rc-standards].
If `--config` argument is provided, the file must be valid JSON, JSONC, or YAML.

## Exit codes

`markdownlint-cli` returns one of the following exit codes:

- `0`: Program ran successfully
- `1`: Linting errors / bad parameter
- `2`: Unable to write `-o`/`--output` output file
- `3`: Unable to load `-r`/`--rules` custom rule

## Related

- [markdownlint][markdownlint] - API for this module
Expand Down

0 comments on commit b0dfa3d

Please sign in to comment.