Hey guys, a quick question. I would like to configure the KtLintExtension for KtLint so it filters o...

# ktlint

[Dieter Vaesen]

Hey guys, a quick question. I would like to configure the KtLintExtension for KtLint so it filters out certain folders. But I would like to configure this in one of my own ConventionPLugins in a BuildConfig module. But It seems like I don't have access to the KtLintExtension class.

I can do the following in my build.gradle.kts files but not in my plugin.
Am I doing something stupid? Or overseeing something?

configure<org.jlleitschuh.gradle.ktlint.KtlintExtension> {
  filter {
    exclude { it.file.path.contains("generated") }
  }
}

[Vampire]

What is the error you are get exactly? Optimally share it as build --scan URL

[Dieter Vaesen]

It's at compile time that i get the following Unresolved reference: jlleitschuh

[Dieter Vaesen]

Screenshot 2024-11-07 at 14.07.12.png

[Dieter Vaesen]

I find it weird that the class doesn't seem to be accessible my convention plugin.

[Vampire]

You probably miss to declare the plugin as dependency for your plugin in the build script of your plugin

[Dieter Vaesen]

Can I do this with compileOnly ? I tried that already but no luck. Probably doing something wrong

[Vampire]

Yes, compileOnly should also be fine, if the consumer will provide the plugin at runtime.
If your plugin also applies the plugin, it is usually better to use implementation.
But both should make the class available for compilation.
Do you get that also when you build from commandline (to rule out that it just isn't synced to IDE properly)

[Dieter Vaesen]

Yess I ran a ./gradlew --scan command and it gave the same error. But I'll try again what I tried earlier

[Dieter Vaesen]

So to give some more information. I have a build.gradle.kts in my build-logic module.
At the top i do the following

plugins {
  `kotlin-dsl`
   alias(libs.plugins.org.jlleitschuh.gradle.ktlint)
}

And lower in the file i do the following

dependencies {
  compileOnly(libs.android.gradlePlugin)
  compileOnly(libs.android.tools.common)
  compileOnly(libs.kotlin.gradlePlugin)
  compileOnly(libs.ksp.gradlePlugin)
  compileOnly(libs.plugins.org.jlleitschuh.gradle.ktlint)
}

[Vampire]

compileOnly(<http://libs.plugins.org|libs.plugins.org>.jlleitschuh.gradle.ktlint) this should not even compile. Can you share a full MCVE?

[Dieter Vaesen]

I made a MRE I added //KTLINT-TEST comments above the lines where my logic is and where i want to change things so you can search quickly

[Dieter Vaesen]

Sorry forgot something. This one is testable

KtlintTest_V2.zip

[Dieter Vaesen]

It's indeed not compiling. But I just want to know how i can use the plugin as a dependency 🙂

[Vampire]

Actually it should compile but fail at build script runtime.

But anyway, for that question, there is https://github.com/gradle/gradle/issues/17963 including work-arounds

[Dieter Vaesen]

thanks @Vampire! Couldn't find anything but this saved my day