fixing bug with ktlint inclusion and adding dynamic version discovery

Author: ianbotsf

build-plugins/build-support/build.gradle.kts

@@ -20,7 +20,7 @@ repositories {
 dependencies {
     // make our custom lint rules available to the buildscript classpath
     runtimeOnly(project(":ktlint-rules")) {
-        // Ensure that kotlin-compiler-embeddable isn't included in the buildscript classpath in consuming modules
+        // Ensure that kotlin-compiler-embeddable isn't included in the buildscript classpath
         exclude(group = "org.jetbrains.kotlin", module = "kotlin-compiler-embeddable")
     }
 
@@ -40,7 +40,26 @@ gradlePlugin {
     }
 }
 
+val generateKtlintVersion by tasks.registering {
+    // generate the version of the runtime to use as a resource.
+    // this keeps us from having to manually change version numbers in multiple places
+    val resourcesDir = layout.buildDirectory.dir("resources/main/aws/sdk/kotlin/gradle/dsl").get()
+
+    val versionCatalog = rootProject.file("gradle/libs.versions.toml")
+    inputs.file(versionCatalog)
+
+    val versionFile = file("$resourcesDir/ktlint-version.txt")
+    outputs.file(versionFile)
+
+    val version = libs.ktlint.cli.ruleset.core.get().version
+    sourceSets.main.get().output.dir(resourcesDir)
+    doLast {
+        versionFile.writeText("$version")
+    }
+}
+
 tasks.withType<KotlinCompile> {
+    dependsOn(generateKtlintVersion)
     compilerOptions {
         jvmTarget.set(JvmTarget.JVM_1_8)
         freeCompilerArgs.add("-opt-in=kotlin.RequiresOptIn")

build-plugins/build-support/src/main/kotlin/aws/sdk/kotlin/gradle/dsl/CodeStyle.kt

@@ -18,21 +18,23 @@ import org.gradle.language.base.plugins.LifecycleBasePlugin
 fun Project.configureLinting(lintPaths: List<String>) {
     verifyRootProject { "Kotlin SDK lint configuration is expected to be configured on the root project" }
 
+    val ktlintVersion = object {} // Can't use Project.javaClass because that's using the Gradle classloader
+        .javaClass
+        .getResource("ktlint-version.txt")
+        ?.readText()
+        ?: error("Missing ktlint-version.txt")
+
     val ktlint by configurations.creating
 
     dependencies {
-        val ktlintVersion = "1.3.0"
         ktlint("com.pinterest.ktlint:ktlint-cli:$ktlintVersion") {
             attributes {
-                attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling.EXTERNAL))
+                attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling.SHADOWED))
             }
-
-            // Ensure that kotlin-compiler-embeddable isn't included in the buildscript classpath in consuming modules
-            exclude(group = "org.jetbrains.kotlin", module = "kotlin-compiler-embeddable")
         }
     }
 
-    // add the buildscript classpath which should pickup our custom ktlint-rules (via runtimeOnly dep on this plugin)
+    // add the buildscript classpath which should pick up our custom ktlint-rules (via runtimeOnly dep on this plugin)
     // plus any custom rules added by consumer
     val execKtlintClasspath = ktlint + buildscript.configurations.getByName("classpath")
 

build.gradle.kts

@@ -49,11 +49,8 @@ val ktlint by configurations.creating
 dependencies {
     ktlint(libs.ktlint.cli) {
         attributes {
-            attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling.EXTERNAL))
+            attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling.SHADOWED))
         }
-
-        // Ensure that kotlin-compiler-embeddable isn't included in the buildscript classpath
-        exclude(group = "org.jetbrains.kotlin", module = "kotlin-compiler-embeddable")
     }
 
     ktlint(project(":ktlint-rules"))

gradle/libs.versions.toml

@@ -1,5 +1,5 @@
 [versions]
-ktlint = "1.5.0"
+ktlint = "1.3.0"
 smithy-version = "1.53.0"
 smithy-gradle-plugin-version = "1.1.0"
 junit-version = "5.10.1"
@@ -16,4 +16,4 @@ smithy-gradle-base-plugin = { module = "software.amazon.smithy.gradle:smithy-bas
 junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit-version" }
 
 [plugins]
-plugin-publish = { id = "com.gradle.plugin-publish", version = "1.2.1"}
+plugin-publish = { id = "com.gradle.plugin-publish", version = "1.2.1"}