Skip to content

Commit 934c305

Browse files
committed
Configuration Options: minor readability improvements
1 parent 3fc8ab2 commit 934c305

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

wiki/Configuration-Options.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,10 @@ $ phpcs --config-set php_version 70416
192192
193193
## Ignoring errors when generating the exit code
194194
195-
By default, PHP_CodeSniffer will exit with a non-zero code if any errors or warnings are found. If you want to display errors to the user, but still return with a zero exit code if no warnings are found, you can set the `ignore_errors_on_exit` configuration option. This option is typically used by automated build tools so that a list of errors can be generated without failing the build.
195+
By default, PHP_CodeSniffer will exit with a non-zero code if any errors or warnings are found.
196+
197+
If you want to display errors to the user, but still return with a zero exit code if no warnings are found, you can set the `ignore_errors_on_exit` configuration option.
198+
_This option is typically used by automated build tools so that a list of errors can be generated without failing the build._
196199
197200
```bash
198201
$ phpcs --config-set ignore_errors_on_exit 1
@@ -210,7 +213,10 @@ $ phpcs --config-set ignore_warnings_on_exit 1
210213
211214
## Ignoring warnings when generating the exit code
212215
213-
By default, PHP_CodeSniffer will exit with a non-zero code if any errors or warnings are found. If you want to display warnings to the user, but still return with a zero exit code if no errors are found, you can set the `ignore_warnings_on_exit` configuration option. This option is typically used by automated build tools so that a list of warnings can be generated without failing the build.
216+
By default, PHP_CodeSniffer will exit with a non-zero code if any errors or warnings are found.
217+
218+
If you want to display warnings to the user, but still return with a zero exit code if no errors are found, you can set the `ignore_warnings_on_exit` configuration option.
219+
_This option is typically used by automated build tools so that a list of warnings can be generated without failing the build._
214220
215221
```bash
216222
$ phpcs --config-set ignore_warnings_on_exit 1
@@ -222,8 +228,9 @@ $ phpcs --config-set ignore_warnings_on_exit 1
222228
## Ignoring non-auto-fixable issues when generating the exit code (PHP_CodeSniffer >= 4.0.0)
223229
224230
By default, PHP_CodeSniffer will exit with a non-zero code if any errors or warnings are found, whether these are auto-fixable or not.
225-
If you want to display non-auto-fixable errors and warnings to the user, but still return with a zero exit code if non-auto-fixable issues are found, you can set the `ignore_non_auto_fixable_on_exit` configuration option.
226-
This option is typically used by automated build tools so that a `phpcbf` run can exit with `0` if it fixed all fixable issues, but there are still some non-auto-fixable issues remaining.
231+
232+
If you want to display non-auto-fixable errors and warnings to the user, but still return with a zero exit code if non-auto-fixable issues are found, you can set the `ignore_non_auto_fixable_on_exit` configuration option.
233+
_This option is typically used by automated build tools so that a `phpcbf` run can exit with `0` if it fixed all fixable issues, but there are still some non-auto-fixable issues remaining._
227234
228235
```bash
229236
$ phpcs --config-set ignore_non_auto_fixable_on_exit 1

0 commit comments

Comments
 (0)