Merge pull request #1323 from kimdv/kimdv/add-custom-format-to-code-gen

Add custom format to code gen for `TupleExprElementListSyntax`, `FunctionParameterListSyntax`, `ArrayElementListSyntax` and `DictionaryElementListSyntax `

Author: kimdv

CodeGeneration/Sources/Utils/CodeGenerationFormat.swift

@@ -17,11 +17,42 @@ import SwiftSyntax
 public class CodeGenerationFormat: BasicFormat {
   public override var indentation: TriviaPiece { .spaces(indentationLevel * 2) }
 
-  public func ensuringTwoLeadingNewlines<NodeType: SyntaxProtocol>(node: NodeType) -> NodeType {
-    if node.leadingTrivia?.first?.isNewline ?? false {
-      return node.with(\.leadingTrivia, indentedNewline + (node.leadingTrivia ?? []))
+  public override func visit(_ node: ArrayElementListSyntax) -> ArrayElementListSyntax {
+    let children = node.children(viewMode: .all)
+    // Short array literals are presented on one line, list each element on a different line.
+    if children.count > 3 {
+      return ArrayElementListSyntax(formatChildrenSeparatedByNewline(children: children, elementType: ArrayElementSyntax.self))
     } else {
-      return node.with(\.leadingTrivia, indentedNewline + indentedNewline + (node.leadingTrivia ?? []))
+      return super.visit(node)
+    }
+  }
+
+  public override func visit(_ node: CodeBlockItemSyntax) -> CodeBlockItemSyntax {
+    if node.parent?.parent?.is(SourceFileSyntax.self) == true, !node.item.is(ImportDeclSyntax.self) {
+      let formatted = super.visit(node)
+      return ensuringTwoLeadingNewlines(node: formatted)
+    } else {
+      return super.visit(node)
+    }
+  }
+
+  public override func visit(_ node: DictionaryElementListSyntax) -> DictionaryElementListSyntax {
+    let children = node.children(viewMode: .all)
+    // Short dictionary literals are presented on one line, list each element on a different line.
+    if children.count > 3 {
+      return DictionaryElementListSyntax(formatChildrenSeparatedByNewline(children: children, elementType: DictionaryElementSyntax.self))
+    } else {
+      return super.visit(node)
+    }
+  }
+
+  public override func visit(_ node: FunctionParameterListSyntax) -> FunctionParameterListSyntax {
+    let children = node.children(viewMode: .all)
+    // Short function parameter literals are presented on one line, list each element on a different line.
+    if children.count > 3 {
+      return FunctionParameterListSyntax(formatChildrenSeparatedByNewline(children: children, elementType: FunctionParameterSyntax.self))
+    } else {
+      return super.visit(node)
     }
   }
 
@@ -34,12 +65,42 @@ public class CodeGenerationFormat: BasicFormat {
     }
   }
 
-  public override func visit(_ node: CodeBlockItemSyntax) -> CodeBlockItemSyntax {
-    if node.parent?.parent?.is(SourceFileSyntax.self) == true, !node.item.is(ImportDeclSyntax.self) {
-      let formatted = super.visit(node)
-      return ensuringTwoLeadingNewlines(node: formatted)
+  public override func visit(_ node: TupleExprElementListSyntax) -> TupleExprElementListSyntax {
+    let children = node.children(viewMode: .all)
+    // Short tuple element list literals are presented on one line, list each element on a different line.
+    if children.count > 3 {
+      return TupleExprElementListSyntax(formatChildrenSeparatedByNewline(children: children, elementType: TupleExprElementSyntax.self))
     } else {
       return super.visit(node)
     }
   }
+
+  // MARK: - Private
+
+  private func ensuringTwoLeadingNewlines<NodeType: SyntaxProtocol>(node: NodeType) -> NodeType {
+    if node.leadingTrivia?.first?.isNewline ?? false {
+      return node.with(\.leadingTrivia, indentedNewline + (node.leadingTrivia ?? []))
+    } else {
+      return node.with(\.leadingTrivia, indentedNewline + indentedNewline + (node.leadingTrivia ?? []))
+    }
+  }
+
+  private func formatChildrenSeparatedByNewline<SyntaxType: SyntaxProtocol>(children: SyntaxChildren, elementType: SyntaxType.Type) -> [SyntaxType] {
+    indentationLevel += 1
+    var formattedChildren = children.map {
+      self.visit($0).as(SyntaxType.self)!
+    }
+    formattedChildren = formattedChildren.map {
+      if $0.leadingTrivia?.first?.isNewline == true {
+        return $0
+      } else {
+        return $0.with(\.leadingTrivia, indentedNewline + ($0.leadingTrivia ?? []))
+      }
+    }
+    indentationLevel -= 1
+    if !formattedChildren.isEmpty {
+      formattedChildren[formattedChildren.count - 1] = formattedChildren[formattedChildren.count - 1].with(\.trailingTrivia, indentedNewline)
+    }
+    return formattedChildren
+  }
 }

CodeGeneration/Sources/generate-swiftsyntax/KeywordFile.swift renamed to CodeGeneration/Sources/generate-swiftsyntax/templates/swiftsyntax/KeywordFile.swift

@@ -17,7 +17,7 @@ import Utils
 
 let lookupTable = ArrayExprSyntax(leftSquare: .leftSquareBracketToken(trailingTrivia: .newline)) {
   for keyword in KEYWORDS {
-    ArrayElementSyntax(expression: ExprSyntax("\(literal: keyword.name)"), trailingComma: .commaToken(), trailingTrivia: .newline)
+    ArrayElementSyntax(expression: ExprSyntax("\(literal: keyword.name)"), trailingComma: .commaToken())
   }
 }
 

Sources/SwiftBasicFormat/generated/BasicFormat.swift

@@ -61,10 +61,11 @@ open class BasicFormat: SyntaxRewriter {
     leadingTrivia = leadingTrivia.indented(indentation: indentation)
     trailingTrivia = trailingTrivia.indented(indentation: indentation)
     let rewritten = TokenSyntax(
-      node.tokenKind, 
-      leadingTrivia: leadingTrivia, 
-      trailingTrivia: trailingTrivia, 
-      presence: node.presence
+        node.tokenKind, 
+        leadingTrivia: leadingTrivia, 
+        trailingTrivia: trailingTrivia, 
+        presence: node.presence
+      
     )
     lastRewrittenToken = rewritten
     putNextTokenOnNewLine = false