PSR12.ControlStructures.ControlStructureSpacing does not ignore comments between conditions #2730
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
PSR12 does not forbid comments interlaced in the conditions of a (multi-line) control structure.
However, the sniff didn't handle those correctly.
With the example code added to the unit test case file, the sniff, as it was, would throw an unsolvable error which would also cause fixer conflicts with the sniff itself:
```
82 | ERROR | [x] Each line in a multi-line control structure must be indented at least once; expected at least 8 spaces, but found 0
| | (PSR12.ControlStructures.ControlStructureSpacing.LineIndent)
```
```
# phpcbf ./psr12/tests/controlstructures/controlstructurespacingunittest.inc --standard=psr12 --sniffs=psr12.controlstructures.controlstructurespacing
PHP_CodeSniffer version 3.5.3 (stable) by Squiz (http://www.squiz.net)
PHPCBF RESULT SUMMARY
----------------------------------------------------------------------------------------------------------------------------------------
FILE FIXED REMAINING
----------------------------------------------------------------------------------------------------------------------------------------
/src/Standards/PSR12/Tests/ControlStructures/ControlStructureSpacingUnitTest.inc FAILED TO FIX
----------------------------------------------------------------------------------------------------------------------------------------
A TOTAL OF 17 ERRORS WERE FIXED IN 1 FILE
----------------------------------------------------------------------------------------------------------------------------------------
PHPCBF FAILED TO FIX 1 FILE
----------------------------------------------------------------------------------------------------------------------------------------
```
By ignoring lines where the first token is a comment, this issue will be fixed.
gsherwood
changed the title
Member
|
As much as I dont like comments between conditions, you're very right. Thanks for the PR. |
jrfnl
deleted the
feature/psr12-controlstructurespacing-allow-fix-comments
branch
Contributor
Author
|
You're welcome ;-) |
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.
PSR12 does not forbid comments interlaced in the conditions of a (multi-line) control structure.
However, the sniff didn't handle those correctly.
With the example code added to the unit test case file, the sniff, as it was, would throw an unsolvable error which would also cause fixer conflicts with the sniff itself:
By ignoring lines where the first token is a comment, this issue will be fixed.