Move EOL comment after left curly brace so code remains compilable (#730

) * Move EOL comment after left curly brace so code remains compilable * Leave comment on same line as left curly brace * Remove unused property
pinterest · May 23, 2020 · 63e8018 · 63e8018
1 parent 5fa5262
commit 63e8018
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 0 deletions.
diff --git a/...-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/SpacingAroundCurlyRule.kt b/...-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/SpacingAroundCurlyRule.kt
@@ -6,6 +6,7 @@ import com.pinterest.ktlint.core.ast.ElementType.CLASS_BODY
 import com.pinterest.ktlint.core.ast.ElementType.COLONCOLON
 import com.pinterest.ktlint.core.ast.ElementType.COMMA
 import com.pinterest.ktlint.core.ast.ElementType.DOT
+import com.pinterest.ktlint.core.ast.ElementType.EOL_COMMENT
 import com.pinterest.ktlint.core.ast.ElementType.EXCLEXCL
 import com.pinterest.ktlint.core.ast.ElementType.FUN
 import com.pinterest.ktlint.core.ast.ElementType.LAMBDA_EXPRESSION
@@ -23,8 +24,10 @@ import com.pinterest.ktlint.core.ast.prevLeaf
 import com.pinterest.ktlint.core.ast.upsertWhitespaceAfterMe
 import com.pinterest.ktlint.core.ast.upsertWhitespaceBeforeMe
 import org.jetbrains.kotlin.com.intellij.lang.ASTNode
+import org.jetbrains.kotlin.com.intellij.psi.PsiComment
 import org.jetbrains.kotlin.com.intellij.psi.PsiWhiteSpace
 import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.LeafPsiElement
+import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.TreeElement
 import org.jetbrains.kotlin.lexer.KtTokens
 import org.jetbrains.kotlin.psi.KtLambdaExpression
 
@@ -67,6 +70,18 @@ class SpacingAroundCurlyRule : Rule("curly-spacing") {
                 ) {
                     emit(node.startOffset, "Unexpected newline before \"${node.text}\"", true)
                     if (autoCorrect) {
+                        val eolCommentExists = prevLeaf.prevLeaf()?.let {
+                            it is PsiComment && it.elementType == EOL_COMMENT
+                        } ?: false
+                        if (eolCommentExists) {
+                            val commentLeaf = prevLeaf.prevLeaf()!!
+                            if (commentLeaf.prevLeaf() is PsiWhiteSpace) {
+                                (commentLeaf.prevLeaf() as LeafPsiElement).rawRemove()
+                            }
+                            (node.treeParent.treeParent as TreeElement).removeChild(commentLeaf)
+                            (node.treeParent as TreeElement).addChild(commentLeaf, node.treeNext)
+                            node.upsertWhitespaceAfterMe(" ")
+                        }
                         (prevLeaf as LeafPsiElement).rawReplaceWithText(" ")
                     }
                 }

diff --git a/...ndard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/SpacingAroundCurlyRuleTest.kt b/...ndard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/SpacingAroundCurlyRuleTest.kt
@@ -209,4 +209,44 @@ class SpacingAroundCurlyRuleTest {
                 { 42 }
         """.trimIndent())
     }
+
+    @Test
+    fun `eol comment placed after curly brace`() {
+        assertThat(
+            SpacingAroundCurlyRule().format(
+                """
+                class MyClass()// a comment
+                {
+                    val x = 0
+                }
+                """.trimIndent()
+            )
+        ).isEqualTo(
+            """
+                class MyClass() { // a comment
+                    val x = 0
+                }
+                """.trimIndent()
+        )
+    }
+
+    @Test
+    fun `eol comment with preceding whitespace placed after curly brace`() {
+        assertThat(
+            SpacingAroundCurlyRule().format(
+                """
+                class MyClass() // a comment
+                {
+                    val x = 0
+                }
+                """.trimIndent()
+            )
+        ).isEqualTo(
+            """
+                class MyClass() { // a comment
+                    val x = 0
+                }
+                """.trimIndent()
+        )
+    }
 }