Missing option to define length of a "long supertype list" in Class header #875

gilgoldzweig · 2020-08-30T10:12:11Z

Jetbrains Class header formatting coding conventions
They state that:

For multiple interfaces, the superclass constructor call should be located first and then each interface should be located in a different line

and provide a sample

class Person(
    id: Int,
    name: String,
    surname: String
) : Human(id, name),
    KotlinMaker { /*...*/ }

But they also state the following:

For classes with a long supertype list put a line break after the colon and align all supertype names horizontally

With the attached code sample

class MyFavouriteVeryLongClassHolder :
    MyLongHolder<MyFavouriteVeryLongClass>(),
    SomeOtherInterface,
    AndAnotherOne {

    fun foo() { /*...*/ }
}

But they don't mention what is considered a long supertype list and what is not, which means it should be opened for discussion and an option to change that number.
I personally would love to change the number of interfaces.

Another issue is that it's very hard to understand the issue with the current message:

Indentetation: Missing newline after ":"

I think it should have a proper message along the lines of

Long supertype list: Too many interfaces ($num$ / $max$), align all supertype names horizontally.

The text was updated successfully, but these errors were encountered:

nkiesel · 2020-11-18T19:58:10Z

I second this. I do not really know what exactly "too long" is, but I see constructors with 200+ characters in a single line which definitely is violating the style guide.

paul-dingemans · 2022-07-03T13:02:35Z

I second this. I do not really know what exactly "too long" is, but I see constructors with 200+ characters in a single line which definitely is violating the style guide.

The max-line-length rule will disallow such constructors if the corresponding .editorconfig property has been set. This issue should be solved as part of the bigger issue #1349.

…consistent format. In code style `ktlint_official`, super types are always wrapped to a separate line. In other code styles, super types are only wrapped in classes having multiple super types. Especially for code style `ktlint_official` the class headers are rewritten in a more consistent format. Closes #875 Closes #1349

paul-dingemans · 2023-07-09T13:52:39Z

The new class-signature will wrap the super types depending on the code style. For code style ktlint_official the super type will always be wrapped. For the other code styles, wrapping of the super type is done for classes having multiple super types or when exceeding the max_line_length.

Given input below:

class Foo {
    // body
}

class Foo() {
    // body
}

class Foo(val bar1: Bar) {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) {
    // body
}

class Foo : FooBar("bar") {
    // body
}

class Foo : FooBar("bar1", "bar2") {
    // body
}

class Foo : FooBar(
    "bar1",
    "bar2",
) {
    // body
}

class Foo :
    FooBar(
        "bar1",
        "bar2",
    ) {
    // body
}

class Foo(val bar1: Bar) : FooBar(bar1) {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(bar1) {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(bar1, bar2) {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(
    bar1,
    bar2,
) {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(
    bar1,
    bar2,
) {
    // body
}

class Foo : FooBar("bar"), BarFoo1, BarFoo2 {
    // body
}

class Foo : FooBar("bar1", "bar2"), BarFoo1, BarFoo2 {
    // body
}

class Foo : FooBar(
    "bar1",
    "bar2"
), BarFoo1, BarFoo2 {
    // body
}

class Foo : FooBar(
    "bar1",
    "bar2"
),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo :
    FooBar(
        "bar1",
        "bar2",
    ),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(bar1, bar2),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(
    bar1,
    bar2,
),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(
    bar1,
    bar2,
),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo
    constructor(
        val bar1: Bar,
        val bar2: Bar,
    ) : FooBar(bar1, bar2),
        BarFoo1,
        BarFoo2 {
    // body
}

will be formatted in ktlint_official as:

class Foo {
    // body
}

class Foo {
    // body
}

class Foo(
    val bar1: Bar,
) {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) {
    // body
}

class Foo : FooBar("bar") {
    // body
}

class Foo : FooBar("bar1", "bar2") {
    // body
}

class Foo :
    FooBar(
        "bar1",
        "bar2",
    ) {
    // body
}

class Foo :
    FooBar(
        "bar1",
        "bar2",
    ) {
    // body
}

class Foo(
    val bar1: Bar,
) : FooBar(bar1) {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(bar1) {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(bar1, bar2) {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(
        bar1,
        bar2,
    ) {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(
        bar1,
        bar2,
    ) {
    // body
}

class Foo :
    FooBar("bar"),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo :
    FooBar("bar1", "bar2"),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo :
    FooBar(
        "bar1",
        "bar2",
    ),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo :
    FooBar(
        "bar1",
        "bar2",
    ),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo :
    FooBar(
        "bar1",
        "bar2",
    ),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(bar1, bar2),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(
        bar1,
        bar2,
    ),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(
        bar1,
        bar2,
    ),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo
    constructor(
        val bar1: Bar,
        val bar2: Bar,
    ) : FooBar(bar1, bar2),
        BarFoo1,
        BarFoo2 {
    // body
}

while in code styles intellij_idea and android_studio it is formatted as:

class Foo {
    // body
}

class Foo {
    // body
}

class Foo(val bar1: Bar) {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) {
    // body
}

class Foo : FooBar("bar") {
    // body
}

class Foo : FooBar("bar1", "bar2") {
    // body
}

class Foo :
    FooBar(
        "bar1",
        "bar2",
    ) {
    // body
}

class Foo :
    FooBar(
        "bar1",
        "bar2",
    ) {
    // body
}

class Foo(val bar1: Bar) : FooBar(bar1) {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(bar1) {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(bar1, bar2) {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(
    bar1,
    bar2,
) {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(
    bar1,
    bar2,
) {
    // body
}

class Foo :
    FooBar("bar"),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo :
    FooBar("bar1", "bar2"),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo :
    FooBar(
        "bar1",
        "bar2",
    ),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo :
    FooBar(
        "bar1",
        "bar2",
    ),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo :
    FooBar(
        "bar1",
        "bar2",
    ),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(bar1, bar2),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(
    bar1,
    bar2,
),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(
    bar1,
    bar2,
),
    BarFoo1,
    BarFoo2 {
    // body
}

class Foo
constructor(
    val bar1: Bar,
    val bar2: Bar,
) : FooBar(bar1, bar2),
    BarFoo1,
    BarFoo2 {
    // body
}

* Add rule `class-signature`. This rule rewrites the class header to a consistent format. In code style `ktlint_official`, super types are always wrapped to a separate line. In other code styles, super types are only wrapped in classes having multiple super types. Especially for code style `ktlint_official` the class headers are rewritten in a more consistent format. Closes #875 Closes #1349 * Add disallowed comments locations for value argument, type argument, value parameter and type parameter lists so that the ClassSignatureRule does not need to check for this * Fix indentation for class having explicit constructor in ktlint_official code style

Tapchicoma added proposal new rule labels Aug 31, 2020

paul-dingemans added enhancement and removed proposal labels Feb 3, 2022

paul-dingemans added the class-signature rule label Nov 24, 2022

paul-dingemans added this to the 1.0 (Yeah!) milestone Apr 16, 2023

paul-dingemans self-assigned this Jul 3, 2023

paul-dingemans mentioned this issue Jul 9, 2023

Add rule class-signature #2119

Merged

9 tasks

paul-dingemans mentioned this issue Jul 9, 2023

Multiline class declaration with superclass + interface: Interface gets moved to newline #1713

Closed

paul-dingemans closed this as completed in #2119 Jul 21, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Missing option to define length of a "long supertype list" in Class header #875

Missing option to define length of a "long supertype list" in Class header #875

gilgoldzweig commented Aug 30, 2020 •

edited

nkiesel commented Nov 18, 2020

paul-dingemans commented Jul 3, 2022

paul-dingemans commented Jul 9, 2023

Missing option to define length of a "long supertype list" in Class header #875

Missing option to define length of a "long supertype list" in Class header #875

Comments

gilgoldzweig commented Aug 30, 2020 • edited

nkiesel commented Nov 18, 2020

paul-dingemans commented Jul 3, 2022

paul-dingemans commented Jul 9, 2023

gilgoldzweig commented Aug 30, 2020 •

edited