Fix adding blank line between declaration and an annotated declaratio…

…n which is preceded by comment (#2429) Closes #2416
pinterest · Dec 11, 2023 · ac870c5 · ac870c5
1 parent ad879b8
commit ac870c5
Show file tree

Hide file tree

Showing 2 changed files with 89 additions and 2 deletions.
diff --git a/.../pinterest/ktlint/ruleset/standard/rules/SpacingBetweenDeclarationsWithAnnotationsRule.kt b/.../pinterest/ktlint/ruleset/standard/rules/SpacingBetweenDeclarationsWithAnnotationsRule.kt
@@ -9,7 +9,8 @@ import com.pinterest.ktlint.rule.engine.core.api.children
 import com.pinterest.ktlint.rule.engine.core.api.indent
 import com.pinterest.ktlint.rule.engine.core.api.isPartOfComment
 import com.pinterest.ktlint.rule.engine.core.api.isWhiteSpace
-import com.pinterest.ktlint.rule.engine.core.api.prevLeaf
+import com.pinterest.ktlint.rule.engine.core.api.nextLeaf
+import com.pinterest.ktlint.rule.engine.core.api.prevCodeLeaf
 import com.pinterest.ktlint.rule.engine.core.api.upsertWhitespaceBeforeMe
 import com.pinterest.ktlint.ruleset.standard.StandardRule
 import org.jetbrains.kotlin.com.intellij.lang.ASTNode
@@ -46,7 +47,7 @@ public class SpacingBetweenDeclarationsWithAnnotationsRule : StandardRule("spaci
             ?.takeIf { it is KtDeclaration }
             ?.takeIf { prevDeclaration -> hasNoBlankLineBetweenDeclarations(node, prevDeclaration) }
             ?.let {
-                val prevLeaf = node.prevLeaf { it.isWhiteSpace() || it.isPartOfComment() }!!
+                val prevLeaf = node.prevCodeLeaf()?.nextLeaf { it.isWhiteSpace() }!!
                 emit(
                     prevLeaf.startOffset + 1,
                     "Declarations and declarations with annotations should have an empty space between.",

diff --git a/...terest/ktlint/ruleset/standard/rules/SpacingBetweenDeclarationsWithAnnotationsRuleTest.kt b/...terest/ktlint/ruleset/standard/rules/SpacingBetweenDeclarationsWithAnnotationsRuleTest.kt
@@ -220,4 +220,90 @@ class SpacingBetweenDeclarationsWithAnnotationsRuleTest {
             """.trimIndent()
         spacingBetweenDeclarationsWithAnnotationsRuleAssertThat(code).hasNoLintViolations()
     }
+
+    @Test
+    fun `Issue 2416 - Given a declaration followed by an EOL comment and other annotated declaration`() {
+        val code =
+            """
+            fun foobar() {
+                val bar = "bar"
+                // Some comment
+                @Suppress("unused")
+                val foo  = "foo"
+            }
+            """.trimIndent()
+        val formattedCode =
+            """
+            fun foobar() {
+                val bar = "bar"
+
+                // Some comment
+                @Suppress("unused")
+                val foo  = "foo"
+            }
+            """.trimIndent()
+        spacingBetweenDeclarationsWithAnnotationsRuleAssertThat(code)
+            .hasLintViolation(3, 1, "Declarations and declarations with annotations should have an empty space between.")
+            .isFormattedAs(formattedCode)
+    }
+
+    @Test
+    fun `Issue 2416 - Given a declaration followed by a block comment and other annotated declaration`() {
+        val code =
+            """
+            fun foobar() {
+                val bar = "bar"
+                /*
+                 * Some comment
+                 */
+                @Suppress("unused")
+                val foo  = "foo"
+            }
+            """.trimIndent()
+        val formattedCode =
+            """
+            fun foobar() {
+                val bar = "bar"
+
+                /*
+                 * Some comment
+                 */
+                @Suppress("unused")
+                val foo  = "foo"
+            }
+            """.trimIndent()
+        spacingBetweenDeclarationsWithAnnotationsRuleAssertThat(code)
+            .hasLintViolation(3, 1, "Declarations and declarations with annotations should have an empty space between.")
+            .isFormattedAs(formattedCode)
+    }
+
+    @Test
+    fun `Issue 2416 - Given a declaration followed by a KDoc and other annotated declaration`() {
+        val code =
+            """
+            fun foobar() {
+                val bar = "bar"
+                /**
+                 * Some comment
+                 */
+                @Suppress("unused")
+                val foo  = "foo"
+            }
+            """.trimIndent()
+        val formattedCode =
+            """
+            fun foobar() {
+                val bar = "bar"
+
+                /**
+                 * Some comment
+                 */
+                @Suppress("unused")
+                val foo  = "foo"
+            }
+            """.trimIndent()
+        spacingBetweenDeclarationsWithAnnotationsRuleAssertThat(code)
+            .hasLintViolation(3, 1, "Declarations and declarations with annotations should have an empty space between.")
+            .isFormattedAs(formattedCode)
+    }
 }