Merge pull request #892 from square/rick/ktlint_kotlinter

update KtLint to 0.47.1 and switch KtLint-gradle to Kotlinter

Author: RBusarow

.editorconfig

@@ -484,6 +484,8 @@ ij_groovy_while_on_new_line = false
 ij_groovy_wrap_long_lines = false
 
 [{*.gradle.kts,*.kt,*.kts,*.main.kts}]
+# noinspection EditorConfigKeyCorrectness
+ktlint_disabled_rules = trailing-comma-on-declaration-site,trailing-comma-on-call-site
 ij_continuation_indent_size = 2
 ij_kotlin_align_in_columns_case_branch = false
 ij_kotlin_align_multiline_binary_operation = false

.github/workflows/kotlin.yml

@@ -90,7 +90,7 @@ jobs :
         name : Check with Gradle
         with :
           arguments : |
-            allTests test apiCheck checkVersionIsSnapshot dependencyGuard lint ktlintCheck jvmWorkflowNodeBenchmarkJar --stacktrace --continue
+            allTests test apiCheck checkVersionIsSnapshot dependencyGuard lint lintKotlin jvmWorkflowNodeBenchmarkJar --stacktrace --continue
           cache-read-only: false
 
       # Report as Github Pull Request Check.

benchmarks/performance-poetry/complex-poetry/src/main/java/com/squareup/benchmarks/performance/complex/poetry/PerformancePoemWorkflow.kt

@@ -64,6 +64,7 @@ class PerformancePoemWorkflow(
 
   sealed class State {
     val isLoading: Boolean = false
+
     // N.B. This state is a smell. We include it to be able to mimic smells
     // we encounter in real life. Best practice would be to fold it
     // into [Selected(NO_SELECTED_STANZA)] at the very least.
@@ -85,9 +86,13 @@ class PerformancePoemWorkflow(
     props: Poem,
     snapshot: Snapshot?
   ): State {
-    return if (simulatedPerfConfig.useInitializingState) Initializing else Selected(
-      NO_SELECTED_STANZA
-    )
+    return if (simulatedPerfConfig.useInitializingState) {
+      Initializing
+    } else {
+      Selected(
+        NO_SELECTED_STANZA
+      )
+    }
   }
 
   @OptIn(WorkflowUiExperimentalApi::class)
@@ -174,23 +179,26 @@ class PerformancePoemWorkflow(
         }
 
         val previousStanzas: List<StanzaScreen> =
-          if (stanzaIndex == NO_SELECTED_STANZA) emptyList()
-          else renderProps.stanzas.subList(0, stanzaIndex)
-            .mapIndexed { index, _ ->
-              context.renderChild(
-                StanzaWorkflow,
-                Props(
-                  poem = renderProps,
-                  index = index,
-                  eventHandlerTag = ActionHandlingTracingInterceptor::keyForTrace
-                ),
-                key = "$index"
-              ) {
-                noAction()
+          if (stanzaIndex == NO_SELECTED_STANZA) {
+            emptyList()
+          } else {
+            renderProps.stanzas.subList(0, stanzaIndex)
+              .mapIndexed { index, _ ->
+                context.renderChild(
+                  StanzaWorkflow,
+                  Props(
+                    poem = renderProps,
+                    index = index,
+                    eventHandlerTag = ActionHandlingTracingInterceptor::keyForTrace
+                  ),
+                  key = "$index"
+                ) {
+                  noAction()
+                }
+              }.map { originalStanzaScreen ->
+                originalStanzaScreen
               }
-            }.map { originalStanzaScreen ->
-              originalStanzaScreen
-            }
+          }
 
         val visibleStanza =
           if (stanzaIndex == NO_SELECTED_STANZA) {

benchmarks/performance-poetry/complex-poetry/src/main/java/com/squareup/benchmarks/performance/complex/poetry/PerformancePoemsBrowserWorkflow.kt

@@ -102,12 +102,12 @@ class PerformancePoemsBrowserWorkflow(
       // Don't try this at home.
       is Initializing -> {
         context.runningWorker(TraceableWorker.from("BrowserInitializing") { Unit }, "init") {
-        isLoading.value = true
-        action {
-          isLoading.value = false
-          state = NoSelection
+          isLoading.value = true
+          action {
+            isLoading.value = false
+            state = NoSelection
+          }
         }
-      }
         return OverviewDetailScreen(overviewRendering = BackStackScreen(BlankScreen))
       }
       is NoSelection -> {

benchmarks/performance-poetry/complex-poetry/src/main/java/com/squareup/benchmarks/performance/complex/poetry/PerformancePoetryActivity.kt

@@ -261,7 +261,8 @@ class PoetryModel(
   interceptor: WorkflowInterceptor?,
   runtimeConfig: RuntimeConfig
 ) : ViewModel() {
-  @OptIn(WorkflowUiExperimentalApi::class) val renderings: StateFlow<Screen> by lazy {
+  @OptIn(WorkflowUiExperimentalApi::class)
+  val renderings: StateFlow<Screen> by lazy {
     renderWorkflowIn(
       workflow = workflow,
       scope = viewModelScope,

build.gradle.kts

@@ -1,6 +1,5 @@
+import com.squareup.workflow1.buildsrc.applyKtLint
 import org.jetbrains.dokka.gradle.DokkaTask
-import org.jlleitschuh.gradle.ktlint.KtlintExtension
-import org.jlleitschuh.gradle.ktlint.reporter.ReporterType
 
 buildscript {
   dependencies {
@@ -11,7 +10,6 @@ buildscript {
     classpath(libs.kotlinx.binaryCompatibility.gradle.plugin)
     classpath(libs.kotlin.gradle.plugin)
     classpath(libs.google.ksp)
-    classpath(libs.ktlint.gradle)
     classpath(libs.vanniktech.publish)
   }
 
@@ -32,26 +30,17 @@ plugins {
 
 subprojects {
 
-  apply(plugin = "org.jlleitschuh.gradle.ktlint")
   afterEvaluate {
     configurations.configureEach {
       // There could be transitive dependencies in tests with a lower version. This could cause
       // problems with a newer Kotlin version that we use.
       resolutionStrategy.force(libs.kotlin.reflect)
     }
   }
-
-  // Configuration documentation: https://github.com/JLLeitschuh/ktlint-gradle#configuration
-  configure<KtlintExtension> {
-    // Prints the name of failed rules.
-    verbose.set(true)
-    reporters {
-      // Default "plain" reporter is actually harder to read.
-      reporter(ReporterType.JSON)
-    }
-  }
 }
 
+applyKtLint()
+
 apply(from = rootProject.file(".buildscript/binary-validation.gradle"))
 
 // This plugin needs to be applied to the root projects for the dokkaGfmCollector task we use to

buildSrc/build.gradle.kts

@@ -1,4 +1,4 @@
-@Suppress("UnstableApiUsage")
+@Suppress("DSL_SCOPE_VIOLATION")
 plugins {
   `kotlin-dsl`
   alias(libs.plugins.google.ksp)
@@ -7,6 +7,7 @@ plugins {
 repositories {
   mavenCentral()
   google()
+  maven("https://plugins.gradle.org/m2/")
 }
 
 dependencies {
@@ -19,6 +20,8 @@ dependencies {
   implementation(libs.dokka.gradle.plugin)
   implementation(libs.dropbox.dependencyGuard)
   implementation(libs.kotlin.gradle.plugin)
+  implementation(libs.ktlint.core)
+  implementation(libs.kotlinter)
   implementation(libs.squareup.moshi)
   implementation(libs.squareup.moshi.adapters)
   implementation(libs.vanniktech.publish)

buildSrc/src/main/java/com/squareup/workflow1/buildsrc/KotlinCommonSettings.kt

@@ -15,6 +15,8 @@ fun Project.kotlinCommonSettings(
   bomConfigurationName: String
 ) {
 
+  applyKtLint()
+
   // force the same Kotlin version everywhere, including transitive dependencies
   dependencies {
     bomConfigurationName(platform(kotlin("bom")))

buildSrc/src/main/java/com/squareup/workflow1/buildsrc/ktlint.kt

@@ -0,0 +1,77 @@
+package com.squareup.workflow1.buildsrc
+
+import org.gradle.api.Project
+import org.gradle.api.tasks.TaskContainer
+import org.jmailen.gradle.kotlinter.tasks.ConfigurableKtLintTask
+import org.jmailen.gradle.kotlinter.tasks.FormatTask
+import org.jmailen.gradle.kotlinter.tasks.LintTask
+
+/**
+ * Applies Kotlinter settings to any project, with additional tasks for the root project.
+ *
+ * @since 0.10.0
+ */
+fun Project.applyKtLint() {
+  pluginManager.apply("org.jmailen.kotlinter")
+
+  tasks.withType(LintTask::class.java) {
+    ignoreFailures.set(false)
+    mustRunAfter(tasks.withType(FormatTask::class.java))
+  }
+
+  if (project == rootProject) {
+    tasks.register("lintKotlin")
+    tasks.register("formatKotlin")
+    afterEvaluate {
+      addGradleScriptTasks(tasks, taskNameQualifier = "")
+    }
+  }
+
+  // dummy ktlint-gradle plugin task names which just delegate to the Kotlinter ones
+  tasks.register("ktlintCheck") {
+    dependsOn(tasks.withType(LintTask::class.java))
+  }
+  tasks.register("ktlintFormat") {
+    dependsOn(tasks.withType(FormatTask::class.java))
+  }
+}
+
+// Add check/format tasks to each root project (including child root projects) which target every
+// `build.gradle.kts` and `settings.gradle.kts` file within that project group.
+private fun Project.addGradleScriptTasks(
+  taskContainer: TaskContainer,
+  taskNameQualifier: String = ""
+) {
+  val includedProjectScriptFiles = allprojects
+    .flatMap { included ->
+      listOfNotNull(
+        included.buildFile,
+        included.file("settings.gradle.kts").takeIf { it.exists() }
+      )
+    }
+
+  val lintKotlinBuildLogic = taskContainer.register(
+    "lintKotlin${taskNameQualifier}BuildScripts",
+    LintTask::class.java
+  ) {
+    group = "Formatting"
+    description = "Runs lint on the build and settings files"
+    source(includedProjectScriptFiles)
+  }
+
+  tasks.named("lintKotlin") {
+    dependsOn(lintKotlinBuildLogic)
+  }
+
+  val formatKotlinBuildLogic = taskContainer.register(
+    "formatKotlin${taskNameQualifier}BuildScripts",
+    FormatTask::class.java
+  ) {
+    group = "Formatting"
+    description = "Formats the build and settings files"
+    source(includedProjectScriptFiles)
+  }
+  tasks.named("formatKotlin") {
+    dependsOn(formatKotlinBuildLogic)
+  }
+}

dependencies/classpath.txt

@@ -166,7 +166,6 @@ org.jetbrains.kotlinx:kotlinx-metadata-jvm:0.5.0
 org.jetbrains:annotations:13.0
 org.jetbrains:markdown-jvm:0.2.4
 org.jetbrains:markdown:0.2.4
-org.jlleitschuh.gradle:ktlint-gradle:10.3.0
 org.json:json:20180813
 org.jsoup:jsoup:1.13.1
 org.jvnet.staxex:stax-ex:1.8.1