feat: require squizlabs/php_codesniffer v4

[simPod]

Closes #345

Resolves #263

[derrabus]

Do we have make a hard bump here or could we support both major versions at the same time?

[kukulich]

slevomat/coding-standard force the 4.0 too (in the 8.23). I may be possible to support both versions but there are some internal changes in PHPCS and it requires more work than I was willing to put into it…

[simPod]

E.g. this definition is not v3/v4 cross compatible.

And also what @kukulich said.

[jrfnl]

@simPod Eh... sorry, but no. What's on the right there has been supported by PHPCS since a very very long time, so definitely cross-version compatible.

[simPod]

ok, that I missed. But still, this CS relies heavily on Slevomat's CS which requires v4 so allowing v3 here has no point if I'm not missing anything.

[jrfnl]

Yeah, I saw that and respect @kukulich's decision in that.
In most cases, making sniffs PHPCS 3/4 cross-version compatibility isn't necessarily that hard, though yes, it does mean more work/higher cognitive load for a period of time and I totally get it if someone maintaining an external standard does not want to have to deal with that.

For the record: PHPCSUtils, PHPCSExtra and PHPCompatibility have all been made cross-version compatible.

[greg0ire]

Thanks @simPod !

[greg0ire]

@simPod sorry for not asking earlier, but do you know the breaking changes are exactly? Are there new sniffs? Or will this maybe break some CIs somehow?

[simPod]

Sure. I went through the upgrade guide and didn’t find anything that would significantly impact end users.

From what I understand, the v4 release is mainly a cleanup and consolidation effort—removing legacy code and streamlining things. It seems to primarily affect sniff developers, while regular PHPCS users with clean configurations shouldn’t notice much change. I even did not have to touch tests here.

(maybe Juliette can elaborate)

[greg0ire]

Oh OK, then I guess it's not worth publishing 14.0.0 yet?

[simPod]

IMO yes cuz otherwise people would be blocked from upgrading Slevomat CS to further versions (new sniffs and fixes) 🙃.

E.g. I require both Doctrine CS and Slevomat CS. But Doctrine's one now blocks me from upgrading to Squizlab's v4 and thus upgrading Slevomat's.

[jrfnl]

From what I understand, the v4 release is mainly a cleanup and consolidation effort—removing legacy code and streamlining things. It seems to primarily affect sniff developers, while regular PHPCS users with clean configurations shouldn’t notice much change. I even did not have to touch tests here.

That's correct and anything I could think of that would impact end/dev users is documented in the upgrade guides:

• https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Version-4.0-User-Upgrade-Guide
• https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Version-4.0-Developer-Upgrade-Guide

Aside from that, there is also the changelog of course:

• https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/4.x/CHANGELOG-4.x.md

The reason I made PHPCSUtils, PHPCSExtra and PHPCompatibility cross-version compatible is to allow for end-users which use a combination of external standards, some of which may be ready for 4.x and some of which may not.

If your user-base is known to often combine multiple external standards, making the package PHPCS cross-version compatible may be preferred to allow users to upgrade [to PHPCS 4.x] as soon as possible, while still benefiting from updates to your package if they can't upgrade to PHPCS 4.x yet.

Also see: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Version-4.0-Developer-Upgrade-Guide#should-i-upgrade-