Remove leading newline above header in source file syntax

kimdv · kimdv · commit 4b226f26cd5a · 2023-02-24T07:25:54.000+01:00
diff --git a/CodeGeneration/Sources/Utils/CodeGenerationFormat.swift b/CodeGeneration/Sources/Utils/CodeGenerationFormat.swift
@@ -36,7 +36,7 @@ public class CodeGenerationFormat: BasicFormat {
   }
 
   public override func visit(_ node: CodeBlockItemSyntax) -> CodeBlockItemSyntax {
-    if node.parent?.parent?.is(SourceFileSyntax.self) == true, !node.item.is(ImportDeclSyntax.self) {
+    if node.parent?.parent?.is(SourceFileSyntax.self) == true, !shouldBeSeparatedByTwoNewlines(node: node) {
       let formatted = super.visit(node)
       return ensuringTwoLeadingNewlines(node: formatted)
     } else {
@@ -85,6 +85,12 @@ public class CodeGenerationFormat: BasicFormat {
 
   // MARK: - Private
 
+  private func shouldBeSeparatedByTwoNewlines(node: CodeBlockItemSyntax) -> Bool {
+    // First item in the `CodeBlockItemListSyntax` don't need a newline or identation if the parent is a `SourceFileSyntax`.
+    // We want to group imports so newline between them should be omitted
+    return node.parent?.as(CodeBlockItemListSyntax.self)?.first == node || node.item.is(ImportDeclSyntax.self)
+  }
+
   private func ensuringTwoLeadingNewlines<NodeType: SyntaxProtocol>(node: NodeType) -> NodeType {
     if node.leadingTrivia?.first?.isNewline ?? false {
       return node.with(\.leadingTrivia, indentedNewline + (node.leadingTrivia ?? []))
diff --git a/Sources/SwiftSyntax/generated/Keyword.swift b/Sources/SwiftSyntax/generated/Keyword.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/Misc.swift b/Sources/SwiftSyntax/generated/Misc.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/SyntaxAnyVisitor.swift b/Sources/SwiftSyntax/generated/SyntaxAnyVisitor.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/SyntaxBaseNodes.swift b/Sources/SwiftSyntax/generated/SyntaxBaseNodes.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/SyntaxCollections.swift b/Sources/SwiftSyntax/generated/SyntaxCollections.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/SyntaxEnum.swift b/Sources/SwiftSyntax/generated/SyntaxEnum.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/SyntaxKind.swift b/Sources/SwiftSyntax/generated/SyntaxKind.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/SyntaxRewriter.swift b/Sources/SwiftSyntax/generated/SyntaxRewriter.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/SyntaxTraits.swift b/Sources/SwiftSyntax/generated/SyntaxTraits.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/SyntaxTransform.swift b/Sources/SwiftSyntax/generated/SyntaxTransform.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/SyntaxVisitor.swift b/Sources/SwiftSyntax/generated/SyntaxVisitor.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/TokenKind.swift b/Sources/SwiftSyntax/generated/TokenKind.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/Tokens.swift b/Sources/SwiftSyntax/generated/Tokens.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/Trivia.swift b/Sources/SwiftSyntax/generated/Trivia.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/raw/RawSyntaxNodes.swift b/Sources/SwiftSyntax/generated/raw/RawSyntaxNodes.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/syntaxNodes/SyntaxDeclNodes.swift b/Sources/SwiftSyntax/generated/syntaxNodes/SyntaxDeclNodes.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/syntaxNodes/SyntaxExprNodes.swift b/Sources/SwiftSyntax/generated/syntaxNodes/SyntaxExprNodes.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/syntaxNodes/SyntaxNodes.swift b/Sources/SwiftSyntax/generated/syntaxNodes/SyntaxNodes.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/syntaxNodes/SyntaxPatternNodes.swift b/Sources/SwiftSyntax/generated/syntaxNodes/SyntaxPatternNodes.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/syntaxNodes/SyntaxStmtNodes.swift b/Sources/SwiftSyntax/generated/syntaxNodes/SyntaxStmtNodes.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//
diff --git a/Sources/SwiftSyntax/generated/syntaxNodes/SyntaxTypeNodes.swift b/Sources/SwiftSyntax/generated/syntaxNodes/SyntaxTypeNodes.swift
@@ -1,5 +1,3 @@
-
-
 //// Automatically Generated by generate-swiftsyntax
 //// Do Not Edit Directly!
 //===----------------------------------------------------------------------===//

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-`
`2`		`-`
`3`	`1`	`//// Automatically Generated by generate-swiftsyntax`
`4`	`2`	`//// Do Not Edit Directly!`
`5`	`3`	`//===----------------------------------------------------------------------===//`