Squiz.WhiteSpace.FunctionSpacing is removing indents from the start of functions when fixing #2110
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
When too many blank lines are found before a function, the `Before/BeforeFirst` fixer would unnecessarily also remove the indentation of the `$nextContent` line, meaning that this sniff would **always** need to be accompanied by one or more sniffs to fix the indentation again. As this sniff is about blank lines between functions, not about indentation, I consider this a bug. This minor change fixes it. Includes unit tests demonstrating the issue.
When too few blank lines are found before a function, the `Before/BeforeFirst` fixer would unnecessarily also remove the indentation of the `$nextContent` line and leave the indentation on the newly added blank line, meaning that this sniff would **always** need to be accompanied by one or more sniffs to fix the indentation again and to remove trailing whitespace. As this sniff is about blank lines between functions, not about indentation, I consider this a bug. This minor change fixes it. Includes unit tests demonstrating the issue.
|
Just realized that the same problem existed when there would be too few blank lines before a function. This new fix also documents how this sniff handles PHPCS annotations found before a function - which may not be as desired -, but I haven't changed the behaviour regarding this. |
gsherwood
changed the title
|
100% agree. Thanks for fixing this. |
jrfnl
deleted the
feature/squiz-functionspacing-fixer-removes-indentation
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.
When too many blank lines are found before a function, the
Before/BeforeFirstfixer would unnecessarily also remove the indentation of the$nextContentline, meaning that this sniff would always need to be accompanied by one or more sniffs to fix the indentation again.As this sniff is about blank lines between functions, not about indentation, I consider this a bug.
This minor change fixes it.
Includes unit tests demonstrating the issue.