Update ktlint to 1.5 (#164409)

Fixes https://github.com/flutter/flutter/issues/164408 Ready for review ~I think this pr is blocked by https://github.com/flutter/cocoon/pull/4275 uploading a new artifact.~ then someone with cipd-writers access running `cipd set-ref flutter/ktlint/linux-amd64 -ref version_1_5_0 -version <TBD ID>` where id comes from https://chrome-infra-packages.appspot.com/p/flutter/ktlint/linux-amd64 To check if I had writer permissions I ran `cipd acl-check flutter/android/sdk/all/ -writer` To request permissions use go/flutter-cipd-write (googler only) Successful run of linux analyze https://ci.chromium.org/ui/p/flutter/builders/try/Linux%20analyze/96415/overview ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing.
2025-06-03 00:51:18 +00:00 · 2025-03-03 14:39:23 -05:00 · 2025-03-03 14:39:23 -05:00 · 7ea4ac53f2
commit 7ea4ac53f2
parent ac7118832d
6 changed files with 54 additions and 48 deletions
--- a/.ci.yaml
+++ b/.ci.yaml
@ -374,7 +374,7 @@ targets:
      shard: analyze
      dependencies: >-
        [
-          {"dependency": "ktlint", "version": "version_1_1_1"}
+          {"dependency": "ktlint", "version": "version_1_5_0"}
        ]
      tags: >
        ["framework","hostonly","shard","linux"]
--- a/dev/benchmarks/multiple_flutters/android/app/src/main/java/dev/flutter/multipleflutters/MainActivity.kt
+++ b/dev/benchmarks/multiple_flutters/android/app/src/main/java/dev/flutter/multipleflutters/MainActivity.kt
@ -62,8 +62,7 @@ class MainActivity : FragmentActivity() {
                .add(
                    12345 + i,
                    flutterFragment
-                )
-                .commit()
+                ).commit()
        }
    }

--- a/examples/hello_world/android/build.gradle.kts
+++ b/examples/hello_world/android/build.gradle.kts
@ -13,10 +13,18 @@ allprojects {
    }
 }

-rootProject.layout.buildDirectory.value(rootProject.layout.buildDirectory.dir("../../build").get())
+rootProject.layout.buildDirectory.value(
+    rootProject.layout.buildDirectory
+        .dir("../../build")
+        .get()
+)

 subprojects {
-    project.layout.buildDirectory.value(rootProject.layout.buildDirectory.dir(project.name).get())
+    project.layout.buildDirectory.value(
+        rootProject.layout.buildDirectory
+            .dir(project.name)
+            .get()
+    )
 }
 subprojects {
    project.evaluationDependsOn(":app")
--- a/packages/flutter_tools/gradle/resolve_dependencies.gradle.kts
+++ b/packages/flutter_tools/gradle/resolve_dependencies.gradle.kts
@ -22,24 +22,24 @@ requireNotNull(flutterRoot) { "Flutter root directory not found!" }
 require(flutterRoot.isDirectory) { "Flutter root is not a valid directory!" }

 val engineVersion =
-    Paths.get(
-        flutterRoot.absolutePath,
-        "bin",
-        "cache",
-        "engine.stamp"
-    )
-        .toFile()
+    Paths
+        .get(
+            flutterRoot.absolutePath,
+            "bin",
+            "cache",
+            "engine.stamp"
+        ).toFile()
        .readText()
        .trim()

 var engineRealm =
-    Paths.get(
-        flutterRoot.absolutePath,
-        "bin",
-        "cache",
-        "engine.realm"
-    )
-        .toFile()
+    Paths
+        .get(
+            flutterRoot.absolutePath,
+            "bin",
+            "cache",
+            "engine.realm"
+        ).toFile()
        .readText()
        .trim()

--- a/packages/flutter_tools/gradle/src/main/kotlin/Deeplink.kt
+++ b/packages/flutter_tools/gradle/src/main/kotlin/Deeplink.kt
@ -5,7 +5,12 @@
 package com.flutter.gradle

 // TODO(gmackall): Identify which of these can be val instead of var.
-class Deeplink(var scheme: String?, var host: String?, var path: String?, var intentFilterCheck: IntentFilterCheck?) {
+class Deeplink(
+    var scheme: String?,
+    var host: String?,
+    var path: String?,
+    var intentFilterCheck: IntentFilterCheck?
+) {
    // TODO(gmackall): This behavior was kept identical to the original Groovy behavior as part of
    // the Groovy->Kotlin conversion, but should be changed once the conversion is complete.
    override fun equals(other: Any?): Boolean {
@ -21,7 +26,5 @@ class Deeplink(var scheme: String?, var host: String?, var path: String?, var in
            path == otherAsDeeplink.path
    }

-    override fun hashCode(): Int {
-        return scheme.hashCode() + host.hashCode() + path.hashCode()
-    }
+    override fun hashCode(): Int = scheme.hashCode() + host.hashCode() + path.hashCode()
 }
--- a/packages/flutter_tools/gradle/src/main/kotlin/DependencyVersionChecker.kt
+++ b/packages/flutter_tools/gradle/src/main/kotlin/DependencyVersionChecker.kt
@ -25,12 +25,11 @@ object DependencyVersionChecker {
    // The following messages represent best effort guesses at where a Flutter developer should
    // look to upgrade a dependency that is below the corresponding threshold. Developers can
    // change some of these locations, so they are not guaranteed to be accurate.
-    @VisibleForTesting internal fun getPotentialGradleFix(projectDirectory: String): String {
-        return "Your project's gradle version is typically " +
+    @VisibleForTesting internal fun getPotentialGradleFix(projectDirectory: String): String =
+        "Your project's gradle version is typically " +
            "defined in the gradle wrapper file. By default, this can be found at " +
            "$projectDirectory/gradle/wrapper/gradle-wrapper.properties. \n" +
            "For more information, see https://docs.gradle.org/current/userguide/gradle_wrapper.html.\n"
-    }

    // The potential java fix does not make use of the project directory,
    // so it left as a constant.
@ -40,8 +39,8 @@ object DependencyVersionChecker {
            "chooses which version of Java to use, see the --jdk-dir section of the " +
            "output of `flutter config -h`.\n"

-    @VisibleForTesting internal fun getPotentialAGPFix(projectDirectory: String): String {
-        return "Your project's AGP version is typically " +
+    @VisibleForTesting internal fun getPotentialAGPFix(projectDirectory: String): String =
+        "Your project's AGP version is typically " +
            "defined in the plugins block of the `settings.gradle` file " +
            "($projectDirectory/settings.gradle), by a plugin with the id of " +
            "com.android.application. \nIf you don't see a plugins block, your project " +
@ -49,17 +48,15 @@ object DependencyVersionChecker {
            "likely defined in the top-level build.gradle file " +
            "($projectDirectory/build.gradle) by the following line in the dependencies" +
            " block of the buildscript: \"classpath 'com.android.tools.build:gradle:<version>'\".\n"
-    }

-    @VisibleForTesting internal fun getPotentialKGPFix(projectDirectory: String): String {
-        return "Your project's KGP version is typically " +
+    @VisibleForTesting internal fun getPotentialKGPFix(projectDirectory: String): String =
+        "Your project's KGP version is typically " +
            "defined in the plugins block of the `settings.gradle` file " +
            "($projectDirectory/settings.gradle), by a plugin with the id of " +
            "org.jetbrains.kotlin.android. \nIf you don't see a plugins block, your project " +
            "was likely created with an older template version, in which case it is most " +
            "likely defined in the top-level build.gradle file " +
            "($projectDirectory/build.gradle) by the ext.kotlin_version property.\n"
-    }

    // The following versions define our support policy for Gradle, Java, AGP, and KGP.
    // Before updating any "error" version, ensure that you have updated the corresponding
@ -118,15 +115,14 @@ object DependencyVersionChecker {
    }

    // https://docs.gradle.org/current/kotlin-dsl/gradle/org.gradle.api/-java-version/index.html#-1790786897%2FFunctions%2F-1793262594
-    @VisibleForTesting internal fun getJavaVersion(): JavaVersion {
-        return JavaVersion.current()
-    }
+    @VisibleForTesting internal fun getJavaVersion(): JavaVersion = JavaVersion.current()

    @VisibleForTesting internal fun getAGPVersion(project: Project): AndroidPluginVersion? {
        val androidPluginVersion: AndroidPluginVersion? =
-            project.extensions.findByType(
-                AndroidComponentsExtension::class.java
-            )?.pluginVersion
+            project.extensions
+                .findByType(
+                    AndroidComponentsExtension::class.java
+                )?.pluginVersion
        return androidPluginVersion
    }

@ -162,26 +158,24 @@ object DependencyVersionChecker {
        versionString: String,
        errorVersion: String,
        potentialFix: String
-    ): String {
-        return "Error: Your project's $dependencyName version ($versionString) is lower " +
+    ): String =
+        "Error: Your project's $dependencyName version ($versionString) is lower " +
            "than Flutter's minimum supported version of $errorVersion. Please upgrade " +
            "your $dependencyName version. \nAlternatively, use the flag " +
            "\"--android-skip-build-dependency-validation\" to bypass this check.\n\n" +
            "Potential fix: $potentialFix"
-    }

    @VisibleForTesting internal fun getWarnMessage(
        dependencyName: String,
        versionString: String,
        warnVersion: String,
        potentialFix: String
-    ): String {
-        return "Warning: Flutter support for your project's $dependencyName version " +
+    ): String =
+        "Warning: Flutter support for your project's $dependencyName version " +
            "($versionString) will soon be dropped. Please upgrade your $dependencyName " +
            "version to a version of at least $warnVersion soon." +
            "\nAlternatively, use the flag \"--android-skip-build-dependency-validation\"" +
            " to bypass this check.\n\nPotential fix: $potentialFix"
-    }

    @VisibleForTesting internal fun checkGradleVersion(
        version: Version,
@ -292,7 +286,11 @@ object DependencyVersionChecker {
 // perform easy comparisons. All versions will have a major, minor, and patch value. These values
 // default to 0 when they are not provided or are otherwise unparseable.
 // For example the version strings "8.2", "8.2.2hfd", and "8.2.0" would parse to the same version.
-internal class Version(val major: Int, val minor: Int, val patch: Int) : Comparable<Version> {
+internal class Version(
+    val major: Int,
+    val minor: Int,
+    val patch: Int
+) : Comparable<Version> {
    companion object {
        fun fromString(version: String): Version {
            val asList: List<String> = version.split(".")
@ -318,9 +316,7 @@ internal class Version(val major: Int, val minor: Int, val patch: Int) : Compara
        return 0
    }

-    override fun toString(): String {
-        return "$major.$minor.$patch"
-    }
+    override fun toString(): String = "$major.$minor.$patch"
 }

 // Custom error for when the dependency_version_checker.kts script finds a dependency out of