load all RuleSetProviderV3 from the classpath in ktlint 49+ (#698)

fixes #697 and #695

test custom rule loading in ktlin 0.50.0 by updating sample project

To Test: Edit Main.kt in the kotlin-rulesets-using projects according to inline comment, then
run ./gradlew samples:kotlin-rulesets-using:build

update root kotlin version to 1.8 since ktlint requires this
update android plugin to 4.1.3

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
 
+-   Fix custom rulesets not loading from classpath [#698](https://github.com/JLLeitschuh/ktlint-gradle/pull/698)
 -   update latest version text file manually [#688](https://github.com/JLLeitschuh/ktlint-gradle/pull/688)
 
 ## [11.5.0] - 2023-07-03

plugin/src/adapter49/kotlin/org/jlleitschuh/gradle/ktlint/worker/KtLintInvocation49.kt

@@ -1,21 +1,30 @@
 package org.jlleitschuh.gradle.ktlint.worker
 
+import com.pinterest.ktlint.cli.ruleset.core.api.RuleSetProviderV3
 import com.pinterest.ktlint.rule.engine.api.Code
 import com.pinterest.ktlint.rule.engine.api.KtLintRuleEngine
 import com.pinterest.ktlint.rule.engine.api.LintError
-import com.pinterest.ktlint.ruleset.standard.StandardRuleSetProvider
+import com.pinterest.ktlint.rule.engine.core.api.RuleProvider
 import java.io.File
+import java.util.ServiceLoader
 
 class KtLintInvocation49(
     private val engine: KtLintRuleEngine
 ) : KtLintInvocation {
     companion object Factory : KtLintInvocationFactory {
         fun initialize(): KtLintInvocation {
             val engine = KtLintRuleEngine(
-                ruleProviders = StandardRuleSetProvider().getRuleProviders()
+                ruleProviders = loadRuleSetsFromClasspathWithRuleSetProviderV3()
             )
             return KtLintInvocation49(engine)
         }
+
+        private fun loadRuleSetsFromClasspathWithRuleSetProviderV3(): Set<RuleProvider> {
+            return ServiceLoader
+                .load(RuleSetProviderV3::class.java)
+                .flatMap { it.getRuleProviders() }
+                .toSet()
+        }
     }
 
     override fun invokeLint(file: File): LintErrorResult {

plugin/src/adapter50/kotlin/org/jlleitschuh/gradle/ktlint/worker/KtLintInvocation50.kt

@@ -1,21 +1,30 @@
 package org.jlleitschuh.gradle.ktlint.worker
 
+import com.pinterest.ktlint.cli.ruleset.core.api.RuleSetProviderV3
 import com.pinterest.ktlint.rule.engine.api.Code
 import com.pinterest.ktlint.rule.engine.api.KtLintRuleEngine
 import com.pinterest.ktlint.rule.engine.api.LintError
-import com.pinterest.ktlint.ruleset.standard.StandardRuleSetProvider
+import com.pinterest.ktlint.rule.engine.core.api.RuleProvider
 import java.io.File
+import java.util.ServiceLoader
 
 class KtLintInvocation50(
     private val engine: KtLintRuleEngine
 ) : KtLintInvocation {
     companion object Factory : KtLintInvocationFactory {
         fun initialize(): KtLintInvocation {
             val engine = KtLintRuleEngine(
-                ruleProviders = StandardRuleSetProvider().getRuleProviders()
+                ruleProviders = loadRuleSetsFromClasspathWithRuleSetProviderV3()
             )
             return KtLintInvocation50(engine)
         }
+
+        private fun loadRuleSetsFromClasspathWithRuleSetProviderV3(): Set<RuleProvider> {
+            return ServiceLoader
+                .load(RuleSetProviderV3::class.java)
+                .flatMap { it.getRuleProviders() }
+                .toSet()
+        }
     }
 
     override fun invokeLint(file: File): LintErrorResult {

samples/kotlin-js/gradle.properties

@@ -0,0 +1 @@
+kotlin.js.compiler=ir

samples/kotlin-mpp/gradle.properties

@@ -0,0 +1 @@
+kotlin.js.compiler=ir

samples/kotlin-rulesets-creating/build.gradle.kts

@@ -6,5 +6,5 @@ plugins {
 dependencies {
     compileOnly(pluginLibs.kotlin.reflect)
     compileOnly(pluginLibs.kotlin.script.runtime)
-    compileOnly(pluginLibs.ktlint.core)
+    compileOnly("com.pinterest.ktlint:ktlint-cli-ruleset-core:0.50.0")
 }

samples/kotlin-rulesets-creating/src/main/kotlin/org/jlleitschuh/gradle/ktlint/sample/kotlin/CustomRuleSetProvider.kt

@@ -1,9 +1,12 @@
 package org.jlleitschuh.gradle.ktlint.sample.kotlin
 
-import com.pinterest.ktlint.core.RuleSet
-import com.pinterest.ktlint.core.RuleSetProvider
+import com.pinterest.ktlint.cli.ruleset.core.api.RuleSetProviderV3
+import com.pinterest.ktlint.rule.engine.core.api.RuleProvider
+import com.pinterest.ktlint.rule.engine.core.api.RuleSetId
 
-class CustomRuleSetProvider : RuleSetProvider {
+class CustomRuleSetProvider : RuleSetProviderV3(RuleSetId("custom")) {
 
-    override fun get(): RuleSet = RuleSet("custom", NoVarRule())
+    override fun getRuleProviders(): Set<RuleProvider> {
+        return setOf(RuleProvider { NoVarRule() })
+    }
 }

samples/kotlin-rulesets-creating/src/main/kotlin/org/jlleitschuh/gradle/ktlint/sample/kotlin/NoVarRule.kt

@@ -1,13 +1,17 @@
 package org.jlleitschuh.gradle.ktlint.sample.kotlin
 
-import com.pinterest.ktlint.core.Rule
+import com.pinterest.ktlint.rule.engine.core.api.Rule
+import com.pinterest.ktlint.rule.engine.core.api.RuleId
 import org.jetbrains.kotlin.com.intellij.lang.ASTNode
 import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.LeafPsiElement
 import org.jetbrains.kotlin.com.intellij.psi.util.PsiTreeUtil.getNonStrictParentOfType
 import org.jetbrains.kotlin.psi.KtStringTemplateEntry
 
-class NoVarRule : Rule("no-var") {
-    override fun visit(
+class NoVarRule : Rule(
+    RuleId("test:novar"),
+    About()
+) {
+    override fun beforeVisitChildNodes(
         node: ASTNode,
         autoCorrect: Boolean,
         emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit

samples/kotlin-rulesets-using/build.gradle.kts

@@ -15,6 +15,7 @@ dependencies {
 }
 
 ktlint {
+    version.set("0.50.0")
     verbose.set(true)
     outputToConsole.set(true)
     reporters {

settings.gradle.kts

@@ -4,8 +4,8 @@ pluginManagement {
     includeBuild("./plugin")
 
     plugins {
-        id("org.jetbrains.kotlin.jvm") version "1.5.31"
-        id("org.jetbrains.kotlin.js") version "1.5.31"
+        id("org.jetbrains.kotlin.jvm") version "1.8.22"
+        id("org.jetbrains.kotlin.js") version "1.8.22"
     }
 
     repositories {
@@ -18,7 +18,7 @@ pluginManagement {
         eachPlugin {
             when (requested.id.id) {
                 "com.android.application" ->
-                    useModule("com.android.tools.build:gradle:4.1.0")
+                    useModule("com.android.tools.build:gradle:4.1.3")
             }
         }
     }