Disable report for phpcbf

[GaryJones]

Is there a way to disable reporting for phpcbf?

Something like: phpcbf -q --report=none .?

[gsherwood]

No, but which output do you want to suppress? The output showing you which files are being fixed and or the final report showing you what was done (or both)?

You could always redirect STDOUT to /dev/null (or NUL for Windows, I think it is) if you want no output at all.

[gsherwood]

Sorry, should have mentioned -q works, but only suppresses that progress output. The final report still shows, so you are probably wanting to suppress that, which there is no way to do.

[GaryJones]

My use case: generating files with zend-code (via a composer script), which doesn't completely comply with PSR-2. Running phpcbf automatically after generation, I have no need for any report to show i.e. silent fixing, since it's just removing redundant blank lines that break PSR-2 compatibility.

> /dev/null seems to work in terms of hiding the output from phpcbf, though Composer is giving me a notice that the script returned with error code 1.

"generate-types": "vendor/bin/soap-client generate:types --config ./config/generate.php && phpcbf -q src/SoapTypes > /dev/null && echo \"Types have been generated to src/SoapTypes. (Ignore the error code message.)\"",

Even with the report still showing, the error code message still persists. Is there a way to override that?

[gsherwood]

The exit codes tell you what PHPCBF did, and can not be changed using config settings:

• Exit code 0 is used to indicate that no fixable errors were found, so nothing was fixed
• Exit code 1 is used to indicate that all fixable errors were fixed correctly
• Exit code 2 is used to indicate that PHPCBF failed to fix some of the fixable errors it found
• Exit code 3 is used for general script execution errors

I'm not sure what config options you have, but if you can have the script error only on exit codes > 1 then it would make more sense. Otherwise, you'll need to see if you can ignore the exit code for PHPCBF if you don't actually care what it did.

[GaryJones]

The exit code here is 1: phpcbf fixed everything that could be fixed (running phpcbf again doesn't give me any exit code message).

Composer custom scripts don't appear to have a way to override the exit code, so even though PHPCBF was 100% successful, it's still reported with a big scary red message.

I have found one workaround though. The relevant part of my script:

phpcbf -q src/SoapTypes > /dev/null || true

---

It still might be useful for some to have phpcbf output no report and no error code, but for now at least, my issue is solved. I'm leaving the issue open in case you wish to pursue, but otherwise, it can be closed.

[gsherwood]

Glad you found a solution for your case. I think an option to disable reporting (or at least change the exit code) would be helpful.

[jrfnl]

It may be an idea to add an option to use industry standard exit codes ?
Something like --exit-codes=zero-based

I realize changing the codes now would break BC too much, but adding an option to use the more common standard of 0 = success, non-0 = failure could be helpful.

I would expect the current exit codes of 0 and 1 to both report as 0 (success) in that case.

Refs:

• http://tldp.org/LDP/abs/html/exit-status.html
• https://www.gnu.org/software/libc/manual/html_node/Exit-Status.html
• http://pubs.opengroup.org/onlinepubs/9699919799//utilities/V3_chap02.html#tag_18_08_02
• https://en.wikipedia.org/wiki/Exit_status

[jrfnl]

Related: #1359