Squiz.WhiteSpace.MemberVarSpacing removes comments before first member var during auto fixing #2656
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
…member var If there would be comments (or commented out code) before the first member variable, the fixer as it was, would remove those comments, including potential PHPCS annotations. By allowing for others comments between the class opener/trait import `use` statement and a property, this is prevented. The fix now implemented means that if there is anything between the class opener/trait import `use` and the first property, other than a property docblock/comment, the property will be treated as any property and won't get the special "first property" treatment. Includes unit test.
gsherwood
changed the title
|
Thanks a lot for this fix. |
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.
Squiz/MemberVarSpacing: bug fix - don't remove comments before first member var
If there would be comments (or commented out code) before the first member variable, the fixer as it was, would remove those comments, including potential PHPCS annotations.
By allowing for other comments between the class opener/trait import
usestatement and a property, this is prevented.The fix now implemented means that if there is anything between the class opener/trait import
useand the first property, other than a property docblock/comment, the property will be treated as any property and won't get the special "first property" treatment.Includes unit test.