Fix conflict within PSR12.ControlStructures.ControlStructureSpacing #581
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
fredden
force-pushed
the
fixer-conflict/PSR12.ControlStructures.ControlStructureSpacing
branch
from
4baa479
to
e67fe56
Compare
jrfnl
reviewed
Jul 30, 2024
src/Standards/PSR12/Tests/ControlStructures/ControlStructureSpacingUnitTest.inc
Outdated
Show resolved
Hide resolved
src/Standards/PSR12/Tests/ControlStructures/ControlStructureSpacingUnitTest.inc
Outdated
Show resolved
Hide resolved
src/Standards/PSR12/Sniffs/ControlStructures/ControlStructureSpacingSniff.php
Outdated
Show resolved
Hide resolved
For multi-line control structures, the first line of code must be on the next line after the control structure. This sniff correctly identified such cases. When the first line of code was on the same line as the control structure, the sniff correctly fixed this by adding a newline between these. However, when there were multiple blank lines between these, the fixer would continue adding new newlines. This change fixes this bug by first removing all non-indentation white-space before adding the one expected newline. Includes test.
fredden
force-pushed
the
fixer-conflict/PSR12.ControlStructures.ControlStructureSpacing
branch
from
d931828
to
d9e164d
Compare
fredden
deleted the
fixer-conflict/PSR12.ControlStructures.ControlStructureSpacing
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
While looking into a fixer conflict for the PSR12 standard regarding the
src/Standards/Squiz/Tests/ControlStructures/ForLoopDeclarationUnitTest.1.incfile, it was noted that the fixer forPSR12.ControlStructures.ControlStructureSpacingwas conflicting with itself.For multi-line control structures, the first line of code must be on the next line after the control structure. This sniff correctly identified such cases. When the first line of code was on the same line as the control structure, the sniff correctly fixed this by adding a newline between these. However, when there were multiple blank lines between these, the fixer would continue adding new newlines.
This change fixes this bug by first removing all white-space before adding the one expected newline. Includes test.
Suggested changelog entry
PSR12.ControlStructures.ControlStructureSpacing: correctly handle multiple empty newlines between the start of a multi-line control structure and the next line of code.Related issues/external references
#152
Types of changes
PR checklist