Merge pull request #1148 from stevapple/tuple-indent

Mark function parameters and tuple elements as indented

Author: kimdv

CodeGeneration/Sources/SyntaxSupport/gyb_generated/DeclNodes.swift

@@ -116,7 +116,8 @@ public let DECL_NODES: [Node] = [
                ]),
          Child(name: "ParameterList",
                kind: "FunctionParameterList",
-               collectionElementName: "Parameter"),
+               collectionElementName: "Parameter",
+               isIndented: true),
          Child(name: "RightParen",
                kind: "RightParenToken",
                tokenChoices: [

CodeGeneration/Sources/SyntaxSupport/gyb_generated/ExprNodes.swift

@@ -344,7 +344,8 @@ public let EXPR_NODES: [Node] = [
                ]),
          Child(name: "ElementList",
                kind: "TupleExprElementList",
-               collectionElementName: "Element"),
+               collectionElementName: "Element",
+               isIndented: true),
          Child(name: "RightParen",
                kind: "RightParenToken",
                tokenChoices: [
@@ -829,7 +830,8 @@ public let EXPR_NODES: [Node] = [
                ]),
          Child(name: "ArgumentList",
                kind: "TupleExprElementList",
-               collectionElementName: "Argument"),
+               collectionElementName: "Argument",
+               isIndented: true),
          Child(name: "RightParen",
                kind: "RightParenToken",
                isOptional: true,

CodeGeneration/Sources/SyntaxSupport/gyb_generated/TypeNodes.swift

@@ -300,7 +300,8 @@ public let TYPE_NODES: [Node] = [
                ]),
          Child(name: "Elements",
                kind: "TupleTypeElementList",
-               collectionElementName: "Element"),
+               collectionElementName: "Element",
+               isIndented: true),
          Child(name: "RightParen",
                kind: "RightParenToken",
                tokenChoices: [
@@ -322,7 +323,8 @@ public let TYPE_NODES: [Node] = [
                ]),
          Child(name: "Arguments",
                kind: "TupleTypeElementList",
-               collectionElementName: "Argument"),
+               collectionElementName: "Argument",
+               isIndented: true),
          Child(name: "RightParen",
                kind: "RightParenToken",
                tokenChoices: [

Sources/SwiftBasicFormat/generated/BasicFormat.swift

@@ -76,10 +76,20 @@ open class BasicFormat: SyntaxRewriter {
       return true
     case \CodeBlockSyntax.statements: 
       return true
+    case \FunctionCallExprSyntax.argumentList: 
+      return true
+    case \FunctionTypeSyntax.arguments: 
+      return true
     case \MemberDeclBlockSyntax.members: 
       return true
+    case \ParameterClauseSyntax.parameterList: 
+      return true
     case \SwitchCaseSyntax.statements: 
       return true
+    case \TupleExprSyntax.elementList: 
+      return true
+    case \TupleTypeSyntax.elements: 
+      return true
     default: 
       return false
     }

Tests/SwiftSyntaxBuilderTest/FunctionTests.swift

@@ -42,7 +42,69 @@ final class FunctionTests: XCTestCase {
     }
     AssertBuildResult(buildable, "test(value1, p2: value2, value3, p4: value4, value5)")
   }
-
+  
+  func testFunctionDeclBuilder() {
+    let builder = FunctionDecl("""
+      func test(_ p1: Int, p2: Int, _ p3: Int, p4: Int, _ p5: Int) -> Int {
+          return p1 + p2 + p3 + p4 + p5
+      }
+      """)
+    
+    AssertBuildResult(builder, """
+      func test(_ p1: Int, p2: Int, _ p3: Int, p4: Int, _ p5: Int) -> Int {
+          return p1 + p2 + p3 + p4 + p5
+      }
+      """)
+  }
+  
+  func testMultilineFunctionParameterList() {
+    let builder = FunctionDecl("""
+      func test(
+        _ p1: Int,
+        p2: Int,
+        _ p3: Int,
+        p4: Int,
+        _ p5: Int
+      ) -> Int {
+        return p1 + p2 + p3 + p4 + p5
+      }
+      """)
+    
+    AssertBuildResult(builder, """
+      func test(
+          _ p1: Int,
+          p2: Int,
+          _ p3: Int,
+          p4: Int,
+          _ p5: Int
+      ) -> Int {
+          return p1 + p2 + p3 + p4 + p5
+      }
+      """)
+  }
+  
+  func testMultilineFunctionCallExpr() {
+    let builder = FunctionCallExpr("""
+      test(
+      p1: value1,
+      p2: value2,
+      p3: value3,
+      p4: value4,
+      p5: value5
+      )
+      """)
+    
+    AssertBuildResult(builder, """
+      test(
+          p1: value1,
+          p2: value2,
+          p3: value3,
+          p4: value4,
+          p5: value5
+      )
+      """)
+  }
+  
   func testParensEmittedForNoArgumentsAndNoTrailingClosure() {
     let buildable = FunctionCallExpr(callee: ExprSyntax("test"))
     AssertBuildResult(buildable, "test()")

Tests/SwiftSyntaxBuilderTest/InitializerDeclTests.swift

@@ -46,4 +46,30 @@ final class InitializerDeclTests: XCTestCase {
       }
       """)
   }
+  
+  func testMultilineParameterList() {
+    let builder = InitializerDecl("""
+      init(
+        _ p1: Int,
+        p2: Int,
+        _ p3: Int,
+        p4: Int,
+        _ p5: Int
+      ) {
+        self.init(p1 + p2 + p3 + p4 + p5)
+      }
+      """)
+    
+    AssertBuildResult(builder, """
+      init(
+          _ p1: Int,
+          p2: Int,
+          _ p3: Int,
+          p4: Int,
+          _ p5: Int
+      ) {
+          self.init(p1 + p2 + p3 + p4 + p5)
+      }
+      """)
+  }
 }

Tests/SwiftSyntaxBuilderTest/TupleTests.swift

@@ -0,0 +1,66 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2022 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 TupleTests: XCTestCase {
+  func testLabeledElementList() {
+    let builder = TupleExprSyntax("(p1: value1, p2: value2, p3: value3)")
+    AssertBuildResult(builder, "(p1: value1, p2: value2, p3: value3)")
+  }
+  
+  func testMultilineTupleExpr() {
+    let builder = TupleExprSyntax("""
+      (
+      p1: value1,
+      p2: value2,
+      p3: value3,
+      p4: value4,
+      p5: value5
+      )
+      """)
+    
+    AssertBuildResult(builder, """
+      (
+          p1: value1,
+          p2: value2,
+          p3: value3,
+          p4: value4,
+          p5: value5
+      )
+      """)
+  }
+  
+  func testMultilineTupleType() {
+    let builder = TupleTypeSyntax("""
+      (
+      Int,
+      p2: Int,
+      Int,
+      p4: Int,
+      Int
+      )
+      """)
+    
+    AssertBuildResult(builder, """
+      (
+          Int,
+          p2: Int,
+          Int,
+          p4: Int,
+          Int
+      )
+      """)
+  }
+}

gyb_syntax_support/DeclNodes.py

@@ -61,7 +61,7 @@
          children=[
              Child('LeftParen', kind='LeftParenToken'),
              Child('ParameterList', kind='FunctionParameterList', name_for_diagnostics='parameters',
-                   collection_element_name='Parameter'),
+                   collection_element_name='Parameter', is_indented=True),
              Child('RightParen', kind='RightParenToken'),
          ]),
 

gyb_syntax_support/ExprNodes.py

@@ -206,7 +206,7 @@
          children=[
              Child('LeftParen', kind='LeftParenToken'),
              Child('ElementList', kind='TupleExprElementList',
-                   collection_element_name='Element'),
+                   collection_element_name='Element', is_indented=True),
              Child('RightParen', kind='RightParenToken'),
          ]),
 
@@ -480,7 +480,7 @@
              Child('LeftParen', kind='LeftParenToken',
                    is_optional=True),
              Child('ArgumentList', kind='TupleExprElementList', name_for_diagnostics='arguments',
-                   collection_element_name='Argument'),
+                   collection_element_name='Argument', is_indented=True),
              Child('RightParen', kind='RightParenToken',
                    is_optional=True),
              Child('TrailingClosure', kind='ClosureExpr', name_for_diagnostics='trailing closure',

gyb_syntax_support/TypeNodes.py

@@ -170,7 +170,7 @@
          children=[
              Child('LeftParen', kind='LeftParenToken'),
              Child('Elements', kind='TupleTypeElementList',
-                   collection_element_name='Element'),
+                   collection_element_name='Element', is_indented=True),
              Child('RightParen', kind='RightParenToken'),
          ]),
 
@@ -182,7 +182,7 @@
          children=[
              Child('LeftParen', kind='LeftParenToken'),
              Child('Arguments', kind='TupleTypeElementList',
-                   collection_element_name='Argument'),
+                   collection_element_name='Argument', is_indented=True),
              Child('RightParen', kind='RightParenToken'),
              Child('AsyncKeyword', kind='ContextualKeyworkToken',
                    text_choices=['async'], is_optional=True),