Merge pull request #3110 from swiftlang/jepa

Enable some nice-to-have code formatting rules

Author: AnthonyLatsis

.swift-format

@@ -13,6 +13,8 @@
         "NoBlockComments": false,
         "OrderedImports": true,
         "UseLetInEveryBoundCaseVariable": false,
-        "UseSynthesizedInitializer": false
+        "UseSynthesizedInitializer": false,
+        "ReturnVoidInsteadOfEmptyTuple": true,
+        "NoVoidReturnOnFunctionSignature": true,
     }
 }

Examples/Sources/MacroExamples/Implementation/Peer/AddAsyncMacro.swift

@@ -42,7 +42,9 @@ public struct AddAsyncMacro: PeerMacro {
     }
 
     // This only makes sense void functions
-    if funcDecl.signature.returnClause?.type.as(IdentifierTypeSyntax.self)?.name.text != "Void" {
+    if let returnClause = funcDecl.signature.returnClause,
+      returnClause.type.as(IdentifierTypeSyntax.self)?.name.text != "Void"
+    {
       throw CustomError.message(
         "@addAsync requires an function that returns void"
       )

Examples/Sources/MacroExamples/Playground/PeerMacrosPlayground.swift

@@ -17,12 +17,12 @@ func runPeerMacrosPlayground() {
 
   struct MyStruct {
     @AddAsync
-    func c(a: Int, for b: String, _ value: Double, completionBlock: @escaping (Result<String, Error>) -> Void) -> Void {
+    func c(a: Int, for b: String, _ value: Double, completionBlock: @escaping (Result<String, Error>) -> Void) {
       completionBlock(.success("a: \(a), b: \(b), value: \(value)"))
     }
 
     @AddAsync
-    func d(a: Int, for b: String, _ value: Double, completionBlock: @escaping (Bool) -> Void) -> Void {
+    func d(a: Int, for b: String, _ value: Double, completionBlock: @escaping (Bool) -> Void) {
       completionBlock(true)
     }
   }

Examples/Tests/MacroExamples/Implementation/Peer/AddAsyncMacroTests.swift

@@ -79,6 +79,32 @@ final class AddAsyncMacroTests: XCTestCase {
     )
   }
 
+  func testImplicitVoidResult() {
+    assertMacroExpansion(
+      """
+      @AddAsync
+      func d(a: Int, completionBlock: @escaping (Bool) -> Void) {
+      }
+      """,
+      expandedSource: """
+        func d(a: Int, completionBlock: @escaping (Bool) -> Void) {
+        }
+
+        func d(a: Int) async -> Bool {
+          await withCheckedContinuation { continuation in
+            d(a: a) { returnValue in
+
+              continuation.resume(returning: returnValue)
+            }
+          }
+
+        }
+        """,
+      macros: macros,
+      indentationWidth: .spaces(2)
+    )
+  }
+
   func testExpansionOnStoredPropertyEmitsError() {
     assertMacroExpansion(
       """
@@ -105,18 +131,18 @@ final class AddAsyncMacroTests: XCTestCase {
     )
   }
 
-  func testExpansionOnAsyncFunctionEmitsError() {
+  func testNonVoidResult() {
     assertMacroExpansion(
       """
       struct Test {
         @AddAsync
-        async func sayHello() {
+        func sayHello() -> Int {
         }
       }
       """,
       expandedSource: """
         struct Test {
-          async func sayHello() {
+          func sayHello() -> Int {
           }
         }
         """,
@@ -132,4 +158,50 @@ final class AddAsyncMacroTests: XCTestCase {
       indentationWidth: .spaces(2)
     )
   }
+
+  func testAlreadyAsync() {
+    assertMacroExpansion(
+      """
+      @AddAsync
+      func d(a: Int, completionBlock: @escaping (Bool) -> Void) async {
+      }
+      """,
+      expandedSource: """
+        func d(a: Int, completionBlock: @escaping (Bool) -> Void) async {
+        }
+        """,
+      diagnostics: [
+        DiagnosticSpec(
+          message: "@addAsync requires an non async function",
+          line: 1,
+          column: 1,
+          severity: .error
+        )
+      ],
+      macros: macros,
+      indentationWidth: .spaces(2)
+    )
+  }
+
+  func testNoCompletionHandler() {
+    assertMacroExpansion(
+      """
+      @AddAsync
+      func sayHello(x: Int) {}
+      """,
+      expandedSource: """
+        func sayHello(x: Int) {}
+        """,
+      diagnostics: [
+        DiagnosticSpec(
+          message: "@addAsync requires an function that has a completion handler as last parameter",
+          line: 1,
+          column: 1,
+          severity: .error
+        )
+      ],
+      macros: macros,
+      indentationWidth: .spaces(2)
+    )
+  }
 }

Sources/SwiftParser/IncrementalParseTransition.swift

@@ -47,7 +47,7 @@ extension Parser {
 ///
 /// This is also used for testing purposes to ensure incremental reparsing
 /// worked as expected.
-public typealias ReusedNodeCallback = (_ node: Syntax) -> ()
+public typealias ReusedNodeCallback = (_ node: Syntax) -> Void
 
 /// Keeps track of a previously parsed syntax tree and the source edits that
 /// occurred since it was created.

Sources/SwiftSyntax/SourceLocation.swift

@@ -701,7 +701,7 @@ fileprivate extension SyntaxText {
   /// - Returns: The position at the end of the walk.
   func forEachEndOfLine(
     position: AbsolutePosition,
-    body: (AbsolutePosition) -> ()
+    body: (AbsolutePosition) -> Void
   ) -> AbsolutePosition {
     guard let startPtr = buffer.baseAddress else {
       return position
@@ -745,7 +745,7 @@ fileprivate extension RawTriviaPiece {
   /// - Returns: The position at the end of the walk.
   func forEachEndOfLine(
     position: AbsolutePosition,
-    body: (AbsolutePosition) -> ()
+    body: (AbsolutePosition) -> Void
   ) -> AbsolutePosition {
     var position = position
     switch self {
@@ -788,7 +788,7 @@ fileprivate extension RawTriviaPieceBuffer {
   /// - Returns: The position at the end of the walk.
   func forEachEndOfLine(
     position: AbsolutePosition,
-    body: (AbsolutePosition) -> ()
+    body: (AbsolutePosition) -> Void
   ) -> AbsolutePosition {
     var position = position
     for piece in self {
@@ -810,8 +810,8 @@ fileprivate extension RawSyntax {
   /// - Returns: The position at the end of the walk.
   func forEachEndOfLine(
     position: AbsolutePosition,
-    body: (AbsolutePosition) -> (),
-    handleSourceLocationDirective: (_ position: AbsolutePosition, _ rawSyntax: RawSyntax) -> ()
+    body: (AbsolutePosition) -> Void,
+    handleSourceLocationDirective: (_ position: AbsolutePosition, _ rawSyntax: RawSyntax) -> Void
   ) -> AbsolutePosition {
     var position = position
     switch self.rawData.payload {