Skip to content

Commit

Permalink
Update README.md by adding a note about exit codes
Browse files Browse the repository at this point in the history
  • Loading branch information
yoheimuta committed Jul 25, 2020
1 parent 3dd6be8 commit f45a1c7
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,14 @@ protolint will search a current working directory for the config file by default
And it can search the specified directory with `-config_dir_path` flag.
It can also search the specified file with `--config_path` flag.

## Exit codes

When linting files, protolint will exit with one of the following exit codes:

- `0`: Linting was successful and there are no linting errors.
- `1`: Linting was successful and there is at least one linting error.
- `2`: Linting was unsuccessful due to all other errors, such as parsing, internal, and runtime errors.

## Motivation

There exists the similar protobuf linters as of 2018/12/20.
Expand Down

0 comments on commit f45a1c7

Please sign in to comment.