Don't move a comment between a modifier and return type. #1588
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
When formatting a function, method, getter, or function type, the formatter hoists any leading comments out so that they don't force a split between the return type and body. However, it failed to take into account modifiers that may occur before the return type but after the comment. If that happened, the comment would get moved before the modifiers. Fix #1585.
kallentu
approved these changes
Oct 24, 2024
natebosch
approved these changes
Oct 24, 2024
| @@ -626,8 +627,9 @@ mixin PieceFactory { | |||
| // @meta | |||
| // // Weird place for comment. | |||
| // int f() {} | |||
| var leadingComments = | |||
| pieces.takeCommentsBefore(returnType.firstNonCommentToken); | |||
| var firstToken = modifiers.firstWhereOrNull((token) => token != null) ?? | |||
There was a problem hiding this comment.
[optional] You could use a non-null filter instead of writing it as a callback.
Suggested change
| var firstToken = modifiers.firstWhereOrNull((token) => token != null) ?? | |
| var firstToken = modifiers.nonNulls.firstOrNull ?? |
There was a problem hiding this comment.
Well crap. I landed this before I saw your suggestion. Today I learned about nonNulls.
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.
When formatting a function, method, getter, or function type, the formatter hoists any leading comments out so that they don't force a split between the return type and body.
However, it failed to take into account modifiers that may occur before the return type but after the comment. If that happened, the comment would get moved before the modifiers.
Fix #1585.