Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NoLineBreakBeforeAssignmentRule: fix wrong formatting when a assignment has comments #973

Merged
merged 1 commit into from
Nov 22, 2020
Merged

NoLineBreakBeforeAssignmentRule: fix wrong formatting when a assignment has comments #973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions .../src/main/kotlin/com/pinterest/ktlint/ruleset/standard/NoLineBreakBeforeAssignmentRule.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,35 @@ package com.pinterest.ktlint.ruleset.standard

import com.pinterest.ktlint.core.Rule
import com.pinterest.ktlint.core.ast.ElementType.EQ
import com.pinterest.ktlint.core.ast.ElementType.REGULAR_STRING_PART
import com.pinterest.ktlint.core.ast.isPartOfComment
import com.pinterest.ktlint.core.ast.isWhiteSpace
import com.pinterest.ktlint.core.ast.isWhiteSpaceWithNewline
import com.pinterest.ktlint.core.ast.prevCodeSibling
import org.jetbrains.kotlin.com.intellij.lang.ASTNode
import org.jetbrains.kotlin.com.intellij.psi.PsiWhiteSpace
import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.LeafPsiElement
import org.jetbrains.kotlin.psi.psiUtil.siblings

class NoLineBreakBeforeAssignmentRule : Rule("no-line-break-before-assignment") {

override fun visit(node: ASTNode, autoCorrect: Boolean, emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit) {
if (node.elementType == EQ) {
val prevElement = node.treePrev?.psi
if (prevElement is PsiWhiteSpace && prevElement.text.contains("\n")) {
val prevCodeSibling = node.prevCodeSibling()
val hasLineBreakBeforeAssignment = prevCodeSibling
?.siblings()
?.takeWhile { it.isWhiteSpace() || it.isPartOfComment() }
?.any { it.isWhiteSpaceWithNewline() }
if (hasLineBreakBeforeAssignment == true) {
emit(node.startOffset, "Line break before assignment is not allowed", true)
if (autoCorrect) {
val leaf = node.treeNext?.psi as? LeafPsiElement
if (leaf != null) {
leaf.rawReplaceWithText(prevElement.text)
} else {
(node.psi as LeafPsiElement).rawInsertAfterMe(
LeafPsiElement(REGULAR_STRING_PART, prevElement.text)
)
val next = prevCodeSibling.treeNext
val newText = buildString {
append(" =")
if (next !is PsiWhiteSpace) append(" ")
append(next.text)
}
(prevElement as LeafPsiElement).rawReplaceWithText(" ")
(next as? LeafPsiElement)?.rawReplaceWithText(newText)
(node as? LeafPsiElement)?.delete()
}
}
}
Expand Down
72 changes: 72 additions & 0 deletions .../test/kotlin/com/pinterest/ktlint/ruleset/standard/NoLineBreakBeforeAssignmentRuleTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,76 @@ class NoLineBreakBeforeAssignmentRuleTest {
""".trimIndent()
)
}

@Test
fun `test assignment with comment 1`() {
assertThat(
NoLineBreakBeforeAssignmentRule().format(
"""
fun sum(a: Int, b: Int): Int
// comment
= a + b
""".trimIndent()
)
).isEqualTo(
"""
fun sum(a: Int, b: Int): Int =
// comment
a + b
""".trimIndent()
)
}

@Test
fun `test assignment with comment 2`() {
assertThat(
NoLineBreakBeforeAssignmentRule().format(
"""
fun sum(a: Int, b: Int): Int
// comment
=a + b
""".trimIndent()
)
).isEqualTo(
"""
fun sum(a: Int, b: Int): Int =
// comment
a + b
""".trimIndent()
)
}

@Test
fun `test assignment with comment 3`() {
assertThat(
NoLineBreakBeforeAssignmentRule().format(
"""
fun sum(a: Int, b: Int): Int // comment
= a + b
""".trimIndent()
)
).isEqualTo(
"""
fun sum(a: Int, b: Int): Int = // comment
a + b
""".trimIndent()
)
}

@Test
fun `test assignment with comment 4`() {
assertThat(
NoLineBreakBeforeAssignmentRule().format(
"""
fun sum(a: Int, b: Int): Int// comment
= a + b
""".trimIndent()
)
).isEqualTo(
"""
fun sum(a: Int, b: Int): Int = // comment
a + b
""".trimIndent()
)
}
}