Migrate to Spotless (#4025)

* Migrate to Spotless

* Bump to Java 11 for Spotless, AGP, and RoboVm

* Apply style for Kotlin

* Cleanups

* Update build.gradle

---------

Co-authored-by: Jake Wharton <[email protected]>

Author: Goooler

Diff for: .editorconfig

@@ -6,5 +6,8 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.{kt, kts}]
-kotlin_imports_layout = ascii
+[*.{kt,kts}]
+ij_kotlin_allow_trailing_comma = true
+ij_kotlin_allow_trailing_comma_on_call_site = true
+ij_kotlin_imports_layout = *
+ktlint_code_style = intellij_idea

Diff for: .github/workflows/build.yml

@@ -39,7 +39,7 @@ jobs:
       - uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: 8
+          java-version: 11
 
       - uses: gradle/gradle-build-action@v2
 
@@ -60,7 +60,7 @@ jobs:
       - uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: 8
+          java-version: 11
 
       - uses: gradle/gradle-build-action@v2
 

Diff for: build.gradle

@@ -22,7 +22,7 @@ plugins {
   alias(libs.plugins.mavenPublish) apply false
   alias(libs.plugins.protobuf) apply false
   alias(libs.plugins.animalsniffer) apply false
-  alias(libs.plugins.googleJavaFormat) apply false
+  alias(libs.plugins.spotless) apply false
 }
 
 subprojects {
@@ -89,28 +89,17 @@ subprojects {
       }
     }
 
-    // google-java-format only works on JDK 11 to JDK 15 (without wild flags).
-    if (Jvm.current().javaVersion.isJava11Compatible() && !Jvm.current().javaVersion.isCompatibleWith(JavaVersion.VERSION_16)) {
-      project.apply plugin: 'com.github.sherter.google-java-format'
-      googleJavaFormat {
-        toolVersion = '1.18.1'
-
-        // By default, the GJF plugin includes all Java folders inside the project directory. This
-        // does not work well with nested projects, especially when you want to exclude them.
-        source = sourceSets*.allJava
+    plugins.apply(libs.plugins.spotless.get().pluginId)
+    spotless {
+      java {
+        googleJavaFormat(libs.googleJavaFormat.get().version)
+          .formatJavadoc(false)
+        removeUnusedImports()
+        target 'src/*/java/**/*.java'
       }
-      afterEvaluate {
-        def verify = tasks.getByName('verifyGoogleJavaFormat')
-        tasks.getByName('check').dependsOn(verify)
-        def prompt = tasks.create('promptGoogleJavaFormat') {
-          doLast {
-            println()
-            println('To automatically format, run "./gradlew googleJavaFormat"')
-            println()
-          }
-          onlyIf { verify.state.failure != null }
-        }
-        verify.finalizedBy(prompt)
+      kotlin {
+        ktlint(libs.ktlint.get().version)
+        target 'src/**/*.kt'
       }
     }
   }

Diff for: gradle/libs.versions.toml

@@ -27,7 +27,7 @@ errorprone = { id = "net.ltgt.errorprone", version = "3.1.0" }
 mavenPublish = { id = "com.vanniktech.maven.publish", version = "0.18.0" }
 protobuf = { id = "com.google.protobuf", version = "0.9.4" }
 animalsniffer = { id = "ru.vyarus.animalsniffer", version = "1.7.1" }
-googleJavaFormat = { id = "com.github.sherter.google-java-format", version = "0.9" }
+spotless = "com.diffplug.spotless:6.23.3"
 
 [libraries]
 androidPlugin = { module = "com.android.tools.build:gradle", version = "4.2.2" }
@@ -66,3 +66,5 @@ jsoup = { module = "org.jsoup:jsoup", version = "1.17.1" }
 robovm = { module = "com.mobidevelop.robovm:robovm-rt", version.ref = "robovm" }
 errorproneCore = { module = "com.google.errorprone:error_prone_core", version = "2.10.0" }
 errorproneJavac = { module = "com.google.errorprone:javac", version = "9+181-r4173-1" }
+googleJavaFormat = "com.google.googlejavaformat:google-java-format:1.19.1"
+ktlint = "com.pinterest.ktlint:ktlint-cli:1.1.0"

Diff for: retrofit-adapters/rxjava/src/main/java/retrofit2/adapter/rxjava/BodyOnSubscribe.java

@@ -39,6 +39,7 @@ public void call(Subscriber<? super T> subscriber) {
 
   private static class BodySubscriber<R> extends Subscriber<Response<R>> {
     private final Subscriber<? super R> subscriber;
+
     /** Indicates whether a terminal event has been sent to {@link #subscriber}. */
     private boolean subscriberTerminated;
 

Diff for: retrofit-mock/src/main/java/retrofit2/mock/BehaviorDelegate.java

@@ -151,6 +151,7 @@ public Type getRawType() {
 
   static class ServiceMethodAdapterInfo {
     final boolean isSuspend;
+
     /**
      * Whether the suspend function return type was {@code Response<T>}. Only meaningful if {@link
      * #isSuspend} is true.

Diff for: retrofit-mock/src/test/java/retrofit2/mock/BehaviorDelegateKotlinTest.kt

@@ -15,16 +15,16 @@
  */
 package retrofit2.mock
 
+import java.io.IOException
+import java.util.Random
+import java.util.concurrent.TimeUnit.MILLISECONDS
+import java.util.concurrent.TimeUnit.NANOSECONDS
 import kotlinx.coroutines.runBlocking
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.Before
 import org.junit.Test
 import retrofit2.Response
 import retrofit2.Retrofit
-import java.io.IOException
-import java.util.Random
-import java.util.concurrent.TimeUnit.MILLISECONDS
-import java.util.concurrent.TimeUnit.NANOSECONDS
 
 class BehaviorDelegateKotlinTest {
   internal interface DoWorkService {
@@ -40,11 +40,11 @@ class BehaviorDelegateKotlinTest {
 
   @Before fun before() {
     val retrofit = Retrofit.Builder()
-        .baseUrl("http://example.com")
-        .build()
+      .baseUrl("http://example.com")
+      .build()
     val mockRetrofit = MockRetrofit.Builder(retrofit)
-        .networkBehavior(behavior)
-        .build()
+      .networkBehavior(behavior)
+      .build()
     val delegate = mockRetrofit.create<DoWorkService>()
 
     service = object : DoWorkService {

Diff for: retrofit/kotlin-test/src/test/java/retrofit2/KotlinExtensionsTest.kt

@@ -27,8 +27,8 @@ class KotlinExtensionsTest {
 
   @Test fun reifiedCreate() {
     val retrofit = Retrofit.Builder()
-        .baseUrl(server.url("/"))
-        .build()
+      .baseUrl(server.url("/"))
+      .build()
 
     assertNotNull(retrofit.create<Empty>())
   }