Skip to content

Commit

Permalink
Fix indent of explicit constructor
Browse files Browse the repository at this point in the history 
(also see #2115)
  • Loading branch information
@paul-dingemans
paul-dingemans committed Jul 9, 2023
1 parent 1e0773f commit e6ff69a
Show file tree
Hide file tree
Showing 2 changed files with 102 additions and 19 deletions.
75 changes: 71 additions & 4 deletions ...t-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/IndentationRule.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import com.pinterest.ktlint.rule.engine.core.api.ElementType.CLASS
import com.pinterest.ktlint.rule.engine.core.api.ElementType.CLASS_BODY
import com.pinterest.ktlint.rule.engine.core.api.ElementType.CLOSING_QUOTE
import com.pinterest.ktlint.rule.engine.core.api.ElementType.COLON
import com.pinterest.ktlint.rule.engine.core.api.ElementType.COMMA
import com.pinterest.ktlint.rule.engine.core.api.ElementType.CONDITION
import com.pinterest.ktlint.rule.engine.core.api.ElementType.CONSTRUCTOR_DELEGATION_CALL
import com.pinterest.ktlint.rule.engine.core.api.ElementType.CONSTRUCTOR_KEYWORD
Expand Down Expand Up @@ -206,14 +207,42 @@ public class IndentationRule :
node.elementType == CLASS_BODY ||
node.elementType == CONTEXT_RECEIVER_LIST ||
node.elementType == LONG_STRING_TEMPLATE_ENTRY ||
node.elementType == SUPER_TYPE_CALL_ENTRY ||
node.elementType == STRING_TEMPLATE ||
node.elementType == VALUE_ARGUMENT_LIST ->
startIndentContext(
fromAstNode = node,
lastChildIndent = "",
)

node.elementType == SUPER_TYPE_CALL_ENTRY -> {
if (codeStyle == ktlint_official &&
node
.parent { it.elementType == CLASS }
?.findChildByType(PRIMARY_CONSTRUCTOR) != null
) {
// Contrary to the default IntelliJ IDEA formatter, indent the super type call entry so that it looks better in case it
// is followed by another super type:
// class Foo(
// val bar1: Bar,
// val bar2: Bar,
// ) : FooBar(
// bar1,
// bar2
// ),
// BarFoo,
startIndentContext(
fromAstNode = node,
childIndent = indentConfig.indent,
activated = true,
)
} else {
startIndentContext(
fromAstNode = node,
lastChildIndent = "",
)
}
}

node.elementType == VALUE_ARGUMENT ->
visitValueArgument(node)

Expand Down Expand Up @@ -608,16 +637,52 @@ public class IndentationRule :
val primaryConstructor = node.findChildByType(PRIMARY_CONSTRUCTOR)
val containsConstructorKeyword = primaryConstructor?.findChildByType(CONSTRUCTOR_KEYWORD) != null
if (codeStyle == ktlint_official && primaryConstructor != null && containsConstructorKeyword) {
// Indent both constructor and super type list
// Contrary to the default IntelliJ IDEA formatter, ident both constructor and super type list as follows:
// class Foo
// @Bar1 @Bar2
// constructor(
// foo1: Foo1,
// foo2: Foo2,
// ) : Foobar1(
// "foobar1",
// "foobar2",
// ),
// FooBar2,
val superTypeList = node.findChildByType(SUPER_TYPE_LIST)
nextToAstNode =
startIndentContext(
fromAstNode = primaryConstructor.getPrecedingLeadingCommentsAndWhitespaces(),
toAstNode =
node
.findChildByType(SUPER_TYPE_LIST)
superTypeList
?.lastChildLeafOrSelf()
?: nextToAstNode,
).prevCodeLeaf()

superTypeList
?.findChildByType(COMMA)
?.let { comma ->
// In case of a multiline primary constructor the first super type is merged with the closing parenthesis of the
// constructor. The start of the super type list does not activate the indent because it is not preceded by a newline.
// To fix this, the super type entries on the next line (e.g. after the comma) have to be double indented.
// Allow:
// class Foo(
// val bar1: Bar,
// val bar2: Bar,
// ) : FooBar(
// bar1,
// bar2
// ),
// BarFoo1
val prevCodeLeaf = startIndentContext(
fromAstNode = comma,
toAstNode = superTypeList.lastChildLeafOrSelf(),
childIndent = indentConfig.indent.repeat(2),
).prevCodeLeaf()
startIndentContext(
fromAstNode = primaryConstructor.getPrecedingLeadingCommentsAndWhitespaces(),
toAstNode = prevCodeLeaf,
).prevCodeLeaf()
}
} else {
node
.findChildByType(SUPER_TYPE_LIST)
Expand Down Expand Up @@ -922,6 +987,7 @@ public class IndentationRule :
childIndent: String = indentConfig.indent,
firstChildIndent: String = childIndent,
lastChildIndent: String = childIndent,
activated: Boolean = false,
): IndentContext =
IndentContext(
fromASTNode = fromAstNode,
Expand All @@ -930,6 +996,7 @@ public class IndentationRule :
firstChildIndent = firstChildIndent,
childIndent = childIndent,
lastChildIndent = lastChildIndent,
activated = activated,
).also { newIndentContext ->
LOGGER.trace {
val nodeIndentLevel = indentConfig.indentLevelFrom(newIndentContext.nodeIndent)
Expand Down
46 changes: 31 additions & 15 deletions ...andard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/IndentationRuleTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5021,9 +5021,9 @@ internal class IndentationRuleTest {
foo1: Foo1,
foo2: Foo2,
) : Foobar(
"foobar1",
"foobar2",
) {
"foobar1",
"foobar2",
) {
fun foo() = "foo"
}
""".trimIndent()
Expand All @@ -5035,9 +5035,9 @@ internal class IndentationRuleTest {
LintViolation(4, 1, "Unexpected indentation (4) (should be 8)"),
LintViolation(5, 1, "Unexpected indentation (4) (should be 8)"),
LintViolation(6, 1, "Unexpected indentation (0) (should be 4)"),
LintViolation(7, 1, "Unexpected indentation (4) (should be 8)"),
LintViolation(8, 1, "Unexpected indentation (4) (should be 8)"),
LintViolation(9, 1, "Unexpected indentation (0) (should be 4)"),
LintViolation(7, 1, "Unexpected indentation (4) (should be 12)"),
LintViolation(8, 1, "Unexpected indentation (4) (should be 12)"),
LintViolation(9, 1, "Unexpected indentation (0) (should be 8)"),
).isFormattedAs(formattedCode)
}

Expand All @@ -5053,7 +5053,9 @@ internal class IndentationRuleTest {
) : Foobar1(
"foobar1",
"foobar2",
), FooBar2 {
),
FooBar2,
FooBar3 {
fun foo() = "foo"
}
""".trimIndent()
Expand All @@ -5065,9 +5067,11 @@ internal class IndentationRuleTest {
foo1: Foo1,
foo2: Foo2,
) : Foobar1(
"foobar1",
"foobar2",
), FooBar2 {
"foobar1",
"foobar2",
),
FooBar2,
FooBar3 {
fun foo() = "foo"
}
""".trimIndent()
Expand All @@ -5079,20 +5083,32 @@ internal class IndentationRuleTest {
LintViolation(4, 1, "Unexpected indentation (4) (should be 8)"),
LintViolation(5, 1, "Unexpected indentation (4) (should be 8)"),
LintViolation(6, 1, "Unexpected indentation (0) (should be 4)"),
LintViolation(7, 1, "Unexpected indentation (4) (should be 8)"),
LintViolation(8, 1, "Unexpected indentation (4) (should be 8)"),
LintViolation(9, 1, "Unexpected indentation (0) (should be 4)"),
LintViolation(7, 1, "Unexpected indentation (4) (should be 12)"),
LintViolation(8, 1, "Unexpected indentation (4) (should be 12)"),
LintViolation(9, 1, "Unexpected indentation (0) (should be 8)"),
LintViolation(10, 1, "Unexpected indentation (4) (should be 8)"),
LintViolation(11, 1, "Unexpected indentation (4) (should be 8)"),
).isFormattedAs(formattedCode)
}

@Test
fun `Issue 2115 - Given a class without an explicit constructor and with a long super type list then do not indent the class body`() {
val code =
"""
class Foo(
class Foo1 :
FooBar(
"bar1",
"bar2",
) {
// body
}
class Foo2(
val bar1: Bar,
val bar2: Bar,
) : FooBar(bar1, bar2),
) : FooBar(
bar1,
bar2
),
BarFoo1,
BarFoo2 {
// body
Expand Down

0 comments on commit e6ff69a

Please sign in to comment.