feedback

Author: 0marperez

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

@@ -40,7 +40,7 @@ fun Project.configureLinting(lintPaths: List<String>) {
                 attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling.SHADOWED))
             }
         }
-        ktlint("aws.sdk.kotlin.gradle:ktlint-rules:$repoToolsVersion")
+        ktlint("aws.sdk.kotlin.gradle:style:$repoToolsVersion")
     }
 
     // add the buildscript classpath which should pick up our custom ktlint-rules (via runtimeOnly dep on this plugin)

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

@@ -7,9 +7,11 @@ package aws.sdk.kotlin.gradle.dsl
 
 import aws.sdk.kotlin.gradle.util.verifyRootProject
 import org.gradle.api.Project
+import org.gradle.api.artifacts.VersionCatalogsExtension
 import org.gradle.api.attributes.Bundling
 import org.gradle.api.tasks.JavaExec
 import org.gradle.kotlin.dsl.*
+import org.gradle.kotlin.dsl.getByType
 import org.gradle.language.base.plugins.LifecycleBasePlugin
 
 /**
@@ -24,6 +26,13 @@ fun Project.configureMinorVersionStrategyRules(lintPaths: List<String>) {
         ?.readText()
         ?: error("Missing ktlint-version.txt")
 
+    val repoToolsVersion = extensions
+        .getByType<VersionCatalogsExtension>()
+        .named("libs")
+        .findVersion("aws-kotlin-repo-tools-version")
+        .get()
+        .requiredVersion
+
     val minorVersionBumpKtlint by configurations.creating
 
     dependencies {
@@ -32,7 +41,7 @@ fun Project.configureMinorVersionStrategyRules(lintPaths: List<String>) {
                 attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling.SHADOWED))
             }
         }
-        minorVersionBumpKtlint(project(":ktlint-rules:minor-version-strategy"))
+        minorVersionBumpKtlint("aws.sdk.kotlin.gradle:minor-version-rules:$repoToolsVersion")
     }
 
     tasks.register<JavaExec>("verifyMinorVersionBump") {
@@ -42,13 +51,4 @@ fun Project.configureMinorVersionStrategyRules(lintPaths: List<String>) {
         mainClass.set("com.pinterest.ktlint.Main")
         args = lintPaths
     }
-
-    tasks.register<JavaExec>("fixMinorVersionBump") {
-        group = LifecycleBasePlugin.VERIFICATION_GROUP
-        description = "Auto fix minor version bump rules"
-        classpath = minorVersionBumpKtlint
-        mainClass.set("com.pinterest.ktlint.Main")
-        args = listOf("-F") + lintPaths
-        jvmArgs("--add-opens=java.base/java.lang=ALL-UNNAMED")
-    }
 }

build.gradle.kts

@@ -59,7 +59,7 @@ dependencies {
         }
     }
 
-    ktlint(project(":ktlint-rules"))
+    ktlint(project(":ktlint:style-rules"))
 }
 
 val lintPaths = listOf(

gradle/libs.versions.toml

@@ -9,21 +9,18 @@ smithy-version = "1.60.2"
 smithy-gradle-plugin-version = "1.3.0"
 junit-version = "5.10.1"
 coroutines-version = "1.10.2"
-slf4j = "2.0.17"
 
 [libraries]
 aws-sdk-cloudwatch = { module = "aws.sdk.kotlin:cloudwatch", version.ref = "aws-sdk-version" }
 aws-sdk-s3 = { module = "aws.sdk.kotlin:s3", version.ref = "aws-sdk-version" }
 ktlint-cli = { module = "com.pinterest.ktlint:ktlint-cli", version.ref = "ktlint" }
 ktlint-cli-ruleset-core = { module = "com.pinterest.ktlint:ktlint-cli-ruleset-core", version.ref = "ktlint" }
-ktlint-rule-engine = { module = "com.pinterest.ktlint:ktlint-rule-engine", version.ref = "ktlint" }
 nexus-publish-plugin = { module = "io.github.gradle-nexus:publish-plugin", version.ref = "nexus-plugin-version" }
 jreleaser-plugin = { module = "org.jreleaser:jreleaser-gradle-plugin", version.ref = "jreleaser-plugin-version" }
 smithy-model = { module = "software.amazon.smithy:smithy-model", version.ref = "smithy-version" }
 smithy-gradle-base-plugin = { module = "software.amazon.smithy.gradle:smithy-base", version.ref = "smithy-gradle-plugin-version" }
 junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit-version" }
 kotlinx-coroutines-test = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "coroutines-version" }
-slf4j-simple = { module = "org.slf4j:slf4j-simple", version.ref = "slf4j" }
 
 [plugins]
 kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin-version" }

ktlint-rules/src/main/kotlin/software/aws/ktlint/rules/DeprecatedApiRule.kt

@@ -5,7 +5,7 @@
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
-description = "Lint rules for the AWS SDK for Kotlin"
+description = "Lint rules for minor version bumps"
 
 plugins {
     `maven-publish`
@@ -16,15 +16,13 @@ kotlin {
     sourceSets {
         main {
             dependencies {
-                api(libs.ktlint.cli.ruleset.core)
+                implementation(libs.ktlint.cli.ruleset.core)
             }
         }
 
         test {
             dependencies {
                 implementation(kotlin("test"))
-                implementation(libs.ktlint.rule.engine)
-                implementation(libs.slf4j.simple) // Required by ktlint rule engine tests
             }
         }
     }

ktlint-rules/src/test/kotlin/software/aws/ktlint/rules/DeprecatedApiRuleTest.kt

@@ -0,0 +1,46 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package software.aws.ktlint.rules
+
+import com.pinterest.ktlint.rule.engine.core.api.ElementType
+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
+
+/**
+ * Matches @DeprecatedUntilVersion with either named args (major=x, minor=y) or positional args (x, y)
+ */
+internal fun deprecatedUntilVersionRegex(major: Int, minor: Int): Regex =
+    Regex(
+        """@DeprecatedUntilVersion\s*\(\s*(?:major\s*=\s*$major\s*,\s*minor\s*=\s*$minor\s*|\s*$major\s*,\s*$minor\s*)\s*\)""",
+    )
+
+/**
+ * Creates a ktlint rule that detects APIs annotated with @DeprecatedUntilVersion for the specified versions.
+ * If autocorrect is enabled, the API will be deleted.
+ */
+class DeprecatedApiRule : Rule(RuleId("minor-version-strategy-rules:deprecated-apis"), About()) {
+    override fun beforeVisitChildNodes(
+        node: ASTNode,
+        autoCorrect: Boolean,
+        emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit,
+    ) {
+        if (node.elementType == ElementType.ANNOTATION_ENTRY) {
+            val sdkVersion = System.getProperty("sdkVersion").split(".")
+            val majorVersion = sdkVersion[0].toInt()
+            val minorVersion = sdkVersion[1].toInt()
+
+            val regex = deprecatedUntilVersionRegex(majorVersion, minorVersion + 1)
+            if (regex.containsMatchIn(node.text)) {
+                emit(
+                    node.startOffset,
+                    "The deprecated API is scheduled for removal, please remove it before releasing the next minor version.",
+                    true,
+                )
+            }
+        }
+    }
+}

ktlint-rules/build.gradle.kts renamed to ktlint/minor-version-rules/build.gradle.kts

@@ -0,0 +1,15 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package software.aws.ktlint.rules
+
+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 MinorVersionRuleSetProvider : RuleSetProviderV3(RuleSetId("minor-version-strategy-rules")) {
+    override fun getRuleProviders() = setOf(
+        RuleProvider { DeprecatedApiRule() },
+    )
+}

ktlint/minor-version-rules/src/main/kotlin/software/aws/ktlint/rules/DeprecatedApiRule.kt

@@ -0,0 +1,4 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+software.aws.ktlint.rules.MinorVersionRuleSetProvider