Add support for multiple/runtime-specific versions of ktlint

[IvanPizhenko]

I have a code like this:

  val someVar = when (ctx.path()) {
      "/some/path/here" -> {
        println("hello")
      }
      else -> ctx.attribute<AttributeClassName>(Attributes.ATTRIBUTE_IDENTIFIER)
        ?: throw MyException("some error message")
    }
    println(someVar.toString())

IDE with installed ktlint plugin is happy with this code, i.e. doesn't put red marks.
But when I run my Gradle build, ktlint check compains at the same code:

SourceFileName.kt:123:13: Missing newline after "->"

I'm expecting that should plugin also detect this inconsistency, but actually it is not.

[IvanPizhenko]

Here is copy of my editorconfig (uploading as txt because github doesn't want to accept Linux hidden file attachment):
editorconfig.txt

[IvanPizhenko]

Here are some more IntelliJ configs (uploading as txt because github doesn't want to accept xml attachment):
codeStyleConfig.xml.txt
Project.xml.txt
ktlint.xml.txt

[nbadal]

Thanks for flagging this and for the sample files! I'll take a look today 😄

[nbadal]

@IvanPizhenko is it possible this is caused by #28 ? The workaround / way to test this would be to explicitly set the folder for your .editorconfig in the plugin settings.

I wasn't able to reproduce that ktlint error with a short example, but that message comes from the indent rule, so maybe it only gets triggered under more complex circumstances 🤔

[IvanPizhenko]

@nbadal Yes, I've faced #28, but I've configured explicit path to the editorconfig, you can see <editorConfigPath>$PROJECT_DIR$</editorConfigPath> in the attached ktlint.xml. So this one is already mitigated. I have the plugin generally working, but in this particular situation it doesn't work correctly.

[IvanPizhenko]

I will try to make it reproduced in a small sample project.

[IvanPizhenko]

Here is sample project https://github.com/IvanPizhenko/kotlin-sample-project

[IvanPizhenko]

Look here https://github.com/IvanPizhenko/kotlin-sample-project/blob/bb95c355aa5e78af4b2744b0d70fb080bc5c2282/module1/src/main/kotlin/org/example/Controller.kt#L15
In the IDE I don't see any "red signs". But when I run ./gradlew build ktlint error appears.

[nbadal]

Awesome, thank you! I'll make sure to distill this down into a test case as well once I've got that set up 😁

Looking into it now, then I'll publish a fix in 0.7.1 hopefully 🤞

[nbadal]

I think this may be due to the gradle ktlint plugin using ktlint 0.39.0, and my plugin using 0.40.0 – I'll have to verify this tomorrow morning, but using ktlint v0.40.0 on the command line directly also doesn't show the error that the gradle plugin does.

This might be fixed by pinterest/ktlint#901 ? Seems like a relevant entry in the 0.40.0 changelog
I'll get my hands on 0.39.0 in the morning to double check though!

[IvanPizhenko]

Tried setting ktlint version to 0.40.0 in the gradle - it worked.
But what we really need is to be able to set the same version of ktlint in the both gradle and IntelliJ plugin.
Can you please add such possibility? It could be this way: a checkbox and edit field in the plugin configuration page, like this

if checkbox is checked, specific version is used, otherwise - whatever default version you apply (I assume it checks for the latest version). This configuration should be saved in the ktlint.xml.

[nbadal]

That would be a nice feature – albeit a bit trickier to implement within the confines of the IDE plugin, but it might be possible!

I'll add it to the roadmap 😄

[alexfacciorusso]

@nbadal If you wouldn't mind, I could try finding some spare time to develop this feature and contribute to the plugin? I don't want to step on anyone else's toes if someone is already on it!

[nbadal]

@alexfacciorusso absolutely, take a stab at it!

[erikhuizinga]

I'm also interested in this feature. Until then, this plugin is probably not very UX friendly for me.

I specifically use https://github.com/JLLeitschuh/ktlint-gradle to simply run ktlint as Gradle tasks (e.g. ktlintCheck, ktlintFormat). If this IDEA plugin would allow setting the ktlint version or executable location, and if the ktlint Gradle plugin declares where its executable is located, then I could bridge the gap.

Wishful thinking: have your plugin detect the Gradle plugin and use its executable, even if it later updates to a newer version.

[IvanPizhenko]

Any chance to have it in the nearest next version?

[nbadal]

I haven't heard any progress from @alexfacciorusso - I can start to take a look at this again

[takanuva15]

I specifically use https://github.com/JLLeitschuh/ktlint-gradle to simply run ktlint as Gradle tasks (e.g. ktlintCheck, ktlintFormat). If this IDEA plugin would allow setting the ktlint version or executable location, and if the ktlint Gradle plugin declares where its executable is located, then I could bridge the gap.

Lol I read this and got a smile since I'm in the same boat. I maintain a different IntelliJ plugin that uses Kotlin and I use the same org.jlleitschuh.gradle.ktlint plugin for linting my kotlin files. By default, it's using ktlint v47 but this plugin uses ktlint v48 so they're out-of-sync. Would be nice to be able to specify the ktlint version as well.

@nbadal Could you point me to the class(es) I should look at which determine the version of ktlint that's downloaded? I've done plugin and UI work with IntelliJ's platform before so I could try poking around to see if I can make a custom version box of some kind work.

[paul-dingemans]

I have had a look at how this is done in ktlint-gradle plugin. My Gradle knowledge is too limited to get this working.

[paul-dingemans]

Next version of plugin supports ktlint versions 0.50.0, 1.0.1, 1.1.1 and 1.2.1.

[paul-dingemans]

This feature will be postponed. Current solution has unwanted side effect that size of plugin increases with 64MB per version of ktlint rules included. See #498.