Fix issue #423: Configure ktlint classpath for custom tasks when no kotlin plugin is applied (#446)

- Moved task classpath configuration outside of plugin-specific block
- Fixed dependency issues by using individual ktlint dependencies
instead of CLI

Co-authored-by: Jeremy Mailen <[email protected]>
Co-authored-by: Claude <[email protected]>

Author: 3 people

README.md

@@ -25,7 +25,7 @@ Available on the Gradle Plugins Portal: https://plugins.gradle.org/plugin/org.jm
 
 ```kotlin
 plugins {
-    id("org.jmailen.kotlinter") version "5.0.1"
+    id("org.jmailen.kotlinter") version "5.0.2"
 }
 ```
 
@@ -36,7 +36,7 @@ plugins {
 
 ```groovy
 plugins {
-    id "org.jmailen.kotlinter" version "5.0.1"
+    id "org.jmailen.kotlinter" version "5.0.2"
 }
 ```
 
@@ -50,7 +50,7 @@ Root `build.gradle.kts`
 
 ```kotlin
 plugins {
-    id("org.jmailen.kotlinter") version "5.0.1" apply false
+    id("org.jmailen.kotlinter") version "5.0.2" apply false
 }
 ```
 
@@ -70,7 +70,7 @@ Root `build.gradle`
 
 ```groovy
 plugins {
-    id 'org.jmailen.kotlinter' version "5.0.1" apply false
+    id 'org.jmailen.kotlinter' version "5.0.2" apply false
 }
 ```
 

build.gradle.kts

@@ -22,7 +22,7 @@ val githubUrl = "https://github.com/jeremymailen/kotlinter-gradle"
 val webUrl = "https://github.com/jeremymailen/kotlinter-gradle"
 val projectDescription = "Lint and formatting for Kotlin using ktlint with configuration-free setup on JVM and Android projects"
 
-version = "5.0.1"
+version = "5.0.2"
 group = "org.jmailen.gradle"
 description = projectDescription
 

src/main/kotlin/org/jmailen/gradle/kotlinter/KotlinterPlugin.kt

@@ -35,18 +35,19 @@ class KotlinterPlugin : Plugin<Project> {
             registerPrePushHookTask()
         }
 
+        // Configure all tasks including custom user tasks regardless of which plugins are applied
+        // This ensures that custom tasks work even without a Kotlin plugin
+        tasks.withType(ConfigurableKtLintTask::class.java).configureEach { task ->
+            task.ktlintClasspath.from(ktlintConfiguration)
+        }
+
         // for known kotlin plugins, register tasks by convention.
         extendablePlugins.forEach { (pluginId, sourceResolver) ->
             pluginManager.withPlugin(pluginId) {
                 val lintKotlin = registerParentLintTask()
                 val formatKotlin = registerParentFormatTask()
 
                 registerSourceSetTasks(kotlinterExtension, sourceResolver, lintKotlin, formatKotlin)
-
-                // Configure all tasks including custom user tasks
-                tasks.withType(ConfigurableKtLintTask::class.java).configureEach { task ->
-                    task.ktlintClasspath.from(ktlintConfiguration)
-                }
             }
         }
     }
@@ -69,12 +70,21 @@ class KotlinterPlugin : Plugin<Project> {
             isCanBeConsumed = false
             isVisible = false
 
-            val dependencyProvider = provider {
-                // Even though we don't use CLI, it bundles all the runtime dependencies we need.
-                val ktlintVersion = kotlinterExtension.ktlintVersion
-                this@createKtLintConfiguration.dependencies.create("com.pinterest.ktlint:ktlint-cli:$ktlintVersion")
+            // Use individual ktlint dependencies rather than the CLI to avoid variant selection issues
+            val ktlintVersion = kotlinterExtension.ktlintVersion
+            val deps = listOf(
+                "com.pinterest.ktlint:ktlint-rule-engine:$ktlintVersion",
+                "com.pinterest.ktlint:ktlint-ruleset-standard:$ktlintVersion",
+                "com.pinterest.ktlint:ktlint-cli-reporter-core:$ktlintVersion",
+                "com.pinterest.ktlint:ktlint-cli-reporter-plain:$ktlintVersion",
+                "com.pinterest.ktlint:ktlint-cli-reporter-html:$ktlintVersion",
+                "com.pinterest.ktlint:ktlint-cli-reporter-checkstyle:$ktlintVersion",
+                "com.pinterest.ktlint:ktlint-cli-reporter-json:$ktlintVersion",
+                "com.pinterest.ktlint:ktlint-cli-reporter-sarif:$ktlintVersion",
+            )
+            deps.forEach { dep ->
+                dependencies.add(project.dependencies.create(dep))
             }
-            dependencies.addLater(dependencyProvider)
         }
         return configuration
     }

src/test/kotlin/org/jmailen/gradle/kotlinter/functional/CustomTaskTest.kt

@@ -1,5 +1,6 @@
 package org.jmailen.gradle.kotlinter.functional
 
+import org.gradle.testkit.runner.GradleRunner
 import org.gradle.testkit.runner.TaskOutcome
 import org.jmailen.gradle.kotlinter.functional.utils.editorConfig
 import org.jmailen.gradle.kotlinter.functional.utils.kotlinClass
@@ -256,4 +257,49 @@ class CustomTaskTest : WithGradleTest.Kotlin() {
             assertTrue(projectRoot.resolve("build/lint-report.txt").exists())
         }
     }
+
+    @Test
+    fun `ktLint custom task works without kotlin plugin applied`() {
+        // Create a new project directory without the kotlin plugin
+        val noKotlinProjectDir = File(testProjectDir.parentFile, "no-kotlin-project").apply {
+            mkdirs()
+        }
+
+        noKotlinProjectDir.resolve("settings.gradle") {
+            writeText(settingsFile)
+        }
+
+        noKotlinProjectDir.resolve("build.gradle") {
+            // language=groovy
+            val buildScript =
+                """
+                plugins {
+                    // No kotlin plugin applied
+                    id 'org.jmailen.kotlinter'
+                }
+                $repositories
+                
+                import org.jmailen.gradle.kotlinter.tasks.FormatTask
+                
+                task customFormatTask(type: FormatTask) {
+                    source files('src')
+                }
+                """
+            writeText(buildScript)
+        }
+
+        noKotlinProjectDir.resolve("src/main/kotlin/Simple.kt") {
+            writeText(kotlinClass("Simple"))
+        }
+
+        // Create a custom Gradle runner for this specific test
+        val runner = GradleRunner.create()
+            .withProjectDir(noKotlinProjectDir)
+            .withArguments("customFormatTask", "--stacktrace")
+            .withPluginClasspath()
+            .forwardOutput()
+
+        val result = runner.build()
+        assertEquals(TaskOutcome.SUCCESS, result.task(":customFormatTask")?.outcome)
+    }
 }