SOLR-17672: Enable spotless for Kotlin files (#3450)

* Add spotless for kotlin and kotlin DSL (multiplatform)

* Format source code

* Add explicit import layout rule

Add explicit import layout rule with alphabetical ordering and alias imports at the end.

Author: malliaridis

.editorconfig

@@ -348,6 +348,20 @@ ij_java_wrap_first_method_in_call_chain = false
 ij_java_wrap_long_lines = true
 ij_java_wrap_semicolon_after_call_chain = false
 
+[{*.kt,*.kts}]
+indent_size = 4
+ij_kotlin_code_style_defaults = KOTLIN_OFFICIAL
+
+#  Disable wildcard imports entirely
+ij_kotlin_name_count_to_use_star_import = 2147483647
+ij_kotlin_name_count_to_use_star_import_for_members = 2147483647
+ij_kotlin_packages_to_use_import_on_demand = unset
+
+ktlint_code_style = intellij_idea
+ktlint_function_naming_ignore_when_annotated_with = Composable
+compose_allowed_composition_locals = LocalExtendedColorScheme, LocalExtendedTypography
+ij_kotlin_imports_layout=*,^
+
 [*.adoc]
 indent_size = 4
 ij_asciidoc_blank_lines_after_header = 1

gradle/libs.versions.toml

@@ -77,7 +77,7 @@ compose = "1.8.2"
 cutterslade-analyze = "1.10.0"
 cybozulabs-langdetect = "1.1-20120112"
 decompose = "3.3.0"
-diffplug-spotless = "6.5.2"
+diffplug-spotless = "7.2.1"
 dropwizard-metrics = "4.2.26"
 eclipse-ecj = "3.39.0"
 eclipse-jetty = "12.0.19"
@@ -150,6 +150,8 @@ kotlinx-browser = "0.3"
 kotlinx-coroutines = "1.10.1"
 kotlinx-datetime = "0.7.1"
 kotlinx-serialization = "1.9.0"
+# @keep used by spotless
+ktlint = "1.7.1"
 ktor = "3.2.2"
 langchain4j = "0.35.0"
 # @keep Link checker version used in ref-guide
@@ -165,6 +167,7 @@ netty = "4.1.114.Final"
 # @keep for version alignment
 netty-tcnative = "2.0.66.Final"
 nimbusds-josejwt = "9.48"
+nlopez-compose = "0.4.26"
 nodegradle-node = "7.0.1"
 # @keep Node JS version used in node.gradle (LTS)
 nodejs = "16.20.2"
@@ -469,6 +472,7 @@ netty-transport-classes-epoll = { module = "io.netty:netty-transport-classes-epo
 # @keep transitive dependency for version alignment
 netty-transport-native-epoll = { module = "io.netty:netty-transport-native-epoll", version.ref = "netty" }
 nimbusds-josejwt = { module = "com.nimbusds:nimbus-jose-jwt", version.ref = "nimbusds-josejwt" }
+nlopez-compose-ktlintrules = { module = "io.nlopez.compose.rules:ktlint", version.ref = "nlopez-compose" }
 openjdk-jmh-core = { module = "org.openjdk.jmh:jmh-core", version.ref = "openjdk-jmh" }
 openjdk-jmh-generatorannprocess = { module = "org.openjdk.jmh:jmh-generator-annprocess", version.ref = "openjdk-jmh" }
 opentelemetry-api = { module = "io.opentelemetry:opentelemetry-api", version.ref = "opentelemetry" }

gradle/validation/spotless.gradle

@@ -87,6 +87,21 @@ configure(allprojects) { prj ->
     }
   }
 
+  // Configure spotless for kotlin sources
+  plugins.withId("org.jetbrains.kotlin.multiplatform") {
+    prj.apply plugin: libs.plugins.diffplug.spotless.get().pluginId
+
+    spotless {
+      kotlin {
+        // Apply to all Kotlin and Kotlin DSL files
+        target "**/*.kt", "**/*.kts"
+
+        ktlint(libs.versions.ktlint.get())
+            .customRuleSets([libs.nlopez.compose.ktlintrules.get().toString()])
+      }
+    }
+  }
+
   // Emit a custom message about how to fix formatting errors.
   tasks.matching { task -> task.name == "spotlessJavaCheck" }.configureEach {
     it.runToFixMessage.set("\nIMPORTANT: run the top-level './gradlew tidy' to format code automatically (see help/formatting.txt for more info).")

solr/ui/src/commonMain/kotlin/org/apache/solr/ui/components/auth/store/BasicAuthStoreProvider.kt

@@ -22,6 +22,7 @@ import com.arkivanov.mvikotlin.core.store.SimpleBootstrapper
 import com.arkivanov.mvikotlin.core.store.Store
 import com.arkivanov.mvikotlin.core.store.StoreFactory
 import com.arkivanov.mvikotlin.extensions.coroutines.CoroutineExecutor
+import kotlin.coroutines.CoroutineContext
 import kotlinx.coroutines.CoroutineExceptionHandler
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
@@ -31,8 +32,7 @@ import org.apache.solr.ui.components.auth.store.BasicAuthStore.State
 import org.apache.solr.ui.domain.AuthMethod
 import org.apache.solr.ui.errors.InvalidCredentialsException
 import org.apache.solr.ui.errors.UnauthorizedException
-import org.apache.solr.ui.errors.parseError
-import kotlin.coroutines.CoroutineContext
+import org.apache.solr.ui.utils.parseError
 
 class BasicAuthStoreProvider(
     private val storeFactory: StoreFactory,

solr/ui/src/commonMain/kotlin/org/apache/solr/ui/components/environment/EnvironmentComponent.kt

@@ -37,4 +37,4 @@ interface EnvironmentComponent {
         val jvm: JvmData = JvmData(),
         val javaProperties: List<JavaProperty> = emptyList(),
     )
-}
+}

solr/ui/src/commonMain/kotlin/org/apache/solr/ui/components/environment/data/JvmMemoryRaw.kt

@@ -28,4 +28,4 @@ data class JvmMemoryRaw(
     val used: Int = 0,
     @SerialName("used%")
     val usedPercentage: Double = 0.0,
-)
+)

solr/ui/src/commonMain/kotlin/org/apache/solr/ui/components/environment/data/SecurityConfig.kt

@@ -22,4 +22,4 @@ import kotlinx.serialization.Serializable
 @Serializable
 data class SecurityConfig(
     val tls: Boolean = false,
-)
+)

solr/ui/src/commonMain/kotlin/org/apache/solr/ui/components/environment/data/SystemInformation.kt

@@ -39,4 +39,4 @@ data class SystemInformation(
     val totalSwapSpaceSize: Long = 0,
     val maxFileDescriptorCount: Long = 0,
     val openFileDescriptorCount: Long = 0,
-)
+)

solr/ui/src/commonMain/kotlin/org/apache/solr/ui/components/environment/data/SystemMode.kt

@@ -23,8 +23,10 @@ import kotlinx.serialization.Serializable
 @Serializable
 enum class SystemMode {
     Unknown,
+
     @SerialName("solrcloud")
     SolrCloud,
+
     @SerialName("std")
     Standalone,
 }

solr/ui/src/commonMain/kotlin/org/apache/solr/ui/components/environment/integration/DefaultEnvironmentComponent.kt

@@ -36,7 +36,8 @@ class DefaultEnvironmentComponent(
     componentContext: AppComponentContext,
     storeFactory: StoreFactory,
     httpClient: HttpClient,
-) : EnvironmentComponent, AppComponentContext by componentContext {
+) : EnvironmentComponent,
+    AppComponentContext by componentContext {
 
     private val mainScope = coroutineScope(SupervisorJob() + mainContext)
     private val ioScope = coroutineScope(SupervisorJob() + ioContext)