Comments above annotations are separated by the annotation with a blank line

[Vampire]

Given code like

val gradle = gradle as ExtensionAware
// work-around for https://youtrack.jetbrains.com/issue/KT-38871
// Kotlin 1.9+ and thus Gradle 8.3+ fixed it and no suppression is necessary anymore
@Suppress("UNUSED_VARIABLE")
val foo by gradle.extra {
    true
}

or

val gradle = gradle as ExtensionAware
/*
 * work-around for https://youtrack.jetbrains.com/issue/KT-38871
 * Kotlin 1.9+ and thus Gradle 8.3+ fixed it and no suppression is necessary anymore
 */
@Suppress("UNUSED_VARIABLE")
val foo by gradle.extra {
    true
}

If you reformat those snippets with default settings / empty editorconfig, in both cases there is a blank line added between the comment and the annotation, while I do not find any rule in the coding guidelines that suggests an annotation has to be preceeded by a blank line and it seems natural that those comments refer to the following line.

The rule triggering this is

Declarations and declarations with annotations should have an empty space between. (standard:spacing-between-declarations-with-annotations)

Your Environment

• Version of ktlint used: 1.0.1
• Relevant parts of the .editorconfig settings: nothing
• Name and version (or code for custom task) of integration used (Gradle plugin, Maven plugin, command line, custom Gradle task): CLI
• Operating System and version: Windows 10

[paul-dingemans]

I can not reproduce the problem with any of the code styles. Can you please run command like ktlint --log-level=debug **/Bar.kts (replace Bar.kts with your file) and post the output here?

[Vampire]

Ah sorry, the example was too minimal, I updated the original description

[paul-dingemans]

It looks like this behavior was added due to https://youtrack.jetbrains.com/issue/KT-35106. For backwards compatibilty this rule should be kept around.

When you run ktlint with formatting, you see output below:

src/main/kotlin/Foo.kt:2:1: Declarations and declarations with annotations should have an empty space between. (standard:spacing-between-declarations-with-annotations)
src/main/kotlin/Foo.kt:2:1: Declarations and declarations with comments should have an empty space between. (standard:spacing-between-declarations-with-comments)

Based on this output you can decide to disable the rule in the .editorconfig via property ktlint_standard_spacing-between-declarations-with-comments.

[Vampire]

But shouldn't the comment be above the comment, so like

val gradle = gradle as ExtensionAware

// work-around for https://youtrack.jetbrains.com/issue/KT-38871
// Kotlin 1.9+ and thus Gradle 8.3+ fixed it and no suppression is necessary anymore
@Suppress("UNUSED_VARIABLE")
val foo by gradle.extra {
    true
}

?

Having it like that upfront also makes ktlint happy and not change it.

[paul-dingemans]

Given that I provide code below:

val gradle = gradle as ExtensionAware
// work-around for https://youtrack.jetbrains.com/issue/KT-38871
// Kotlin 1.9+ and thus Gradle 8.3+ fixed it and no suppression is necessary anymore
@Suppress("UNUSED_VARIABLE")
val foo by gradle.extra {
    true
}

to ktlint command ktlint -F --stdin results in:

val gradle = gradle as ExtensionAware

// work-around for https://youtrack.jetbrains.com/issue/KT-38871
// Kotlin 1.9+ and thus Gradle 8.3+ fixed it and no suppression is necessary anymore
@Suppress("UNUSED_VARIABLE")
val foo by gradle.extra {
    true
}

So I am confused what you mean. Isn't this exactly what you expect?

[Vampire]

Yes, but not what I get.
I get

val gradle = gradle as ExtensionAware
// work-around for https://youtrack.jetbrains.com/issue/KT-38871
// Kotlin 1.9+ and thus Gradle 8.3+ fixed it and no suppression is necessary anymore

@Suppress("UNUSED_VARIABLE")
val foo by gradle.extra {
    true
}

[Vampire]

Argh, I'm really bad at knitting MCVEs today.
Don't have it top-level in a class but inside a method, sorry again.

[paul-dingemans]

Ok, now the bug can be reproduced with code:

fun foo() {
    val gradle = gradle as ExtensionAware
    // work-around for https://youtrack.jetbrains.com/issue/KT-38871
    // Kotlin 1.9+ and thus Gradle 8.3+ fixed it and no suppression is necessary anymore
    @Suppress("UNUSED_VARIABLE")
    val foo by gradle.extra {
        true
    }
}