Report warnings but return a zero exit code

[rcrowe]

I want to report to console/checkstyle any warnings, but I do not want the exit code to be > 0. Currently warnings are returning a 1.

All I could find was suppressing but this means nothing is output.

[aik099]

You want phpcs executable that found coding standard violations in checked code to exit with 0 exit code in shell?

[aik099]

The exit code is returned to inform Continuous Integration Server about process status so it can call it's error handling routines. PHPUnit does the same.

[rcrowe]

Thats fine for errors, but I dont want it to happen with warnings

[rcrowe]

I want warnings reported, but don't cause my CI server to fail.

Warnings are issues but do not stop it from successfully building / deploying.

[aik099]

That makes sense. It's 00:15 for @gsherwood now, so we'll wait for him to post his ideas about backwards compatible implementation.

[gsherwood]

I understand the use case, but a change like this makes a very big assumption for all existing users. Having a config option for it may be the only way because I'm not prepared to break backwards compatibility in this area.

So you'd need to run PHP_CodeSniffer something like this: phpcs --runtime-set exitIgnoreWarnings true --standard=MyStandard /path/to/code

(although I'd need to think of a good config option name)

You can also set the config option once and let PHPCS read it from the config file, but the CLI arg makes it more obvious in an automated script.

Let me know if that sounds like something that would work for you.

[rcrowe]

Exactly what I was after; no intention on altering how it works by default so the cli flag is perfect.

[rcrowe]

For the time being I've had to commit the codesniffer dependency & change line 242 to the following:

return $this->totalErrors;

So would be very grateful for the enhancement.

[gsherwood]

I've committed this feature now. It's only in the 2.x version because it changes the return value of the main printReport() method, which is a bit risky.

To use it, run PHPCS like this: phpcs --runtime-set ignore_warnings_on_exit true /path/to/code

[tim-bezhashvyly]

It will make sense to add this to wiki.

Also why also not create ignore_errors_on_exit flag? As a usecase I'm running phpcs as a composer script and would like to just get the report w/o 1 response code as in this case composer goes all red telling that phpcs suffered a "RuntimeException".

[gsherwood]

That flag was already documented on the config options page of the wiki: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options#ignoring-warnings-when-generating-the-exit-code

Adding an ignore_errors_on_exit option was a good idea, so I committed it here: 897df04

And documented it here: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options#ignoring-errors-when-generating-the-exit-code

Thanks

[tim-bezhashvyly]

Great! Thanks a lot!