PEAR/FunctionDeclaration: prevent fixer conflict for unfinished closures/live coding #827
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
…res/live coding
The `PEAR.Functions.FunctionDeclaration` sniff contained code to protect against a fixer conflict for unfinished closures, however, this code did not work correctly as an unfinished closure will generally also not have a function body, which "undoes" the protection via the scope opener check.
In other words, the fixer conflict still existed and would result in one part of the sniff trying to _add_ a space between the `function` keyword and the open parenthesis, while another part of the sniff would be removing that space again.
```
=> Fixing file: 1/1 violations remaining
PEAR.Functions.FunctionDeclaration:124 replaced token 11 (T_WHITESPACE on line 7) " (" => "("
=> Fixing file: 1/1 violations remaining [made 1 pass]...
* fixed 1 violations, starting loop 2 *
PEAR.Functions.FunctionDeclaration:94 replaced token 10 (T_FUNCTION on line 7) "function" => "function "
=> Fixing file: 1/1 violations remaining [made 2 passes]...
* fixed 1 violations, starting loop 3 *
PEAR.Functions.FunctionDeclaration:124 replaced token 11 (T_WHITESPACE on line 7) " (" => "("
=> Fixing file: 1/1 violations remaining [made 3 passes]...
* fixed 1 violations, starting loop 4 *
PEAR.Functions.FunctionDeclaration:94 replaced token 10 (T_FUNCTION on line 7) "function" => "function "
=> Fixing file: 1/1 violations remaining [made 4 passes]...
* fixed 1 violations, starting loop 5 *
```
Fixed now by verifying if the function is named instead. That way we can be sure it's not a closure.
Includes test.
Builds on the previously pulled fix from PR 816.
Related to #152
fredden
approved these changes
Feb 17, 2025
|
Thanks for reviewing @fredden ! |
jrfnl
deleted the
feature/pear-functiondeclaration-prevent-fixer-conflict
branch
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
The
PEAR.Functions.FunctionDeclarationsniff contained code to protect against a fixer conflict for unfinished closures, however, this code did not work correctly as an unfinished closure will generally also not have a function body, which "undoes" the protection via the scope opener check.In other words, the fixer conflict still existed and would result in one part of the sniff trying to add a space between the
functionkeyword and the open parenthesis, while another part of the sniff would be removing that space again.Fixed now by verifying if the function is named instead. That way we can be sure it's not a closure.
Includes test.
Suggested changelog entry
PEAR.Functions.FunctionDeclaration could get into a fixer conflict over an unfinished closure during live coding
Related issues/external references
Builds on the previously pulled fix from PR #816.
Related to #152
Types of changes