PHP 8.3 | Ruleset::explain() fix deprecation notice #3876
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
On PHP 8.3, using the `-e` (explain) command would show a `Deprecated: Increment on non-alphanumeric string is deprecated in path/to/src/Ruleset.php on line 297` notice after the very first sniff being listed. As the `$lastCount` variable is used as a counter, it should have an integer default (start) value, not a text string. Fixed now. Testable via the command-line using the following command: ```bash phpcs -e --standard=PSR1 ``` Output without this fix: ``` The PSR1 standard contains 8 sniffs Generic (4 sniffs) ------------------ Generic.Files.ByteOrderMark Deprecated: Increment on non-alphanumeric string is deprecated in D:\000_GitHub\PHPCS\PHP_CodeSniffer\src\Ruleset.php on line 297 Generic.NamingConventions.UpperCaseConstantName Generic.PHP.DisallowAlternativePHPTags Generic.PHP.DisallowShortOpenTag PSR1 (3 sniffs) --------------- PSR1.Classes.ClassDeclaration PSR1.Files.SideEffects PSR1.Methods.CamelCapsMethodName Squiz (1 sniff) ---------------- Squiz.Classes.ValidClassName ``` Output with this fix: ``` The PSR1 standard contains 8 sniffs Generic (4 sniffs) ------------------ Generic.Files.ByteOrderMark Generic.NamingConventions.UpperCaseConstantName Generic.PHP.DisallowAlternativePHPTags Generic.PHP.DisallowShortOpenTag PSR1 (3 sniffs) --------------- PSR1.Classes.ClassDeclaration PSR1.Files.SideEffects PSR1.Methods.CamelCapsMethodName Squiz (1 sniff) ---------------- Squiz.Classes.ValidClassName ``` Note: yes, I'd like to add some tests for this, but it would be much easier to do so without the (partially unclosed) output buffers being created by this function, so I'm pulling this fix first and will refactor the method and add some tests at some point in the future.
fredden
approved these changes
Aug 14, 2023
DannyvdSluijs
approved these changes
Aug 24, 2023
jrfnl
changed the title
|
Tested these changes running phpcs from my local clone. Using Laravel Herd I could easily switch to PHP 8.3 beta. On the |
1 task
|
Closing as replaced by PHPCSStandards/PHP_CodeSniffer#84 |
|
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). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
On PHP 8.3, using the
-e(explain) command would show aDeprecated: Increment on non-alphanumeric string is deprecated in path/to/src/Ruleset.php on line 297notice after the very first sniff being listed.As the
$lastCountvariable is used as a counter, it should have an integer default (start) value, not a text string.Fixed now.
Testable via the command-line using the following command:
Output without this fix:
Output with this fix:
👉🏻 Note: yes, I'd like to add some tests for this, but it would be much easier to do so without the (partially unclosed) output buffers being created by this function, so I'm pulling this fix first and will refactor the method and add some tests at some point in the future.
Suggested changelog entry
Explain command: fixed PHP 8.3 deprecation notice
Related issues/external references
Refs: https://wiki.php.net/rfc/saner-inc-dec-operators
Types of changes