Insert white space before trailing closure of a macro expression #544
Conversation
| @@ -1250,6 +1250,10 @@ fileprivate final class TokenStreamCreator: SyntaxVisitor { | |||
| } | |||
|
|
|||
| override func visit(_ node: MacroExpansionExprSyntax) -> SyntaxVisitorContinueKind { | |||
| before( | |||
There was a problem hiding this comment.
Before this, we need to pick up the same logic we're doing here: https://github.com/apple/swift-format/blob/8793d965ecd830bae26d86c6cddca607a3a7fa93/Sources/SwiftFormatPrettyPrint/TokenStreamCreator.swift#L981-L985
And then pass that value into forcesBreakBeforeRightDelimiter below.
There was a problem hiding this comment.
Thank you for the feedback! I have pushed an update addressing the suggestion and adding another test case similar to the corresponding one in FunctionCallTests.swift.
| assertPrettyPrintEqual(input: input, expected: expected, linelength: 40) | ||
| } | ||
|
|
||
| func testKeepWhiteSpaceAfterMacroNameWithGenerics() { |
There was a problem hiding this comment.
Given this test name, should the invocations below have a generic argument list? Or should the function name be changed?
IMO, you could just combine both cases into the same test:
#Preview {}
#Preview<Whatever> {}
and have a test that verifies that they keep the space, and then another test that verifies that if the space isn't there, it gets added.
There was a problem hiding this comment.
My bad, I seem to have mixed up the test methods' names 😅
But you are absolutely right, I agree that those should be merged to one test method each.
In the latest update I moved the tests for inserting the missing white space into #Preview{} and #Predicate<Int>{} to the same method and also expanded it by a third example #Preview("..."){} to show that the white space is also inserted when an argument list is supplied.
I did the same for the examples where the white space is already there and should be kept.
Furthermore, I renamed those methods to better convey their purpose.
| let input = | ||
| """ | ||
| #Preview {} | ||
| #Preview("MyPreview) { |
There was a problem hiding this comment.
Here and throughout below, it looks like you're missing the trailing quote after "MyPreview, so we can't really trust the test results (if they do pass, the parser may be fixing the literal for us automatically)
There was a problem hiding this comment.
Thanks for the thorough attention, I would have totally missed that! Sorry for the inconvenience 🙇
The strings should now properly be closed with the latest update.
If a freestanding macro expression contains a trailing closure keep a, single space before its opening brace or insert one if none exists. Part of #542
…hite_space Insert white space before trailing closure of a macro expression
This small PR fixes a bug causing the space before the trailing closure of a freestanding macro expression to be removed when running
swift-format.For example, the following line of code
would originally be formatted to
In addition to resolving this issue, this PR adds some basic tests to ensure the correct behavior.
For more information and examples see also issue #542.