Fix false positive with elvis operator and comment (chain-wrapping)

pinterest · Jul 4, 2021 · da19fe3 · da19fe3
1 parent 15b98b0
commit da19fe3
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Fix false positive in lambda in dot qualified expression (`argument-list-wrapping`) ([#1112](https://github.com/pinterest/ktlint/issues/1112))
 - Fix false positive with multiline expression with elvis operator in assignment (`indent`) ([#1165](https://github.com/pinterest/ktlint/issues/1165))
 - Ignore backticks in imports for ordering purposes (`import-ordering`) ([#1106](https://github.com/pinterest/ktlint/issues/1106))
+- Fix false positive with elvis operator and comment (`chain-wrapping`) ([#1055](https://github.com/pinterest/ktlint/issues/1055))
 ### Changed
 - Updated to dokka 1.4.32 ([#1148](https://github.com/pinterest/ktlint/pull/1148))
 - Updated Kotlin to 1.5.20 version

diff --git a/...leset-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/ChainWrappingRule.kt b/...leset-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/ChainWrappingRule.kt
@@ -19,6 +19,8 @@ import com.pinterest.ktlint.core.ast.ElementType.SAFE_ACCESS
 import com.pinterest.ktlint.core.ast.ElementType.WHEN_CONDITION_WITH_EXPRESSION
 import com.pinterest.ktlint.core.ast.ElementType.WHITE_SPACE
 import com.pinterest.ktlint.core.ast.isPartOfComment
+import com.pinterest.ktlint.core.ast.isWhiteSpaceWithNewline
+import com.pinterest.ktlint.core.ast.isWhiteSpaceWithoutNewline
 import com.pinterest.ktlint.core.ast.nextCodeLeaf
 import com.pinterest.ktlint.core.ast.nextLeaf
 import com.pinterest.ktlint.core.ast.prevCodeLeaf
@@ -30,6 +32,7 @@ import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.LeafElement
 import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.LeafPsiElement
 import org.jetbrains.kotlin.com.intellij.psi.tree.TokenSet
 import org.jetbrains.kotlin.lexer.KtTokens
+import org.jetbrains.kotlin.psi.psiUtil.leaves
 
 class ChainWrappingRule : Rule("chain-wrapping") {
 
@@ -54,9 +57,7 @@ class ChainWrappingRule : Rule("chain-wrapping") {
                 return
             }
             val nextLeaf = node.nextCodeLeaf()?.prevLeaf()
-            if (nextLeaf?.elementType == WHITE_SPACE &&
-                nextLeaf.textContains('\n')
-            ) {
+            if (nextLeaf.isWhiteSpaceWithNewline() && !node.isElvisOperatorAndComment()) {
                 emit(node.startOffset, "Line must not end with \"${node.text}\"", true)
                 if (autoCorrect) {
                     // rewriting
@@ -129,4 +130,9 @@ class ChainWrappingRule : Rule("chain-wrapping") {
 
     private fun ASTNode.isPartOfWhenCondition() =
         treeParent?.treeParent?.treeParent?.elementType == WHEN_CONDITION_WITH_EXPRESSION
+
+    private fun ASTNode.isElvisOperatorAndComment(): Boolean {
+        return elementType == ELVIS &&
+            leaves().takeWhile { it.isWhiteSpaceWithoutNewline() || it.isPartOfComment() }.any()
+    }
 }
diff --git a/...t-standard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/ChainWrappingRuleTest.kt b/...t-standard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/ChainWrappingRuleTest.kt
@@ -2,6 +2,7 @@ package com.pinterest.ktlint.ruleset.standard
 
 import com.pinterest.ktlint.test.diffFileFormat
 import com.pinterest.ktlint.test.diffFileLint
+import com.pinterest.ktlint.test.lint
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.Test
 
@@ -21,4 +22,26 @@ class ChainWrappingRuleTest {
             )
         ).isEmpty()
     }
+
+    // https://github.com/pinterest/ktlint/issues/1055
+    @Test
+    fun `lint elvis operator and comment`() {
+        assertThat(
+            ChainWrappingRule().lint(
+                """
+                fun test(): Int {
+                    val foo = foo()
+                        ?: // Comment
+                        return bar()
+                    return baz()
+                }
+
+                fun foo(): Int? = null
+                fun bar(): Int = 1
+                fun baz(): Int = 2
+
+                """.trimIndent()
+            )
+        ).isEmpty()
+    }
 }