Applying ktlint-gradle from my own plugin

[nanodeath]

Hi,

I have my own Gradle plugin (internally used at my company) that I want to use to apply ktlint-gradle. However...this is giving me quite a lot of trouble. I'm curious if anyone else has done this and has an example to share.

The closest I've gotten is this:

If I add this to my plugin's build.gradle:

dependencies {
    runtimeOnly("org.jlleitschuh.gradle:ktlint-gradle:10.1.0")
}

and this to my main apply method:

project.plugins.apply("org.jlleitschuh.gradle.ktlint")

it successfully finds the plugin, but then crashes:

FAILURE: Build failed with an exception.

* What went wrong:
org/jetbrains/kotlin/gradle/dsl/KotlinProjectExtension

* Try:
Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Exception is:
java.lang.NoClassDefFoundError: org/jetbrains/kotlin/gradle/dsl/KotlinProjectExtension
        at org.jlleitschuh.gradle.ktlint.KtlintPlugin$applyKtLint$1$1.execute(KtlintPlugin.kt:18)
        at org.gradle.internal.extensibility.ExtensionsStorage$ExtensionHolder.configure(ExtensionsStorage.java:173)
        at org.gradle.internal.extensibility.ExtensionsStorage.configureExtension(ExtensionsStorage.java:64)
        at org.gradle.internal.extensibility.DefaultConvention.configure(DefaultConvention.java:194)
        at org.jlleitschuh.gradle.ktlint.KtlintPlugin$applyKtLint$1.invoke(KtlintPlugin.kt:83)
        at org.jlleitschuh.gradle.ktlint.KtlintPlugin$applyKtLint$1.invoke(KtlintPlugin.kt:18)
        at org.jlleitschuh.gradle.ktlint.KtlintPlugin$sam$org_gradle_api_Action$0.execute(KtlintPlugin.kt)

Thoughts?

[Tapchicoma]

Most probably related to #253 and how Gradle separates classpathes. The fix may be to also add Kotlin Gradle plugin as a runtimeOnly dependency.

[nanodeath]

With that proposed workaround I get this exception instead:

Caused by: org.gradle.internal.metaobject.AbstractDynamicObject$CustomMessageMissingMethodException: Could not find method kotlinter() for arguments ...

which is unfortunate.

Thankfully I did find a circuitous way to make this work: script plugins!
if I create a file src/main/groovy/kotlinter.gradle with contents

plugins {
    id "org.jmailen.kotlinter"
}

and then

project.plugins.apply("kotlinter")

from my main plugin, things work just fine.

Weird, right? I don't even need to add any dependencies, it's just that one file and other line of code.

In my actual code it's namespaced by my company name to avoid possible collisions.

[nanodeath]

Well, I should say it kind of works. If I try to refer to any of the Kotlinter* classes from my code, I either have to say compileOnly kotlinter, at which point it panics about missing kotlin gradle types, or if I add kotlin-gradle-plugin, it panics about not being able to apply the kotlin-jvm plugin twice. So...still some major rough edges I'm working through.

[nanodeath]

Also I keep getting ktlint-gradle and kotlinter confused :/ so...feel free to disregard this if it doesn't make sense any more :)