Auto fix for Squiz.Commenting.BlockComment.WrongEnd is incorrect #748
Conversation
This file contains hidden or 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
The `$stackPtr` was being used instead of `$end`, leading to the comment opener being replaced with `*/`. This would cause a syntax error in the “fixed” PHP file. The sniff did not have a test for the fixing component, which is why this wasn’t caught sooner. I’ve added the `.fixed` file, but it is just a copy of the `.inc` file, because I didn’t know for sure whether all of the fixing behavior is correct. So currently the tests are intentionally failing. See https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards squizlabs/issues/478
gsherwood changed the title 
| Thanks a lot for finding and fixing that. |
jrfnl added a commit to jrfnl/PHP_CodeSniffer that referenced this pull request Dec 7, 2024
…ion-short-list-bug Squiz/ArrayDeclaration: fixes false positive when handling short lists inside `foreach`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
The
$stackPtrwas being used instead of$end, leading to thecomment opener being replaced with
*/. This would cause a syntaxerror in the “fixed” PHP file.
The sniff did not have a test for the fixing component, which is why
this wasn’t caught sooner. I’ve added the
.fixedfile, but it is justa copy of the
.incfile, because I didn’t know for sure whether allof the fixing behavior is correct. So currently the tests are
intentionally failing.
See
WordPress/WordPress-Coding-Standards#478