Remove requiresLeadingNewline from basic format

Author: kimdv

CodeGeneration/Sources/SyntaxSupport/Child.swift

@@ -62,7 +62,6 @@ public class Child {
   public let description: String?
   public let forceClassification: Bool
   public let isIndented: Bool
-  public let requiresLeadingNewline: Bool
   public let isOptional: Bool
   public let classification: SyntaxClassification?
 
@@ -158,8 +157,7 @@ public class Child {
     isOptional: Bool = false,
     classification: String? = nil,
     forceClassification: Bool = false,
-    isIndented: Bool = false,
-    requiresLeadingNewline: Bool = false
+    isIndented: Bool = false
   ) {
     if let firstCharInName = name.first {
       precondition(firstCharInName.isUppercase == true, "The first letter of a child’s name should be uppercase")
@@ -171,7 +169,6 @@ public class Child {
     self.classification = classificationByName(classification)
     self.forceClassification = forceClassification
     self.isIndented = isIndented
-    self.requiresLeadingNewline = requiresLeadingNewline
     self.isOptional = isOptional
   }
 }

CodeGeneration/Sources/SyntaxSupport/CommonNodes.swift

@@ -77,8 +77,7 @@ public let COMMON_NODES: [Node] = [
       ),
       Child(
         name: "RightBrace",
-        kind: .token(choices: [.token(tokenKind: "RightBraceToken")]),
-        requiresLeadingNewline: true
+        kind: .token(choices: [.token(tokenKind: "RightBraceToken")])
       ),
     ]
   ),

CodeGeneration/Sources/SyntaxSupport/DeclNodes.swift

@@ -55,8 +55,7 @@ public let DECL_NODES: [Node] = [
       ),
       Child(
         name: "RightBrace",
-        kind: .token(choices: [.token(tokenKind: "RightBraceToken")]),
-        requiresLeadingNewline: true
+        kind: .token(choices: [.token(tokenKind: "RightBraceToken")])
       ),
     ]
   ),
@@ -1001,8 +1000,7 @@ public let DECL_NODES: [Node] = [
       Child(
         name: "PoundKeyword",
         kind: .token(choices: [.token(tokenKind: "PoundIfToken"), .token(tokenKind: "PoundElseifToken"), .token(tokenKind: "PoundElseToken")]),
-        classification: "BuildConfigId",
-        requiresLeadingNewline: true
+        classification: "BuildConfigId"
       ),
       Child(
         name: "Condition",
@@ -1054,8 +1052,7 @@ public let DECL_NODES: [Node] = [
       Child(
         name: "PoundEndif",
         kind: .token(choices: [.token(tokenKind: "PoundEndifToken")]),
-        classification: "BuildConfigId",
-        requiresLeadingNewline: true
+        classification: "BuildConfigId"
       ),
     ]
   ),
@@ -1366,8 +1363,7 @@ public let DECL_NODES: [Node] = [
       ),
       Child(
         name: "RightBrace",
-        kind: .token(choices: [.token(tokenKind: "RightBraceToken")]),
-        requiresLeadingNewline: true
+        kind: .token(choices: [.token(tokenKind: "RightBraceToken")])
       ),
     ]
   ),

CodeGeneration/Sources/SyntaxSupport/ExprNodes.swift

@@ -477,8 +477,7 @@ public let EXPR_NODES: [Node] = [
       ),
       Child(
         name: "RightBrace",
-        kind: .token(choices: [.token(tokenKind: "RightBraceToken")]),
-        requiresLeadingNewline: true
+        kind: .token(choices: [.token(tokenKind: "RightBraceToken")])
       ),
     ]
   ),
@@ -1654,8 +1653,7 @@ public let EXPR_NODES: [Node] = [
       ),
       Child(
         name: "RightBrace",
-        kind: .token(choices: [.token(tokenKind: "RightBraceToken")]),
-        requiresLeadingNewline: true
+        kind: .token(choices: [.token(tokenKind: "RightBraceToken")])
       ),
     ]
   ),

CodeGeneration/Sources/generate-swiftsyntax/templates/swiftbasicformat/BasicFormatExtensionsFile.swift

@@ -65,19 +65,6 @@ let basicFormatExtensionsFile = SourceFileSyntax(leadingTrivia: copyrightHeader)
     )
   }
 
-  try! ExtensionDeclSyntax("public extension TokenSyntax") {
-    DeclSyntax(
-      """
-      var requiresLeadingNewline: Bool {
-        if let keyPath = keyPathInParent, keyPath.requiresLeadingNewline {
-          return true
-        }
-        return false
-      }
-      """
-    )
-  }
-
   try! ExtensionDeclSyntax("fileprivate extension AnyKeyPath") {
     try VariableDeclSyntax("var requiresIndent: Bool") {
       try SwitchExprSyntax("switch self") {
@@ -94,21 +81,6 @@ let basicFormatExtensionsFile = SourceFileSyntax(leadingTrivia: copyrightHeader)
       }
     }
 
-    try VariableDeclSyntax("var requiresLeadingNewline: Bool") {
-      try SwitchExprSyntax("switch self") {
-        for node in SYNTAX_NODES where !node.isBase {
-          for child in node.children where child.requiresLeadingNewline {
-            SwitchCaseSyntax("case \\\(raw: node.type.syntaxBaseName).\(raw: child.swiftName):") {
-              StmtSyntax("return true")
-            }
-          }
-        }
-        SwitchCaseSyntax("default:") {
-          StmtSyntax("return false")
-        }
-      }
-    }
-
     try VariableDeclSyntax("var requiresLeadingSpace: Bool?") {
       try SwitchExprSyntax("switch self") {
         for node in SYNTAX_NODES where !node.isBase {

Sources/SwiftBasicFormat/BasicFormat.swift

@@ -155,10 +155,6 @@ open class BasicFormat: SyntaxRewriter {
     {
       return false
     } else if let second {
-      if second.requiresLeadingNewline {
-        return true
-      }
-
       var ancestor: Syntax = Syntax(second)
       while let parent = ancestor.parent {
         ancestor = parent
@@ -178,11 +174,16 @@ open class BasicFormat: SyntaxRewriter {
     }
 
     switch (first?.tokenKind, second?.tokenKind) {
+
     case (.multilineStringQuote, .backslash),  // string interpolation segment inside a multi-line string literal
       (.multilineStringQuote, .multilineStringQuote),  // empty multi-line string literal
       (.multilineStringQuote, .stringSegment),  // segment starting a multi-line string literal
       (.stringSegment, .multilineStringQuote),  // ending a multi-line string literal that has a string interpolation segment at its end
-      (.rightParen, .multilineStringQuote):  // ending a multi-line string literal that has a string interpolation segment at its end
+      (.rightParen, .multilineStringQuote),  // ending a multi-line string literal that has a string interpolation segment at its end
+      (_, .poundElseKeyword),
+      (_, .poundElseifKeyword),
+      (_, .poundEndifKeyword),
+      (_, .rightBrace):
       return true
     default:
       return false

Sources/SwiftBasicFormat/generated/BasicFormat+Extensions.swift

@@ -23,15 +23,6 @@ public extension SyntaxProtocol {
   }
 }
 
-public extension TokenSyntax {
-  var requiresLeadingNewline: Bool {
-    if let keyPath = keyPathInParent, keyPath.requiresLeadingNewline {
-      return true
-    }
-    return false
-  }
-}
-
 fileprivate extension AnyKeyPath {
   var requiresIndent: Bool {
     switch self {
@@ -70,27 +61,6 @@ fileprivate extension AnyKeyPath {
     }
   }
 
-  var requiresLeadingNewline: Bool {
-    switch self {
-    case \AccessorBlockSyntax.rightBrace:
-      return true
-    case \ClosureExprSyntax.rightBrace:
-      return true
-    case \CodeBlockSyntax.rightBrace:
-      return true
-    case \IfConfigClauseSyntax.poundKeyword:
-      return true
-    case \IfConfigDeclSyntax.poundEndif:
-      return true
-    case \MemberDeclBlockSyntax.rightBrace:
-      return true
-    case \SwitchExprSyntax.rightBrace:
-      return true
-    default:
-      return false
-    }
-  }
-  
   var requiresLeadingSpace: Bool? {
     switch self {
     case \AvailabilityArgumentSyntax.entry:

Tests/SwiftSyntaxBuilderTest/IfConfigDeclSyntaxTests.swift

@@ -34,7 +34,22 @@ final class IfConfigDeclSyntaxTests: XCTestCase {
           )
         )
         IfConfigClauseSyntax(
-          poundKeyword: .poundElseKeyword(leadingTrivia: .newline),
+          poundKeyword: .poundElseifKeyword(),
+          condition: ExprSyntax("TEST"),
+          elements: .statements(
+            CodeBlockItemListSyntax {
+              DeclSyntax(
+                """
+                public func debug(_ data: Foo) -> String {
+                  return data.description
+                }
+                """
+              )
+            }
+          )
+        )
+        IfConfigClauseSyntax(
+          poundKeyword: .poundElseKeyword(),
           elements: .statements(
             CodeBlockItemListSyntax {
               DeclSyntax(
@@ -48,7 +63,7 @@ final class IfConfigDeclSyntaxTests: XCTestCase {
           )
         )
       },
-      poundEndif: .poundEndifKeyword(leadingTrivia: .newline)
+      poundEndif: .poundEndifKeyword()
     )
 
     assertBuildResult(
@@ -58,6 +73,10 @@ final class IfConfigDeclSyntaxTests: XCTestCase {
       public func debug(_ data: Foo) -> String {
         return data.debugDescription
       }
+      #elseif TEST
+      public func debug(_ data: Foo) -> String {
+        return data.description
+      }
       #else
       public func debug(_ data: Foo) -> String {
         return data.description

Tests/SwiftSyntaxBuilderTest/StringLiteralExprSyntaxTests.swift

@@ -168,9 +168,9 @@ final class StringLiteralExprSyntaxTests: XCTestCase {
     // Tab should not be escaped in single-line string literals
     assertBuildResult(
       StringLiteralExprSyntax(
-        openQuote: .multilineStringQuoteToken(trailingTrivia: .newline),
+        openQuote: .multilineStringQuoteToken(),
         content: "a\tb",
-        closeQuote: .multilineStringQuoteToken(leadingTrivia: .newline)
+        closeQuote: .multilineStringQuoteToken()
       ),
       #"""
       """
@@ -225,7 +225,7 @@ final class StringLiteralExprSyntaxTests: XCTestCase {
 
   func testMultiLineStringWithResultBuilder() {
     let buildable = StringLiteralExprSyntax(
-      openQuote: .multilineStringQuoteToken(trailingTrivia: .newline),
+      openQuote: .multilineStringQuoteToken(),
       segments: StringLiteralSegmentsSyntax {
         StringSegmentSyntax(content: .stringSegment(#"Error validating child at index \(index) of \(nodeKind):"#), trailingTrivia: .newline)
         StringSegmentSyntax(content: .stringSegment(#"Node did not satisfy any node choice requirement."#), trailingTrivia: .newline)
@@ -236,7 +236,7 @@ final class StringLiteralExprSyntaxTests: XCTestCase {
           }
         )
       },
-      closeQuote: .multilineStringQuoteToken(leadingTrivia: .newline)
+      closeQuote: .multilineStringQuoteToken()
     )
 
     assertBuildResult(