BLANK_LINE_BETWEEN_PROPERTIES false positive (#1608)

* BLANK_LINE_BETWEEN_PROPERTIES false positive ### What's done: * fixed isFollowedByNewlineCheck Closes #1496
saveourtool · Feb 3, 2023 · 22c1cdb · 22c1cdb
1 parent 7954882
commit 22c1cdb
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 1 deletion.
diff --git a/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt b/diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt
@@ -185,7 +185,11 @@ fun ASTNode.isEol() = parent({ it.treeNext != null }, false)?.isFollowedByNewlin
  */
 fun ASTNode.isFollowedByNewline() =
     parent({ it.treeNext != null }, strict = false)?.let {
-        it.treeNext.elementType == WHITE_SPACE && it.treeNext.text.contains("\n")
+        val probablyWhitespace = it.treeNext
+        it.isFollowedByNewlineCheck() ||
+                (probablyWhitespace.elementType == WHITE_SPACE && probablyWhitespace.treeNext.run {
+                    elementType == EOL_COMMENT && isFollowedByNewlineCheck()
+                })
     } ?: false
 
 /**
@@ -902,6 +906,9 @@ fun ASTNode.isBooleanExpression(): Boolean =
 fun PsiElement.isLongStringTemplateEntry(): Boolean =
     node.elementType == LONG_STRING_TEMPLATE_ENTRY
 
+private fun ASTNode.isFollowedByNewlineCheck() =
+    this.treeNext.elementType == WHITE_SPACE && this.treeNext.text.contains("\n")
+
 private fun <T> Sequence<T>.takeWhileInclusive(pred: (T) -> Boolean): Sequence<T> {
     var shouldContinue = true
     return takeWhile {

diff --git a/.../src/test/kotlin/org/cqfn/diktat/ruleset/chapter3/ClassLikeStructuresOrderRuleWarnTest.kt b/.../src/test/kotlin/org/cqfn/diktat/ruleset/chapter3/ClassLikeStructuresOrderRuleWarnTest.kt
@@ -146,6 +146,20 @@ class ClassLikeStructuresOrderRuleWarnTest : LintTestBase(::ClassLikeStructuresO
         )
     }
 
+    @Test
+    @Tag(WarningNames.BLANK_LINE_BETWEEN_PROPERTIES)
+    fun `a single-line comment after annotation`() {
+        lintMethod(
+            """class Example {
+                    |   private val val0 = Regex(""${'"'}\d+""${'"'})
+                    |
+                    |    @Deprecated("Deprecation message") // Trailing comment
+                    |    private val val2 = ""
+                    |}
+            """.trimMargin()
+        )
+    }
+
     @Test
     @Tag(WarningNames.BLANK_LINE_BETWEEN_PROPERTIES)
     fun `should allow blank lines around properties with custom getters and setters - positive example`() {