Merge pull request #1368 from kimdv/kimdv/add-newline-after-endif

Add newline for pund-keywords in `IfConfigDeclSyntax`

Author: kimdv

CodeGeneration/Sources/SyntaxSupport/gyb_generated/DeclNodes.swift

@@ -523,7 +523,8 @@ public let DECL_NODES: [Node] = [
        children: [
          Child(name: "PoundKeyword",
                kind: .token(choices: [.token(tokenKind: "PoundIfToken"), .token(tokenKind: "PoundElseifToken"), .token(tokenKind: "PoundElseToken")]),
-               classification: "BuildConfigId"),
+               classification: "BuildConfigId",
+               requiresLeadingNewline: true),
          Child(name: "Condition",
                kind: .node(kind: "Expr"),
                nameForDiagnostics: "condition",
@@ -553,7 +554,8 @@ public let DECL_NODES: [Node] = [
                kind: .collection(kind: "IfConfigClauseList", collectionElementName: "Clause")),
          Child(name: "PoundEndif",
                kind: .token(choices: [.token(tokenKind: "PoundEndifToken")]),
-               classification: "BuildConfigId")
+               classification: "BuildConfigId",
+               requiresLeadingNewline: true)
        ]),
 
   Node(name: "ImportDecl",

CodeGeneration/Sources/generate-swiftsyntax/templates/basicformat/BasicFormatFile.swift

@@ -119,6 +119,9 @@ let basicFormatFile = SourceFileSyntax(leadingTrivia: generateCopyrightHeader(fo
       /// - Parameter node: the node that is being visited
       /// - Returns: returns true if newline should be omitted
       open func shouldOmitNewline(_ node: TokenSyntax) -> Bool {
+        if node.previousToken(viewMode: .sourceAccurate) == nil {
+          return true
+        }
         var ancestor: Syntax = Syntax(node)
         while let parent = ancestor.parent {
           ancestor = parent

Sources/SwiftBasicFormat/generated/BasicFormat.swift

@@ -77,6 +77,9 @@ open class BasicFormat: SyntaxRewriter {
   /// - Parameter node: the node that is being visited
   /// - Returns: returns true if newline should be omitted
   open func shouldOmitNewline(_ node: TokenSyntax) -> Bool {
+    if node.previousToken(viewMode: .sourceAccurate) == nil {
+      return true
+    }
     var ancestor: Syntax = Syntax(node)
     while let parent = ancestor.parent {
       ancestor = parent
@@ -129,6 +132,10 @@ open class BasicFormat: SyntaxRewriter {
       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:

Tests/SwiftSyntaxBuilderTest/IfConfigDeclSyntaxTests.swift

@@ -0,0 +1,69 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import XCTest
+import SwiftSyntax
+import SwiftSyntaxBuilder
+
+final class IfConfigDeclSyntaxTests: XCTestCase {
+  func testIfConfigClauseSyntax() {
+    let buildable = IfConfigDeclSyntax(
+      clauses: IfConfigClauseListSyntax {
+        IfConfigClauseSyntax(
+          poundKeyword: .poundIfKeyword(),
+          condition: ExprSyntax("DEBUG"),
+          elements: .statements(
+            CodeBlockItemListSyntax {
+              DeclSyntax(
+                """
+                public func debug(_ data: Foo) -> String {
+                  return data.debugDescription
+                }
+                """
+              )
+            }
+          )
+        )
+        IfConfigClauseSyntax(
+          poundKeyword: .poundElseKeyword(leadingTrivia: .newline),
+          elements: .statements(
+            CodeBlockItemListSyntax {
+              DeclSyntax(
+                """
+                public func debug(_ data: Foo) -> String {
+                  return data.description
+                }
+                """
+              )
+            }
+          )
+        )
+      },
+      poundEndif: .poundEndifKeyword(leadingTrivia: .newline)
+    )
+
+    AssertBuildResult(
+      buildable,
+      """
+      #if DEBUG
+      public func debug(_ data: Foo) -> String {
+          return data.debugDescription
+      }
+      #else
+      public func debug(_ data: Foo) -> String {
+          return data.description
+      }
+      #endif
+      """
+    )
+  }
+}

gyb_syntax_support/DeclNodes.py

@@ -94,7 +94,7 @@
                        'PoundIfToken',
                        'PoundElseifToken',
                        'PoundElseToken',
-                   ]),
+                   ], requires_leading_newline=True),
              Child('Condition', kind='Expr', name_for_diagnostics='condition', classification='BuildConfigId',
                    is_optional=True),
              Child('Elements', is_optional=True, kind='Syntax',
@@ -118,7 +118,7 @@
              Child('Clauses', kind='IfConfigClauseList',
                    collection_element_name='Clause'),
              Child('PoundEndif', kind='PoundEndifToken',
-                   classification='BuildConfigId'),
+                   classification='BuildConfigId', requires_leading_newline=True),
          ]),
 
     Node('PoundSourceLocation', name_for_diagnostics="'#sourceLocation' directive",