Various comment sniffs: fix fixer conflicts #1812
Merged
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
|
Just out of interest, are you running auto-fixes during live coding? If so, how is that working out? |
@gsherwood I'm not, but I am aware that there are IDEs out there which do. I'm currently still finding these fixer conflicts based on the ruleset tests as discussed in #1645 (comment) (still some 60-something fixer conflicts to go... ) |
|
Thanks for these fixes |
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.
Another small PR to deal with fixer conflicts.
When a docblock comment is unfinished and at the end of a file - typically found in live coding situations -, fixer conflicts would occur through a combination of the
Generic.Files.(No)Newline,Generic.Commenting.DocComment,Squiz.Commenting.DocCommentAlignmentand theSquiz.Commenting.FileCommentsniffs.The fixer conflicts can be reproduced by checking out the first commit, which just contains the tests demonstrating the issue, and running:
phpcbf -p -s -vv ./src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.inc --standard=Squizand
phpcbf -p -s -vv ./src/Standards/Squiz/Tests/Commenting/FileCommentUnitTest.2.inc --standard=SquizThe changes made in the second commit basically just prevent the sniffs from throwing errors/fixing when no valid docblock closer tag is found.