Generic opening brace placement sniffs incorrectly move PHPCS annotations #1938
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
…ations As discussed in 1931, moving a trailing `phpcs:ignore` annotation to the next line changes its meaning, which is what currently happens when the `ContentAfterBrace` error is triggered by one of the new PHPCS annotations in the `Generic.Functions.OpeningFunctionBraceKernighanRitchie` and `Generic.Functions.OpeningFunctionBraceBsdAllman` sniffs. For the `Generic.Functions.OpeningFunctionBraceBsdAllman` sniff, this also impacts the fixer of the `BraceOnSameLine` errror which could also move the comment down. This PR fixes that. For this fix, I've chosen to ignore *all* the PHPCS annotations, not just the `phpcs:ignore` one. If so desired, I can change the PR to only make an exception for a trailing `phpcs:ignore` comment and to move `phpcs:disable/enable/set` comments to the next line, just like "normal" comments. Includes unit tests.
gsherwood
changed the title
gsherwood
added a commit
that referenced
this pull request
Mar 15, 2018
I think that makes sense. Thanks a lot for fixing this. |
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.
As discussed in #1931, moving a trailing
phpcs:ignoreannotation to the next line changes its meaning, which is what currently happens when theContentAfterBraceerror is triggered by one of the new PHPCS annotations in theGeneric.Functions.OpeningFunctionBraceKernighanRitchieandGeneric.Functions.OpeningFunctionBraceBsdAllmansniffs.For the
Generic.Functions.OpeningFunctionBraceBsdAllmansniff, this also impacts the fixer of theBraceOnSameLineerrror which could also move the comment down.This PR fixes that.
For this fix, I've chosen to ignore all the PHPCS annotations, not just the
phpcs:ignoreone. If so desired, I can change the PR to only make an exception for a trailingphpcs:ignorecomment and to movephpcs:disable/enable/setcomments to the next line, just like "normal" comments.Includes unit tests.