Skip to content

#1: Add if rule #5

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

Open
bitvale wants to merge 2 commits into
base: master
Choose a base branch
from
Open

#1: Add if rule #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85c9756
Add if rule
bitvale Feb 10, 2021
07623cc
Update if rule test
bitvale Feb 10, 2021
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
111 changes: 111 additions & 0 deletions ktlint-rules/src/main/java/ru/nobird/android/ktlint/rules/IfElseRule.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
package ru.nobird.android.ktlint.rules

import com.pinterest.ktlint.core.Rule
import com.pinterest.ktlint.core.ast.ElementType
import com.pinterest.ktlint.core.ast.children
import org.jetbrains.kotlin.com.intellij.lang.ASTNode
import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.LeafPsiElement
import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.PsiWhiteSpaceImpl
import org.jetbrains.kotlin.psi.KtIfExpression
import org.jetbrains.kotlin.psi.KtVariableDeclaration

/**
* Created by Alexander Kolpakov (jquickapp@gmail.com) on 09-Feb-21
* https://github.com/bitvale
*/
class IfElseRule : Rule("single-multiline-if-else") {
companion object {
private const val MAX_EXPRESSION_SIZE = 100
private const val INDENT_SIZE = 4
}

override fun visit(
node: ASTNode,
autoCorrect: Boolean,
emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit
) {
when (val element = node.psi ?: return) {
is KtVariableDeclaration -> {
val ifExpression = element.lastChild as? KtIfExpression ?: return

if (ifExpression.text.length <= MAX_EXPRESSION_SIZE &&
!ifExpression.prevSibling.text.contains('\n') &&
!ifExpression.text.contains('{')
) return

val incorrectOneLine = ifExpression.text.length > 100 &&
(!ifExpression.prevSibling.text.contains('\n') ||
!ifExpression.text.contains('{'))

val incorrectMultiline = ifExpression.text.contains('{') &&
!ifExpression.prevSibling.text.contains('\n')

if (incorrectOneLine || incorrectMultiline) {
emit(
node.startOffset,
"Is expression should be formatted correctly",
true
)

if (autoCorrect) {
val lastChildNode = node.lastChildNode

val afterEqualSpaces = node.children()
.first { it.elementType == ElementType.EQ }
.treeNext

node.replaceChild(afterEqualSpaces, PsiWhiteSpaceImpl(" "))
node.removeChild(lastChildNode)

node.addChild(LeafPsiElement(ElementType.DANGLING_NEWLINE, "\n"), null)
val indent =
if (element.prevSibling.text.contains("\n")) {
element.prevSibling.text.split("\n").last().length
} else {
element.prevSibling.textLength
}
node.addChild(PsiWhiteSpaceImpl(" ".repeat(indent + INDENT_SIZE)), null)

node.addChild(LeafPsiElement(ElementType.IF_KEYWORD, "if"), null)
node.addChild(PsiWhiteSpaceImpl(" "), null)
node.addChild(LeafPsiElement(ElementType.LPAR, "("), null)
node.addChild(
lastChildNode.children()
.first { it.elementType == ElementType.CONDITION },
null
)
node.addChild(LeafPsiElement(ElementType.RPAR, ")"), null)
node.addChild(PsiWhiteSpaceImpl(" "), null)
node.addChild(LeafPsiElement(ElementType.LBRACE, "{"), null)
node.addChild(LeafPsiElement(ElementType.DANGLING_NEWLINE, "\n"), null)
val firstBlock = lastChildNode.children()
.first { it.elementType == ElementType.THEN }
.text
.replace("{", "")
.replace("}", "")
node.addChild(PsiWhiteSpaceImpl(" ".repeat(indent + INDENT_SIZE * 2)), null)
node.addChild(LeafPsiElement(ElementType.BLOCK, firstBlock.trim()), null)
node.addChild(LeafPsiElement(ElementType.DANGLING_NEWLINE, "\n"), null)
node.addChild(PsiWhiteSpaceImpl(" ".repeat(indent + INDENT_SIZE)), null)
node.addChild(LeafPsiElement(ElementType.RBRACE, "}"), null)
node.addChild(PsiWhiteSpaceImpl(" "), null)
node.addChild(LeafPsiElement(ElementType.ELSE_KEYWORD, "else"), null)
node.addChild(PsiWhiteSpaceImpl(" "), null)
node.addChild(LeafPsiElement(ElementType.LBRACE, "{"), null)
node.addChild(LeafPsiElement(ElementType.DANGLING_NEWLINE, "\n"), null)
val secondBlock = lastChildNode.children()
.first { it.elementType == ElementType.ELSE }
.text
.replace("{", "")
.replace("}", "")
node.addChild(PsiWhiteSpaceImpl(" ".repeat(indent + INDENT_SIZE * 2)), null)
node.addChild(LeafPsiElement(ElementType.BLOCK, secondBlock.trim()), null)
node.addChild(LeafPsiElement(ElementType.DANGLING_NEWLINE, "\n"), null)
node.addChild(PsiWhiteSpaceImpl(" ".repeat(indent + INDENT_SIZE)), null)
node.addChild(LeafPsiElement(ElementType.RBRACE, "}"), null)
}
}
}
}
}
}
3 changes: 2 additions & 1 deletion ktlint-rules/src/main/java/ru/nobird/android/ktlint/rules/NobirdRuleSetProvider.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ class NobirdRuleSetProvider : RuleSetProvider {
"nobird-ktlint-rules",
ExpressionBodyRule(),
ExpressionBodyIndentRule(),
ExplicitPublicTypeRule()
ExplicitPublicTypeRule(),
IfElseRule()
)
}
229 changes: 229 additions & 0 deletions ktlint-rules/src/test/java/ru/nobird/android/ktlint/rules/IfElseRuleTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
package ru.nobird.android.ktlint.rules

import org.junit.Test

/**
* Created by Alexander Kolpakov (jquickapp@gmail.com) on 09-Feb-21
* https://github.com/bitvale
*/
class IfElseRuleTest {
private val rule = IfElseRule()

@Test
fun `if statement shorter than 100 symbols`() {
assertNoLintErrors(
"""
private fun hello() {
val x = if (a > 13) 100 else 500
}
""",
rule
)
}

@Test
fun `if statement equal 100 symbols`() {
assertNoLintErrors(
"""
private fun hello() {
val x = if (a > 13) 100 else 5000000000000000000000000000000000000000000000000000000000000000000000000000000
}
""",
rule
)
}

@Test
fun `if statement longer than 100 symbols`() {
assertFormat(
"""
private fun hello() {
val x = if (a > 13) 100 else 50000000000000000000000000000000000000000000000000000000000000000000000000000000
}
""",
"""
private fun hello() {
val x =
if (a > 13) {
100
} else {
50000000000000000000000000000000000000000000000000000000000000000000000000000000
}
}
""",
rule
)
}

@Test
fun `if statement with brace on one line`() {
assertFormat(
"""
private fun hello() {
val x = if (a > 13) { 100 + 450 } else { 500 }
}
""",
"""
private fun hello() {
val x =
if (a > 13) {
100 + 450
} else {
500
}
}
""",
rule
)
}

@Test
fun `if statement with brace on one line with incorrect indent`() {
assertFormat(
"""
private fun hello() {
val x = if (a > 13) { 100 + 450 } else { 500 }
}
""",
"""
private fun hello() {
val x =
if (a > 13) {
100 + 450
} else {
500
}
}
""",
rule
)
}

@Test
fun `if statement with brace on two lines`() {
assertFormat(
"""
private fun hello() {
val x = if (a > 13) { 100 }
else { 500 }
}
""",
"""
private fun hello() {
val x =
if (a > 13) {
100
} else {
500
}
}
""",
rule
)
}

@Test
fun `incorrect if statement 1`() {
assertFormat(
"""
private fun hello() {
val x = if (a > 13)
100
else
500
}
""",
"""
private fun hello() {
val x =
if (a > 13) {
100
} else {
500
}
}
""",
rule
)
}

@Test
fun `incorrect if statement 2`() {
assertFormat(
"""
private fun hello() {
val x =
if (a > 13)
100
else
500
}
""",
"""
private fun hello() {
val x =
if (a > 13) {
100
} else {
500
}
}
""",
rule
)
}

@Test
fun `incorrect if statement 3`() {
assertFormat(
"""
private fun hello() {
val x =

if (a > 13)
100
else
500
}
""",
"""
private fun hello() {
val x =
if (a > 13) {
100
} else {
500
}
}
""",
rule
)
}

@Test
fun `incorrect if statement 4`() {
assertFormat(
"""
private fun hello() {
val x = if (a > 13) {
val q = 1
q
} else
500
}
""",
"""
private fun hello() {
val x =
if (a > 13) {
val q = 1
q
} else {
500
}
}
""",
rule
)
}
}