Swap to ktfmt for kotlin code, but keep ktlint for gradle scripts

will-molloy · Jan 6, 2025 · 078f74c · 078f74c
1 parent 657decc
commit 078f74c
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -12,7 +12,8 @@ template repo for Java/Kotlin Gradle projects
 - [GitHub Actions](https://github.com/features/actions) CI/CD
 - Automatic code formatting via [Spotless](https://github.com/diffplug/spotless)
   - Java: [`google-java-format`](https://github.com/google/google-java-format)
-  - Kotlin: [`ktlint`](https://github.com/pinterest/ktlint) and [`ktfmt`](https://github.com/facebook/ktfmt)
+  - Kotlin: [`ktfmt`](https://github.com/facebook/ktfmt)
+  - Kotlin Gradle: [`ktlint`](https://github.com/pinterest/ktlint)
 - Code style analysis via [Checkstyle](https://github.com/checkstyle/checkstyle)
 - Static analysis via [SpotBugs](https://spotbugs.github.io/)
 - Unit and integration test support via [JUnit 5](https://junit.org/junit5/) and [TestSets plugin](https://github.com/unbroken-dome/gradle-testsets-plugin)

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -8,7 +8,6 @@ import org.gradle.api.tasks.testing.logging.TestLogEvent
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension
 
 logger.quiet("Java version: ${JavaVersion.current()}")
-
 logger.quiet("Gradle version: ${gradle.gradleVersion}")
 
 plugins {
@@ -21,7 +20,9 @@ plugins {
 
 allprojects {
   group = "com.willmolloy"
-  repositories { mavenCentral() }
+  repositories {
+    mavenCentral()
+  }
 
   apply(plugin = "java")
   configure<JavaPluginExtension> {
@@ -30,7 +31,9 @@ allprojects {
   }
 
   apply(plugin = "kotlin")
-  configure<KotlinJvmProjectExtension> { jvmToolchain(21) }
+  configure<KotlinJvmProjectExtension> {
+    jvmToolchain(21)
+  }
 
   apply(plugin = "com.diffplug.spotless")
   configure<SpotlessExtension> {
@@ -42,15 +45,16 @@ allprojects {
       endWithNewline()
     }
     // https://github.com/diffplug/spotless/tree/main/plugin-gradle#kotlin
+    // ktfmt seems better than ktlint (more deterministic/consistent output).
+    // Furthermore, using spotless more for formatting than linting.
+    // However, ktfmt has some weird output with Gradle scripts, so using ktlint for that.
     kotlin {
-      ktlint()
       ktfmt().googleStyle()
       trimTrailingWhitespace()
       endWithNewline()
     }
     kotlinGradle {
       ktlint().editorConfigOverride(mapOf("ktlint_standard_no-empty-file" to "disabled"))
-      ktfmt().googleStyle()
       trimTrailingWhitespace()
       endWithNewline()
     }
@@ -74,7 +78,9 @@ allprojects {
     ignoreFailures.set(false)
     excludeFilter.set(rootProject.file("./spotbugs-exclude.xml"))
   }
-  tasks.withType<SpotBugsTask> { reports.create("html").required.set(true) }
+  tasks.withType<SpotBugsTask> {
+    reports.create("html").required.set(true)
+  }
 
   tasks.withType<Test> {
     maxParallelForks = Runtime.getRuntime().availableProcessors()
@@ -103,12 +109,22 @@ allprojects {
   }
 
   apply(plugin = "jacoco")
-  tasks.withType<JacocoReport> { reports { xml.required.set(true) } }
+  tasks.withType<JacocoReport> {
+    reports {
+      xml.required.set(true)
+    }
+  }
 
   val previewFeatures = emptyList<String>()
-  tasks.withType<JavaCompile> { options.compilerArgs = previewFeatures }
-  tasks.withType<Test> { jvmArgs = previewFeatures }
-  tasks.withType<JavaExec> { jvmArgs = previewFeatures }
+  tasks.withType<JavaCompile> {
+    options.compilerArgs = previewFeatures
+  }
+  tasks.withType<Test> {
+    jvmArgs = previewFeatures
+  }
+  tasks.withType<JavaExec> {
+    jvmArgs = previewFeatures
+  }
 
   dependencies {
     implementation(rootProject.libs.log4j.core)

diff --git a/example-kotlin/src/main/kotlin/com/willmolloy/HelloWorld.kt b/example-kotlin/src/main/kotlin/com/willmolloy/HelloWorld.kt
@@ -6,6 +6,7 @@ package com.willmolloy
  * @author <a href=https://willmolloy.com>Will Molloy</a>
  */
 class HelloWorld {
+
   fun hello(text: String): String {
     return "Hello $text!"
   }

diff --git a/example-kotlin/src/test/kotlin/com/willmolloy/HelloWorldTest.kt b/example-kotlin/src/test/kotlin/com/willmolloy/HelloWorldTest.kt
@@ -5,6 +5,7 @@ import org.junit.jupiter.api.Test
 
 /** Unit tests for [HelloWorld]. */
 class HelloWorldTest {
+
   @Test
   fun `test hello`() {
     assertThat(HelloWorld().hello("world")).isEqualTo("Hello world!")

diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -1,5 +1,3 @@
 rootProject.name = "java-template"
-
 include("example-java")
-
 include("example-kotlin")