Skip to content

Commit b0dfa3d

Browse files
committedFeb 8, 2020
Add section to README for exit codes (refs #75).
1 parent a1713b7 commit b0dfa3d

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed
 

‎README.md

+9
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,15 @@ If it is not provided, `markdownlint-cli` looks for file `.markdownlint.json`/`.
8888
The algorithm is described in details on [rc package page][rc-standards].
8989
If `--config` argument is provided, the file must be valid JSON, JSONC, or YAML.
9090

91+
## Exit codes
92+
93+
`markdownlint-cli` returns one of the following exit codes:
94+
95+
- `0`: Program ran successfully
96+
- `1`: Linting errors / bad parameter
97+
- `2`: Unable to write `-o`/`--output` output file
98+
- `3`: Unable to load `-r`/`--rules` custom rule
99+
91100
## Related
92101

93102
- [markdownlint][markdownlint] - API for this module

0 commit comments

Comments
 (0)
Please sign in to comment.