replaced kotlinter by jlleitschuh's ktlint plugin

Jolanrensen · Jolanrensen · commit 2320a28ae503 · 2024-06-25T19:16:53.000+02:00
diff --git a/.editorconfig b/.editorconfig
@@ -1,16 +1,36 @@
 [*]
-charset=utf-8
-end_of_line=lf
-insert_final_newline=true
-indent_style=space
-indent_size=4
-max_line_length=120
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+max_line_length = 120
 
 [*.json]
-indent_size=2
+indent_size = 2
 
 [{*.yaml,*.yml}]
-indent_size=2
+indent_size = 2
 
 [*.ipynb]
-insert_final_newline=false
+insert_final_newline = false
+
+[*.{kt,kts}]
+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 = ktlint_official
+ktlint_experimental = enabled
+ktlint_standard_filename = disabled
+ktlint_standard_no-empty-first-line-in-class-body = disabled
+ktlint_class_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than = 4
+ktlint_function_signature_rule_force_multiline_when_parameter_count_greater_or_equal_than = 4
+ktlint_ignore_back_ticked_identifier = true
+ktlint_standard_multiline-expression-wrapping = disabled
+
+[{*/build/**/*,**/*keywords*/**,**/*.Generated.kt,**/*$Extensions.kt}]
+ktlint = disabled
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -10,6 +10,7 @@ import org.jetbrains.kotlinx.dataframe.io.readJson
 import org.jetbrains.kotlinx.publisher.apache2
 import org.jetbrains.kotlinx.publisher.developer
 import org.jetbrains.kotlinx.publisher.githubRepo
+import org.jlleitschuh.gradle.ktlint.KtlintExtension
 
 plugins {
     with(libs.plugins) {
@@ -19,7 +20,7 @@ plugins {
         alias(jupyter.api) apply false
         alias(dokka)
         alias(kover)
-        alias(kotlinter)
+        alias(ktlint)
         alias(korro) apply false
         alias(docProcessor) apply false
         alias(simpleGit) apply false
@@ -54,7 +55,12 @@ dependencies {
 }
 
 enum class Version : Comparable<Version> {
-    SNAPSHOT, DEV, ALPHA, BETA, RC, STABLE;
+    SNAPSHOT,
+    DEV,
+    ALPHA,
+    BETA,
+    RC,
+    STABLE,
 }
 
 fun String.findVersion(): Version {
@@ -72,15 +78,19 @@ fun String.findVersion(): Version {
 // these names of outdated dependencies will not show up in the table output
 val dependencyUpdateExclusions = listOf(
     // TODO Requires more work to be updated to 1.7.0+, https://github.com/Kotlin/dataframe/issues/594
-    libs.plugins.kover.get().pluginId,
-    // TODO Updating requires major changes all across the project, https://github.com/Kotlin/dataframe/issues/364
-    libs.plugins.kotlinter.get().pluginId,
+    libs.plugins.kover
+        .get()
+        .pluginId,
     // TODO 5.8.0 is not possible due to https://github.com/Kotlin/dataframe/issues/595
     libs.kotestAssertions.get().name,
     // Can't be updated to 7.4.0+ due to Java 8 compatibility
-    libs.android.gradle.api.get().group,
-    // TODO 0.1.6 breaks ktlint, https://github.com/Kotlin/dataframe/issues/598
-    libs.plugins.korro.get().pluginId,
+    libs.android.gradle.api
+        .get()
+        .group,
+    // TODO 0.1.6 broke kotlinter, https://github.com/Kotlin/dataframe/issues/598
+    libs.plugins.korro
+        .get()
+        .pluginId,
     // Directly dependent on the Gradle version
     "org.gradle.kotlin.kotlin-dsl",
 )
@@ -100,14 +110,16 @@ tasks.named<DependencyUpdatesTask>("dependencyUpdates").configure {
     doLast {
         val outputFile = layout.buildDirectory
             .file("../$outputDir/$reportfileName.json")
-            .get().asFile
+            .get()
+            .asFile
         when (val outDatedDependencies = DataFrame.readJson(outputFile)["outdated"]["dependencies"][0]) {
             is AnyFrame -> {
-                val df = outDatedDependencies.select {
-                    cols("group", "name", "version") and {
-                        "available"["milestone"] named "newVersion"
-                    }
-                }.filter { "name"() !in dependencyUpdateExclusions && "group"() !in dependencyUpdateExclusions }
+                val df = outDatedDependencies
+                    .select {
+                        cols("group", "name", "version") and {
+                            "available"["milestone"] named "newVersion"
+                        }
+                    }.filter { "name"() !in dependencyUpdateExclusions && "group"() !in dependencyUpdateExclusions }
                 logger.warn("Outdated dependencies found:")
                 df.print(
                     rowsLimit = Int.MAX_VALUE,
@@ -137,29 +149,15 @@ allprojects {
         targetCompatibility = JavaVersion.VERSION_1_8.toString()
     }
 
-    // Attempts to configure kotlinter for each sub-project that uses the plugin
+    // Attempts to configure ktlint for each sub-project that uses the plugin
     afterEvaluate {
         try {
-            kotlinter {
-                ignoreFailures = false
-                reporters = arrayOf("checkstyle", "plain")
-                experimentalRules = true
-                disabledRules = arrayOf(
-                    "no-wildcard-imports",
-                    "experimental:spacing-between-declarations-with-annotations",
-                    "experimental:enum-entry-name-case",
-                    "experimental:argument-list-wrapping",
-                    "experimental:annotation",
-                    "max-line-length",
-                    "filename",
-                    "comment-spacing",
-                    "curly-spacing",
-                    "experimental:annotation-spacing",
-                    "no-unused-imports", // broken
-                )
+            configure<KtlintExtension> {
+                version = "1.3.0"
+                // rules are set up through .editorconfig
             }
         } catch (_: UnknownDomainObjectException) {
-            logger.warn("Could not set kotlinter config on :${this.name}")
+            logger.warn("Could not set ktlint config on :${this.name}")
         }
 
         // set the java toolchain version to 11 for all subprojects for CI stability
@@ -223,13 +221,13 @@ kotlinPublications {
     sonatypeSettings(
         project.findProperty("kds.sonatype.user") as String?,
         project.findProperty("kds.sonatype.password") as String?,
-        "dataframe project, v. ${project.version}"
+        "dataframe project, v. ${project.version}",
     )
 
     signingCredentials(
         project.findProperty("kds.sign.key.id") as String?,
         project.findProperty("kds.sign.key.private") as String?,
-        project.findProperty("kds.sign.key.passphrase") as String?
+        project.findProperty("kds.sign.key.passphrase") as String?,
     )
 
     pom {
diff --git a/core/build.gradle.kts b/core/build.gradle.kts
@@ -5,7 +5,6 @@ import nl.jolanrensen.docProcessor.defaultProcessors.ARG_DOC_PROCESSOR_LOG_NOT_F
 import nl.jolanrensen.docProcessor.gradle.creatingProcessDocTask
 import org.gradle.jvm.tasks.Jar
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-import org.jmailen.gradle.kotlinter.tasks.LintTask
 import xyz.ronella.gradle.plugin.simple.git.task.GitTask
 
 plugins {
@@ -17,7 +16,7 @@ plugins {
         alias(korro)
         alias(keywordGenerator)
         alias(kover)
-        alias(kotlinter)
+        alias(ktlint)
         alias(docProcessor)
         alias(simpleGit)
 
@@ -103,7 +102,7 @@ tasks.withType<KspTask> {
     }
 }
 
-tasks.named("lintKotlinSamples") {
+tasks.named("runKtlintCheckOverSamplesSourceSet") {
     onlyIf { false }
 }
 
@@ -316,37 +315,26 @@ tasks.withType<KspTaskJvm> {
     dependsOn(tasks.generateKeywordsSrc)
 }
 
-tasks.formatKotlinMain {
+tasks.runKtlintFormatOverMainSourceSet {
     dependsOn(tasks.generateKeywordsSrc)
     dependsOn("kspKotlin")
 }
 
-tasks.formatKotlinTest {
+tasks.runKtlintFormatOverTestSourceSet {
     dependsOn(tasks.generateKeywordsSrc)
     dependsOn("kspTestKotlin")
 }
 
-tasks.lintKotlinMain {
+tasks.runKtlintCheckOverMainSourceSet {
     dependsOn(tasks.generateKeywordsSrc)
     dependsOn("kspKotlin")
 }
 
-tasks.lintKotlinTest {
+tasks.runKtlintCheckOverTestSourceSet {
     dependsOn(tasks.generateKeywordsSrc)
     dependsOn("kspTestKotlin")
 }
 
-tasks.withType<LintTask> {
-    exclude("**/*keywords*/**")
-    exclude {
-        it.name.endsWith(".Generated.kt")
-    }
-    exclude {
-        it.name.endsWith("\$Extensions.kt")
-    }
-    enabled = true
-}
-
 kotlin {
     explicitApi()
 }
diff --git a/dataframe-arrow/build.gradle.kts b/dataframe-arrow/build.gradle.kts
@@ -3,7 +3,7 @@ plugins {
         alias(kotlin.jvm)
         alias(publisher)
         alias(kover)
-        alias(kotlinter)
+        alias(ktlint)
     }
 }
 
diff --git a/dataframe-excel/build.gradle.kts b/dataframe-excel/build.gradle.kts
@@ -3,7 +3,7 @@ plugins {
         alias(kotlin.jvm)
         alias(publisher)
         alias(kover)
-        alias(kotlinter)
+        alias(ktlint)
     }
 }
 
diff --git a/dataframe-jdbc/build.gradle.kts b/dataframe-jdbc/build.gradle.kts
@@ -3,7 +3,7 @@ plugins {
         alias(kotlin.jvm)
         alias(publisher)
         alias(kover)
-        alias(kotlinter)
+        alias(ktlint)
         alias(jupyter.api)
     }
 }
diff --git a/dataframe-openapi/build.gradle.kts b/dataframe-openapi/build.gradle.kts
@@ -4,7 +4,7 @@ plugins {
         alias(publisher)
         alias(serialization)
         alias(kover)
-        alias(kotlinter)
+        alias(ktlint)
         alias(jupyter.api)
     }
 }
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -2,9 +2,7 @@
 ksp = "1.9.23-1.0.20"
 kotlinJupyter = "0.12.0-139"
 
-# TODO Updating requires major changes all across the project
-# https://github.com/Kotlin/dataframe/issues/364
-ktlint = "3.4.5"
+ktlint = "12.1.1"
 
 # make sure to sync manually with :generator module
 kotlin = "1.9.22"
@@ -17,7 +15,7 @@ libsPublisher = "1.8.10-dev-43"
 # dogfood Gradle / KSP plugins in tests and idea-examples modules
 dataframe = "0.13.1"
 
-# TODO 0.1.6 breaks ktlint, https://github.com/Kotlin/dataframe/issues/598
+# TODO 0.1.6 breaks kotlinter (which is no longer in use), https://github.com/Kotlin/dataframe/issues/598
 korro = "0.1.5"
 
 # TODO Requires more work to be updated to 0.7.0+
@@ -141,7 +139,7 @@ dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
 keywordGenerator = { id = "org.jetbrains.dataframe.generator", version = "1.0" }
 publisher = { id = "org.jetbrains.kotlin.libs.publisher", version.ref = "libsPublisher" }
 korro = { id = "io.github.devcrocod.korro", version.ref = "korro" }
-kotlinter = { id = "org.jmailen.kotlinter", version.ref = "ktlint" }
+ktlint = { id = "org.jlleitschuh.gradle.ktlint", version.ref = "ktlint" }
 dataframe = { id = "org.jetbrains.kotlinx.dataframe", version.ref = "dataframe" }
 kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
 docProcessor = { id = "nl.jolanrensen.docProcessor", version.ref = "docProcessor" }
diff --git a/plugins/dataframe-gradle-plugin/build.gradle.kts b/plugins/dataframe-gradle-plugin/build.gradle.kts
@@ -3,7 +3,7 @@ plugins {
     `java-gradle-plugin`
     `maven-publish`
     alias(libs.plugins.plugin.publish)
-    alias(libs.plugins.kotlinter)
+    alias(libs.plugins.ktlint)
 }
 
 repositories {
@@ -51,10 +51,12 @@ tasks.withType<ProcessResources> {
         filter {
             it.replace(
                 "%DATAFRAME_JAR%",
-                project(":core").configurations.getByName("instrumentedJars").artifacts.single().file.absolutePath.replace(
+                project(
+                    ":core",
+                ).configurations.getByName("instrumentedJars").artifacts.single().file.absolutePath.replace(
                     File.separatorChar,
-                    '/'
-                )
+                    '/',
+                ),
             )
         }
     }
@@ -77,13 +79,14 @@ gradlePlugin {
             id = "org.jetbrains.kotlin.plugin.dataframe"
             implementationClass = "org.jetbrains.dataframe.gradle.DeprecatingSchemaGeneratorPlugin"
             displayName = "Kotlin Dataframe gradle plugin"
-            description = "The plugin was moved to 'org.jetbrains.kotlinx.dataframe'. Gradle plugin providing task for inferring data schemas from your CSV or JSON data"
+            description =
+                "The plugin was moved to 'org.jetbrains.kotlinx.dataframe'. Gradle plugin providing task for inferring data schemas from your CSV or JSON data"
             tags = listOf("dataframe", "kotlin")
         }
     }
 }
 
-tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile>() {
+tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
     kotlinOptions.jvmTarget = "1.8"
 }
 
@@ -103,7 +106,6 @@ sourceSets {
     }
 }
 
-
 val integrationTestConfiguration by configurations.creating {
     extendsFrom(configurations.testImplementation.get())
 }
diff --git a/plugins/expressions-converter/build.gradle.kts b/plugins/expressions-converter/build.gradle.kts
@@ -4,7 +4,7 @@ plugins {
         alias(kotlin.jvm)
         alias(shadow)
         alias(publisher)
-        alias(kotlinter)
+        alias(ktlint)
     }
 }
 
@@ -66,7 +66,8 @@ tasks.create<JavaExec>("generateTests") {
 
 fun Test.setLibraryProperty(propName: String, jarName: String) {
     val path = project.configurations
-        .testRuntimeClasspath.get()
+        .testRuntimeClasspath
+        .get()
         .files
         .find { """$jarName-\d.*jar""".toRegex().matches(it.name) }
         ?.absolutePath
diff --git a/plugins/symbol-processor/build.gradle b/plugins/symbol-processor/build.gradle
@@ -4,7 +4,7 @@ plugins {
     alias(libs.plugins.shadow)
     alias(libs.plugins.kotlin.jvm)
     alias(libs.plugins.publisher)
-    alias(libs.plugins.kotlinter)
+    alias(libs.plugins.ktlint)
 }
 
 repositories {
diff --git a/tests/build.gradle.kts b/tests/build.gradle.kts

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ plugins {`
`3`	`3`	`alias(kotlin.jvm)`
`4`	`4`	`alias(publisher)`
`5`	`5`	`alias(kover)`
`6`		`- alias(kotlinter)`
	`6`	`+ alias(ktlint)`
`7`	`7`	`}`
`8`	`8`	`}`
`9`	`9`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ plugins {`
`4`	`4`	`alias(publisher)`
`5`	`5`	`alias(serialization)`
`6`	`6`	`alias(kover)`
`7`		`- alias(kotlinter)`
	`7`	`+ alias(ktlint)`
`8`	`8`	`alias(jupyter.api)`
`9`	`9`	`}`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ plugins {`
`3`	`3`	`java-gradle-plugin`
`4`	`4`	`maven-publish`
`5`	`5`	`alias(libs.plugins.plugin.publish)`
`6`		`- alias(libs.plugins.kotlinter)`
	`6`	`+ alias(libs.plugins.ktlint)`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`repositories {`
`@@ -51,10 +51,12 @@ tasks.withType<ProcessResources> {`
`51`	`51`	`filter {`
`52`	`52`	`it.replace(`
`53`	`53`	`"%DATAFRAME_JAR%",`
`54`		`- project(":core").configurations.getByName("instrumentedJars").artifacts.single().file.absolutePath.replace(`
	`54`	`+ project(`
	`55`	`+ ":core",`
	`56`	`+ ).configurations.getByName("instrumentedJars").artifacts.single().file.absolutePath.replace(`
`55`	`57`	`File.separatorChar,`
`56`		`- '/'`
`57`		`- )`
	`58`	`+ '/',`
	`59`	`+ ),`
`58`	`60`	`)`
`59`	`61`	`}`
`60`	`62`	`}`
`@@ -77,13 +79,14 @@ gradlePlugin {`
`77`	`79`	`id = "org.jetbrains.kotlin.plugin.dataframe"`
`78`	`80`	`implementationClass = "org.jetbrains.dataframe.gradle.DeprecatingSchemaGeneratorPlugin"`
`79`	`81`	`displayName = "Kotlin Dataframe gradle plugin"`
`80`		`- description = "The plugin was moved to 'org.jetbrains.kotlinx.dataframe'. Gradle plugin providing task for inferring data schemas from your CSV or JSON data"`
	`82`	`+ description =`
	`83`	`+ "The plugin was moved to 'org.jetbrains.kotlinx.dataframe'. Gradle plugin providing task for inferring data schemas from your CSV or JSON data"`
`81`	`84`	`tags = listOf("dataframe", "kotlin")`
`82`	`85`	`}`
`83`	`86`	`}`
`84`	`87`	`}`
`85`	`88`
`86`		`-tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile>() {`
	`89`	`+tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {`
`87`	`90`	`kotlinOptions.jvmTarget = "1.8"`
`88`	`91`	`}`
`89`	`92`
`@@ -103,7 +106,6 @@ sourceSets {`
`103`	`106`	`}`
`104`	`107`	`}`
`105`	`108`
`106`		`-`
`107`	`109`	`val integrationTestConfiguration by configurations.creating {`
`108`	`110`	`extendsFrom(configurations.testImplementation.get())`
`109`	`111`	`}`