Skip to content

Don’t add an implicit leading newline in CodeBlockItemList result builder if previous element already has a trailing newline #2858

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions Sources/SwiftSyntaxBuilder/ResultBuilderExtensions.swift
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,15 @@ extension CodeBlockItemListBuilder {
}

public static func buildFinalResult(_ component: Component) -> CodeBlockItemListSyntax {
.init(
component.enumerated().map { (index, expression) in
if index > component.startIndex, !expression.leadingTrivia.contains(where: \.isNewline) {
// Treat the first element as being on a new line. It doesn't need a leading newline
var previousEndedInNewline = true

return CodeBlockItemListSyntax(
component.map { expression in
defer {
previousEndedInNewline = expression.trailingTrivia.pieces.last?.isNewline ?? false
}
if !previousEndedInNewline, !expression.leadingTrivia.contains(where: \.isNewline) {
return expression.with(\.leadingTrivia, .newline.merging(expression.leadingTrivia))
} else {
return expression
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ public func failStringsEqualWithDiff(

// Use `CollectionDifference` on supported platforms to get `diff`-like line-based output. On
// older platforms, fall back to simple string comparison.
let actualLines = actual.split(separator: "\n")
let expectedLines = expected.split(separator: "\n")
let actualLines = actual.split(separator: "\n", omittingEmptySubsequences: false)
let expectedLines = expected.split(separator: "\n", omittingEmptySubsequences: false)

let difference = actualLines.difference(from: expectedLines)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import SwiftSyntaxBuilder
import XCTest

final class CollectionNodeFlatteningTests: XCTestCase {
func test_FlattenCodeBlockItemListWithBuilder() {
func testFlattenCodeBlockItemListWithBuilder() {
@CodeBlockItemListBuilder
func buildInnerCodeBlockItemList() -> CodeBlockItemListSyntax {
[ExprSyntax("innerBuilder1"), ExprSyntax("innerBuilder2")].lazy.map {
Expand Down Expand Up @@ -47,7 +47,7 @@ final class CollectionNodeFlatteningTests: XCTestCase {
)
}

func test_FlattenCodeBlockItemListWithCodeBlockItemStrings() {
func testFlattenCodeBlockItemListWithCodeBlockItemStrings() {
let buildable = CodeBlockItemListSyntax {
"let one = object.methodOne()"
"let two = object.methodTwo()"
Expand All @@ -62,7 +62,7 @@ final class CollectionNodeFlatteningTests: XCTestCase {
)
}

func test_FlattenCodeBlockItemListWithCodeBlockItemStringArray() {
func testFlattenCodeBlockItemListWithCodeBlockItemStringArray() {
let buildable = CodeBlockItemListSyntax {
["let one = object.methodOne()", "let two = object.methodTwo()"]
}
Expand All @@ -76,7 +76,7 @@ final class CollectionNodeFlatteningTests: XCTestCase {
)
}

func test_FlattenCodeBlockItemListWithCodeBlockInterpolated() {
func testFlattenCodeBlockItemListWithCodeBlockInterpolated() {
let block = CodeBlockItemListSyntax {
"let a = 1"
"let b = 2"
Expand All @@ -102,4 +102,21 @@ final class CollectionNodeFlatteningTests: XCTestCase {
"""
)
}

func testFlattenCodeBlockItemListWithTrailingNewline() {
let buildable = CodeBlockItemListSyntax {
DeclSyntax("let a = 1").with(\.trailingTrivia, .newline)
DeclSyntax("let b = 2").with(\.trailingTrivia, .newline)
}

assertBuildResult(
buildable,
"""
let a = 1
let b = 2

"""
)
}

}