PSR1/SideEffects: improve recognition of disable/enable annotations #3772
Conversation
As it was, the sniff would respect PHPCS disable annotations, but only when either unqualified or qualified up to a sniff name. It would not respect a disable annotation using a sniffname with errorcode, i.e. `PSR1.Files.SideEffects.FoundWithSymbols`. While the `FoundWithSymbols` errorcode is the only error code for this sniff and using `// phpcs:disable PSR1.Files.SideEffects.FoundWithSymbols` is effectively the same as using `// phpcs:disable PSR1.Files.SideEffects`, I do believe end-users should not need to be aware of whether or not a sniff has multiple error codes when using disable annotations. This updates the sniff to also respect disable annotations which include the error code. Includes unit test. Fixes 3386
|
Hmm seems like its not happy on 8.2 :( would love to see this get working, but I haven't contributed before... so not sure how to attempt. |
The 8.2 issue is unrelated to this PR, so should not be a blocker for this PR to get merged. |
|
The test failure on 8.2 should be fixed when #3773 gets merged in. |
|
Closing as replaced by PHPCSStandards/PHP_CodeSniffer#54 |
jrfnl
deleted the
feature/3386-psr1-sideffects-allow-for-ignore-with-errorcode
branch
|
FYI: this fix is included in today's PHP_CodeSniffer 3.8.0 release. As per #3932, development on PHP_CodeSniffer will continue in the PHPCSStandards/PHP_CodeSniffer repository. If you want to stay informed, you may want to start "watching" that repo (or watching releases from that repo). |
As it was, the sniff would respect PHPCS disable annotations, but only when either unqualified or qualified up to a sniff name. It would not respect a disable annotation using a sniffname with errorcode, i.e.
PSR1.Files.SideEffects.FoundWithSymbols.While the
FoundWithSymbolserrorcode is the only error code for this sniff and using// phpcs:disable PSR1.Files.SideEffects.FoundWithSymbolsis effectively the same as using// phpcs:disable PSR1.Files.SideEffects, I do believe end-users should not need to be aware of whether or not a sniff has multiple error codes when using disable annotations.This updates the sniff to also respect disable annotations which include the error code.
Includes unit test.
Fixes #3386