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,17 @@ 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):
+      return true
+    case (_, .rightBrace) where first?.tokenKind != .leftBrace:  // empty declarations like `struct {}`.
       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/SwiftParserTest/DeclarationTests.swift

@@ -127,8 +127,7 @@ final class DeclarationTests: XCTestCase {
         DiagnosticSpec(message: "expected member block in class", fixIts: ["insert member block"]),
       ],
       fixedSource: """
-        class T where t{
-        }
+        class T where t{}
         """
     )
     assertParse(
@@ -148,8 +147,7 @@ final class DeclarationTests: XCTestCase {
         ),
       ],
       fixedSource: """
-        class B<where g> {
-        }
+        class B<where g> {}
         """
     )
   }
@@ -882,8 +880,7 @@ final class DeclarationTests: XCTestCase {
         ),
       ],
       fixedSource: """
-        struct S {
-        }
+        struct S {}
           / ###line 25 "line-directive.swift"/
         }
         """
@@ -1197,8 +1194,7 @@ final class DeclarationTests: XCTestCase {
         DiagnosticSpec(locationMarker: "2️⃣", message: "expected member block in class", fixIts: ["insert member block"]),
       ],
       fixedSource: """
-        }class C {
-        }
+        }class C {}
         """
     )
     assertParse(
@@ -1208,8 +1204,7 @@ final class DeclarationTests: XCTestCase {
         DiagnosticSpec(locationMarker: "2️⃣", message: "expected member block in enum", fixIts: ["insert member block"]),
       ],
       fixedSource: """
-        }enum C {
-        }
+        }enum C {}
         """
     )
     assertParse(
@@ -1219,8 +1214,7 @@ final class DeclarationTests: XCTestCase {
         DiagnosticSpec(locationMarker: "2️⃣", message: "expected member block in protocol", fixIts: ["insert member block"]),
       ],
       fixedSource: """
-        }protocol C {
-        }
+        }protocol C {}
         """
     )
     assertParse(
@@ -1230,8 +1224,7 @@ final class DeclarationTests: XCTestCase {
         DiagnosticSpec(locationMarker: "2️⃣", message: "expected member block in actor", fixIts: ["insert member block"]),
       ],
       fixedSource: """
-        }actor C {
-        }
+        }actor C {}
         """
     )
     assertParse(
@@ -1241,8 +1234,7 @@ final class DeclarationTests: XCTestCase {
         DiagnosticSpec(locationMarker: "2️⃣", message: "expected member block in struct", fixIts: ["insert member block"]),
       ],
       fixedSource: """
-        }struct C {
-        }
+        }struct C {}
         """
     )
     assertParse(
@@ -1384,8 +1376,7 @@ final class DeclarationTests: XCTestCase {
         ),
       ],
       fixedSource: """
-        struct U<@<#type#> <#identifier#>> {
-        }
+        struct U<@<#type#> <#identifier#>> {}
         """
     )
   }
@@ -1402,8 +1393,7 @@ final class DeclarationTests: XCTestCase {
       ],
       fixedSource: """
         struct Foo {
-          struct Bar {
-        }
+          struct Bar {}
         }
         """
     )
@@ -1892,8 +1882,7 @@ final class DeclarationTests: XCTestCase {
         DiagnosticSpec(locationMarker: "3️⃣", message: "expected member block in protocol", fixIts: ["insert member block"]),
       ],
       fixedSource: """
-        protocol <#identifier#><<#identifier#>>: <#type#> {
-        }
+        protocol <#identifier#><<#identifier#>>: <#type#> {}
         """
     )
   }

Tests/SwiftParserTest/StatementTests.swift

@@ -758,8 +758,7 @@ final class StatementTests: XCTestCase {
         ),
       ],
       fixedSource: """
-        subscript() -> <#type#> {
-        }@self _modify
+        subscript() -> <#type#> {}@self _modify
         """
     )
   }

Tests/SwiftParserTest/translated/ActorTests.swift

@@ -27,8 +27,7 @@ final class ActorTests: XCTestCase {
         )
       ],
       fixedSource: """
-        actor MyActor1 {
-        }
+        actor MyActor1 {}
         """
     )
   }

Tests/SwiftParserTest/translated/GuardTests.swift

@@ -27,8 +27,7 @@ final class GuardTests: XCTestCase {
       ],
       fixedSource: """
         func noConditionNoElse() {
-          guard {} else {
-        }
+          guard {} else {}
         }
         """
     )