Merge pull request #1511 from kimdv/kimdv/add-spacing-between-attributes

Add test cases for spaces between attributes

Author: kimdv

CodeGeneration/Sources/SyntaxSupport/CommonNodes.swift

@@ -16,8 +16,7 @@ public let COMMON_NODES: [Node] = [
     name: "CodeBlockItemList",
     nameForDiagnostics: nil,
     kind: "SyntaxCollection",
-    element: "CodeBlockItem",
-    elementsSeparatedByNewline: true
+    element: "CodeBlockItem"
   ),
 
   // code-block-item = (decl | stmt | expr) ';'?

CodeGeneration/Sources/SyntaxSupport/DeclNodes.swift

@@ -111,8 +111,7 @@ public let DECL_NODES: [Node] = [
     name: "AccessorList",
     nameForDiagnostics: nil,
     kind: "SyntaxCollection",
-    element: "AccessorDecl",
-    elementsSeparatedByNewline: true
+    element: "AccessorDecl"
   ),
 
   // (value)
@@ -1296,8 +1295,7 @@ public let DECL_NODES: [Node] = [
     name: "MemberDeclList",
     nameForDiagnostics: nil,
     kind: "SyntaxCollection",
-    element: "MemberDeclListItem",
-    elementsSeparatedByNewline: true
+    element: "MemberDeclListItem"
   ),
 
   // declaration-modifier -> access-level-modifier

CodeGeneration/Sources/SyntaxSupport/ExprNodes.swift

@@ -1481,8 +1481,7 @@ public let EXPR_NODES: [Node] = [
     kind: "SyntaxCollection",
     element: "Syntax",
     elementName: "SwitchCase",
-    elementChoices: ["SwitchCase", "IfConfigDecl"],
-    elementsSeparatedByNewline: true
+    elementChoices: ["SwitchCase", "IfConfigDecl"]
   ),
 
   // switch-case -> unknown-attr? switch-case-label stmt-list

CodeGeneration/Sources/SyntaxSupport/Node.swift

@@ -30,7 +30,6 @@ public class Node {
   public let collectionElementName: String?
   public let collectionElementChoices: [String]?
   public let omitWhenEmpty: Bool
-  public let elementsSeparatedByNewline: Bool
   public let collectionElement: String
 
   /// Returns `true` if this node declares one of the base syntax kinds.
@@ -98,8 +97,7 @@ public class Node {
     element: String = "",
     elementName: String? = nil,
     elementChoices: [String]? = nil,
-    omitWhenEmpty: Bool = false,
-    elementsSeparatedByNewline: Bool = false
+    omitWhenEmpty: Bool = false
   ) {
     self.syntaxKind = name
     self.swiftSyntaxKind = lowercaseFirstWord(name: name)
@@ -159,7 +157,6 @@ public class Node {
     // from its supertype, use that.
     self.collectionElementName = elementName ?? self.collectionElement
     self.collectionElementChoices = elementChoices ?? []
-    self.elementsSeparatedByNewline = elementsSeparatedByNewline
 
     // For SyntaxCollections make sure that the elementName is set.
     precondition(!isSyntaxCollection || elementName != nil || element != "")

Tests/SwiftSyntaxBuilderTest/AttributeListSyntaxTests.swift

@@ -0,0 +1,30 @@
+//===----------------------------------------------------------------------===//
+//
+// 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 AttributeListSyntaxTests: XCTestCase {
+  func testAttributeListSyntaxSpacing() {
+    let buildable = AttributeListSyntax {
+      AttributeSyntax("@inlinable")
+      AttributeSyntax("@discardableResult")
+    }
+    assertBuildResult(
+      buildable,
+      """
+      @inlinable @discardableResult
+      """
+    )
+  }
+}

Tests/SwiftSyntaxBuilderTest/ClosureExprTests.swift

@@ -34,4 +34,46 @@ final class ClosureExprTests: XCTestCase {
       """
     )
   }
+  func testClosureExprWithAsync() {
+    let buildable = ClosureExprSyntax(
+      signature: ClosureSignatureSyntax(
+        input: .simpleInput(
+          ClosureParamListSyntax {
+            ClosureParamSyntax(name: .identifier("area"))
+          }
+        ),
+        effectSpecifiers: TypeEffectSpecifiersSyntax(
+          asyncSpecifier: .keyword(.async),
+          throwsSpecifier: .keyword(.throws)
+        )
+      )
+    ) {}
+
+    assertBuildResult(
+      buildable,
+      """
+      {area async throws in
+      }
+      """
+    )
+  }
+
+  func testMultiTrailingClosure() {
+    let buildable = ExprSyntax(
+      """
+      foo { _ in
+      }anotherClosure: { _ in
+      }
+      """
+    )
+
+    assertBuildResult(
+      buildable,
+      """
+      foo { _ in
+      } anotherClosure: { _ in
+      }
+      """
+    )
+  }
 }

Tests/SwiftSyntaxBuilderTest/FunctionSignatureSyntaxTests.swift

@@ -0,0 +1,29 @@
+//===----------------------------------------------------------------------===//
+//
+// 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 FunctionSignatureSyntaxTests: XCTestCase {
+  func testFunctionEffectSpecifiersSyntax() throws {
+    let functionEffects = FunctionEffectSpecifiersSyntax(asyncSpecifier: .keyword(.async), throwsSpecifier: .keyword(.rethrows))
+    let buildable = FunctionSignatureSyntax(input: .init(parameterList: []), effectSpecifiers: functionEffects, output: .init(returnType: TypeSyntax("String")))
+
+    assertBuildResult(
+      buildable,
+      """
+      () async rethrows -> String
+      """
+    )
+  }
+}

Tests/SwiftSyntaxBuilderTest/FunctionTests.swift

@@ -163,6 +163,47 @@ final class FunctionTests: XCTestCase {
         }
         """
       ),
+      #line: (
+        DeclSyntax(
+          """
+          @discardableResult
+          public func foo() -> String {
+            return "foo"
+          }
+          """
+        ),
+        """
+        @discardableResult
+        public func foo() -> String {
+          return "foo"
+        }
+        """
+      ),
+      #line: (
+        DeclSyntax(
+          FunctionDeclSyntax(
+            attributes: [.attribute(AttributeSyntax("@inline(__always)")), .attribute(AttributeSyntax("@discardableResult"))],
+            modifiers: [DeclModifierSyntax(name: .keyword(.public))],
+            identifier: TokenSyntax.identifier("foo"),
+            signature: FunctionSignatureSyntax(
+              input: ParameterClauseSyntax(
+                parameterList: FunctionParameterListSyntax {}
+              ),
+              output: ReturnClauseSyntax(
+                returnType: SimpleTypeIdentifierSyntax(name: .identifier("String"))
+              )
+            ),
+            bodyBuilder: {
+              StmtSyntax(#"return "foo""#)
+            }
+          )
+        ),
+        """
+        @inline(__always) @discardableResult public func foo() -> String {
+            return "foo"
+        }
+        """
+      ),
       #line: (
         DeclSyntax(
           FunctionDeclSyntax(

Tests/SwiftSyntaxBuilderTest/FunctionTypeSyntaxTests.swift

@@ -0,0 +1,29 @@
+//===----------------------------------------------------------------------===//
+//
+// 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 FunctionTypeSyntaxTests: XCTestCase {
+  func testFunctionEffectSpecifiersSyntax() throws {
+    let typeEffects = TypeEffectSpecifiersSyntax(asyncSpecifier: .keyword(.async), throwsSpecifier: .keyword(.throws))
+    let buildable = FunctionTypeSyntax(arguments: [], effectSpecifiers: typeEffects, output: .init(returnType: TypeSyntax("String")))
+
+    assertBuildResult(
+      buildable,
+      """
+      () async throws -> String
+      """
+    )
+  }
+}

Tests/SwiftSyntaxBuilderTest/ImportTests.swift renamed to Tests/SwiftSyntaxBuilderTest/ImportDeclSyntaxTests.swift

@@ -14,16 +14,28 @@ import XCTest
 import SwiftSyntax
 import SwiftSyntaxBuilder
 
-final class ImportTests: XCTestCase {
-  func testImport() {
-    let leadingTrivia = Trivia.unexpectedText("␣")
+final class ImportDeclSyntaxTests: XCTestCase {
+  func testImportDeclSyntax() {
     let identifier = TokenSyntax.identifier("SwiftSyntax")
 
     let importDecl = ImportDeclSyntax(
-      leadingTrivia: leadingTrivia,
       path: AccessPathSyntax([AccessPathComponentSyntax(name: identifier)])
     )
 
-    assertBuildResult(importDecl, "␣import SwiftSyntax")
+    assertBuildResult(importDecl, "import SwiftSyntax")
+  }
+
+  func testImportWithAttribute() {
+    let buildable = ImportDeclSyntax(
+      attributes: [.attribute("@_exported")],
+      path: [AccessPathComponentSyntax(name: "SwiftSyntax")]
+    )
+
+    assertBuildResult(
+      buildable,
+      """
+      @_exported import SwiftSyntax
+      """
+    )
   }
 }

Tests/SwiftSyntaxBuilderTest/VariableTests.swift

@@ -293,6 +293,28 @@ final class VariableTests: XCTestCase {
     )
   }
 
+  func testAccessorWithEffectSpecifier() throws {
+    let buildable = try VariableDeclSyntax("var test: Int") {
+      AccessorDeclSyntax(
+        accessorKind: .keyword(.get),
+        effectSpecifiers: AccessorEffectSpecifiersSyntax(
+          asyncSpecifier: .keyword(.async),
+          throwsSpecifier: .keyword(.throws)
+        )
+      ) {}
+    }
+
+    assertBuildResult(
+      buildable,
+      """
+      var test: Int {
+          get async throws {
+          }
+      }
+      """
+    )
+  }
+
   func testAttributedVariables() throws {
     let testCases: [UInt: (VariableDeclSyntax, String)] = try [
       #line: (