Admit comments at the top of a Kotlin file and before the import list.

hovinen · Feb 18, 2021 · 2d32f82 · 2d32f82
1 parent 4113647
commit 2d32f82
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 1 deletion.
diff --git a/formatter/src/main/kotlin/org/kotlin/formatter/scanning/KotlinFileScanner.kt b/formatter/src/main/kotlin/org/kotlin/formatter/scanning/KotlinFileScanner.kt
@@ -13,12 +13,14 @@ import org.kotlin.formatter.scanning.nodepattern.nodePattern
 internal class KotlinFileScanner(private val kotlinScanner: KotlinScanner) : NodeScanner {
     private val nodePattern =
         nodePattern {
+            possibleWhitespaceWithComment()
             either {
                 nonEmptyPackageDirective() thenMapToTokens { nodes ->
                     kotlinScanner.scanNodes(nodes, ScannerState.BLOCK)
                 }
-                possibleWhitespace()
                 exactlyOne {
+                    possibleWhitespace()
+                    possibleWhitespaceWithComment()
                     nodeOfType(KtNodeTypes.IMPORT_LIST) thenMapToTokens { nodes ->
                         kotlinScanner.scanNodes(nodes, ScannerState.BLOCK)
                     }

diff --git a/formatter/src/test/kotlin/org/kotlin/formatter/KotlinFormatterTest.kt b/formatter/src/test/kotlin/org/kotlin/formatter/KotlinFormatterTest.kt
@@ -3659,6 +3659,56 @@ class KotlinFormatterTest {
         )
     }
 
+    @Test
+    fun `admits comments at the top of the file`() {
+        val subject = KotlinFormatter()
+
+        val result = subject.format(
+            """
+                /* A comment */
+                package org.kotlin.formatter
+                
+                class MyClass
+            """.trimIndent()
+        )
+
+        assertThat(result).isEqualTo(
+            """
+                /* A comment */
+                package org.kotlin.formatter
+                
+                class MyClass
+            """.trimIndent()
+        )
+    }
+
+    @Test
+    fun `admits comments before the import list`() {
+        val subject = KotlinFormatter()
+
+        val result = subject.format(
+            """
+                package org.kotlin.formatter
+                
+                /* A comment */
+                import apackage.AClass
+                
+                class MyClass : AClass
+            """.trimIndent()
+        )
+
+        assertThat(result).isEqualTo(
+            """
+                package org.kotlin.formatter
+                
+                /* A comment */
+                import apackage.AClass
+                
+                class MyClass : AClass
+            """.trimIndent()
+        )
+    }
+
     @Test
     fun `breaks before inheritance spec when necessary`() {
         val subject = KotlinFormatter(maxLineLength = 46)