Skip to content

4.0 | Wiki/Advanced-Usage: add the cumulative exit codes #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 28, 2025
Merged

4.0 | Wiki/Advanced-Usage: add the cumulative exit codes #51

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2c1b135
4.0 | Wiki: add the cumulative exit codes
yCodeTech Aug 27, 2025
0a2036f
fix: cumulative exit codes table formatting
yCodeTech Aug 27, 2025
5634b9b
4.0 | Wiki: change cumulative exit codes table and example paragraph
yCodeTech Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions wiki/Advanced-Usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -515,16 +515,22 @@ If a coding standard or configuration file includes settings to print progress o

As of PHP_CodeSniffer 4.0.0, exit codes are cumulative and composed as follows:

| Exit code | Meaning |
| --------- | ------------------------------------------------------------------------------------------------------- |
| `0` | clean code base / successful non-scan request (_help/documentation/etc_) |
| `1` | issues found/remaining, auto-fixable |
| `2` | issues found/remaining, non-auto-fixable |
| `4` | failure to fix some files/fixer conflict (phpcbf only) |
| `16` | processing error - blocking the actual run of PHP_CodeSniffer, like a parse error in an XML ruleset |
| `64` | requirements for running not met (i.e. minimum PHP version doesn't comply, missing required extensions) |

Example: when running `phpcs`, if both auto-fixable as well as non-auto-fixable issues are found, the exit code will be `3` (`1` + `2`).
| Exit code | Meaning |
| --------- | -------------------------------------------------------------------------------------------------------------- |
| `0` | clean code base / auto-fixed with no issues remaining / successful non-scan request (_help/documentation/etc_) |
| `1` | issues found/remaining, auto-fixable |
| `2` | issues found/remaining, non-auto-fixable |
| `4` | failure to fix some files/fixer conflict (phpcbf only) |
| `16` | processing error - blocking the actual run of PHP_CodeSniffer, like a parse error in an XML ruleset |
| `64` | requirements for running not met (i.e. minimum PHP version doesn't comply, missing required extensions) |

The exit codes in some situations can be combined, resulting in a new exit code. These cumulative exit codes are as follows:

| Exit code | Exit codes used | Meaning |
| --------- | --------------- | -------------------------------------------------------------------------------------------- |
| `3` | `1` + `2` | issues found, mix of auto-fixable and non-auto-fixable (phpcs only) |
| `5` | `1` + `4` | issues found, auto-fixable, but some failed to fix (phpcbf only) |
| `7` | `1` + `2` + `4` | issues found, mix of auto-fixable and non-auto-fixable, but some failed to fix (phpcbf only) |

The exit codes can be influenced by the following configuration flags: [`ignore_errors_on_exit`](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Configuration-Options#ignoring-errors-when-generating-the-exit-code), [`ignore_warnings_on_exit`](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Configuration-Options#ignoring-warnings-when-generating-the-exit-code) and [`ignore_non_auto_fixable_on_exit`](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Configuration-Options#ignoring-non-auto-fixable-issues-when-generating-the-exit-code).

Expand Down
Loading