Improve the formatting logic of OmitExplicitReturns rule #935
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
TTOzzi
requested review from
ahoppen,
allevato,
bnbarham and
shawnhyam
as code owners
TTOzzi
commented
Feb 15, 2025
| @@ -60,7 +60,7 @@ public final class OmitExplicitReturns: SyntaxFormatRule { | |||
| guard let accessorBlock = binding.accessorBlock, | |||
| let transformed = transformAccessorBlock(accessorBlock) | |||
| else { | |||
| return node | |||
| return super.visit(node) | |||
There was a problem hiding this comment.
If the condition was not met, the node was returned immediately, preventing the additional visit logic from executing.
By calling super.visit, the visit process continues, allowing the formatting logic in visit(_ node: ClosureExprSyntax) to be applied.
| @@ -145,7 +145,7 @@ public final class OmitExplicitReturns: SyntaxFormatRule { | |||
| CodeBlockItemListSyntax([ | |||
| CodeBlockItemSyntax( | |||
| leadingTrivia: returnStmt.leadingTrivia, | |||
| item: .expr(returnStmt.expression!), | |||
| item: .expr(returnStmt.expression!.detached.with(\.trailingTrivia, [])), | |||
There was a problem hiding this comment.
Since returnStmt.expression and returnStmt had the same trailingTrivia, formatting caused trailingTrivia to appear twice when present.
To fix this, I detached the trailingTrivia of returnStmt.expression when rewrapping with CodeBlockItemSyntax, ensuring it does not get duplicated.
ahoppen
approved these changes
Feb 17, 2025
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.
Resolve #812 and fix an additional minor bug that was discovered.
I will leave the explanation in the comments.