Squiz/FunctionSpacing: fixer is broken with doc comment on closing brace line#784
Merged
jrfnl merged 2 commits intoPHPCSStandards:masterfrom Jan 12, 2025
Merged
Conversation
jrfnl
approved these changes
Jan 12, 2025
Member
jrfnl
left a comment
There was a problem hiding this comment.
I can confirm the sniff getting into a fixer conflict with itself with the provided code sample and that the patch fixes this.
Generally speaking this sniff doesn't care about other content on the same line as the function declaration. Code like the below will not be flagged by the sniff:
function c() {} function d() {}
But in the case of a "trailing" docblock, this meant that the sniff was adding the new lines within the doc block, which, in turn, meant it would still not see the "blank lines after" in the next loop, as the added lines would be seen as doc comment lines, not blank lines. Hence, the fixer conflict.
Thanks for fixing this @klausi !
jrfnl
pushed a commit
that referenced
this pull request
Jan 12, 2025
…ace line (#784) The fixer in Squiz.WhiteSpace.FunctionSpacing gets confused when there is a doc comment on the closing brace line. Generally speaking this sniff doesn't care about other content on the same line as the function declaration. But in the case of a "trailing" docblock, this meant that the sniff was adding the new lines _within_ the doc block, which, in turn, meant it would still not see the "blank lines after" in the next loop, as the added lines would be seen as doc comment lines, not blank lines. Hence, the fixer conflict. Fixed now.
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
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 fixer in Squiz.WhiteSpace.FunctionSpacing gets confused when there is a doc comment on the closing brace line:
Description
Solves this fixer infinite loop
Suggested changelog entry
Squiz.WhiteSpace.FunctionSpacing: Fix the fixer when there is a doc comment on the function closing line.
Related issues/external references
https://www.drupal.org/project/coder/issues/3461139
Types of changes
PR checklist