I'd like to integrate KtLint into Gradle. Do you r...

# gradle

[Edoardo Luppi]

I'd like to integrate KtLint into Gradle.
Do you recommend kotlinter-gradle or ktlint-gradle? How's your experience with them?

[wakingrufus]

i recommend ktlint-gradle, but I am biased, since I am one of the developers lol. the main benefit ktlint-gradle provides is that it is decoupled from the ktlint version. so you can configure ktlint-gradle to use any* version of the ktlint tool.

*within the supported version range for that version of ktlint-grade

[Eugen Martynov]

We run ktlint as part of detekt

[Edoardo Luppi]

Thanks @wakingrufus, biased answers are ok!
@Eugen Martynov interesting! So Detekt adds ktlint issues as part of its own report?

[wakingrufus]

dtekt has a feature to run ktlint as an extension of detekt

[Eugen Martynov]

It can also format your code

[Eugen Martynov]

https://detekt.dev/docs/rules/formatting/

[wakingrufus]

why does controlling the ktlint version matter, you ask? because ktlint sometimes drastically changes behavior between versions, it can be helpful to be able to control that version and upgrade on your own timeline while staying on the latest version of the gradle plugin

[Edoardo Luppi]

I did watch @gammax talk some time ago about Detekt and was really interested in using it for custom rules.
Do you recommend starting with it straight away?

[wakingrufus]

i use detekt along side ktlint-gradle

[wakingrufus]

and opt not to use the ktlint part of detekt

[wakingrufus]

but detekt is really nice for its main function

[Edoardo Luppi]

and opt not to use the ktlint part of detekt

Any reason for that or just to keep it "clean"?

[wakingrufus]

and i dont know how it works, but intellij can autocomplete the detekt.yml

[wakingrufus]

the reason is because the ktlint-gradle plugin behaves how you would expect a tool plugin to work: setting tool version as explained above, using the worker api to break down work on a per file basis, etc. since detekt runs it as an extension of detekt, its not really like a first class gradle plugin

[Eugen Martynov]

In addition what John said - I can not find easily what ktlint version is used by detekt. Ktlint looks like got a major update recently with some breaking changes.

[Eugen Martynov]

Oke found at least for the latest https://github.com/detekt/detekt/blob/main/gradle/libs.versions.toml

[wakingrufus]

yeah ktlint did a lot of breaking changes recently in the lead up to 1.0. being able to support all of these versions of ktlint in the same version of the ktlint-gradle plugin was a lot of work, but I thought it was important because that is how things like pmd, checkstyle, etc work, so it should be true of the ktlint plugin as well

[wakingrufus]

and detekt and kotlinter have not done this (each version of the plugin is locked to a specific version of ktlint), so that is the main differentiator imo

[Eugen Martynov]

Correct, thanks for this question I also created ticket for the detekt https://github.com/detekt/detekt/issues/6515