Fix bugs in the organizeDeclarations rule and remove rewritesEntireFile flag #703
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
calda
commented
Aug 19, 2020
| // The `name` property on individual rules is not populated until the first call into `rulesByName`, | ||
| // so we have to make sure to trigger this before checking the names of the given rules. | ||
| if rules.contains(where: { $0.name.isEmpty }) { | ||
| _ = FormatRules.all |
There was a problem hiding this comment.
All of the organizeDeclaration tests were mysteriously failing when ran individually, but succeeding when ran as a part of the entire unit test suite.
It turns out the rules.first?.name == "organizeDeclarations" check below was failing because the name fields hadn't been populated yet. I think this may be a recent change / regression (I wasn't observing this behavior on my work branch last weekend).
|
Awesome, thanks 👍 |
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.
This PR fixes some issues with the
parseDeclarationsmethod (added in #701), which was causing bugs in theorganizeDeclarationsrule.When
parseDeclarationsfinds astartOfScopetoken, it skips to the correspondingendOfScope.startOfScope("//")token but no correspondingendOfScopetoken, so this was inadvertently skipping to the end of the scope.parseDeclarationsto accidentally chunk all of the code after a// MARK:comment into the same declaration.When
parseDeclarationfinds anendOfScopetoken, it was always skipping to the correspondingstartOfScope.parseDeclarationsto accidentally include multiple declarations in a singleDeclarationobject.This PR also updates
organizeDeclarationsto only mutate theformatterwhen it actually needs to make changes. This change, combined with the other fixes, means we no longer need therewritesEntireFileflag!