Merge pull request #2528 from square/bquenaudon.2023-07-07.spotlessss

Introduce Spotless for the whole repo Kotlin & Java

.gitignore

@@ -14,7 +14,6 @@ out/
 .gradle
 build
 generated
-gradle
 gradlew
 gradlew.bat
 

build.gradle.kts

@@ -1,6 +1,8 @@
 import com.diffplug.gradle.spotless.SpotlessExtension
+import com.diffplug.spotless.LineEnding
 import com.vanniktech.maven.publish.MavenPublishBaseExtension
 import com.vanniktech.maven.publish.SonatypeHost
+import kotlinx.validation.ApiValidationExtension
 import org.gradle.api.tasks.testing.logging.TestExceptionFormat
 import org.gradle.api.tasks.testing.logging.TestLogEvent.FAILED
 import org.gradle.api.tasks.testing.logging.TestLogEvent.PASSED
@@ -10,7 +12,6 @@ import org.jetbrains.dokka.gradle.DokkaTask
 import org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootExtension
 import org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootPlugin
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-import kotlinx.validation.ApiValidationExtension
 
 buildscript {
   dependencies {
@@ -56,15 +57,30 @@ allprojects {
 }
 
 subprojects {
-  apply(plugin = "com.diffplug.spotless")
-  configure<SpotlessExtension> {
-    setEnforceCheck(false)
-    kotlin {
-      target("**/*.kt")
-      ktlint(libs.versions.ktlint.get()).userData(kotlin.collections.mapOf("indent_size" to "2"))
-      trimTrailingWhitespace()
-      endWithNewline()
-      toggleOffOn()
+  if (name != "wire-golden-files") {
+    apply(plugin = "com.diffplug.spotless")
+    configure<SpotlessExtension> {
+      val licenseHeaderFile = rootProject.file("gradle/license-header.txt")
+      kotlin {
+        target("**/*.kt")
+        ktlint(libs.versions.ktlint.get()).editorConfigOverride(
+          mapOf("ktlint_standard_filename" to "disabled"),
+        )
+        trimTrailingWhitespace()
+        endWithNewline()
+        toggleOffOn()
+        lineEndings = LineEnding.UNIX
+        licenseHeaderFile(licenseHeaderFile)
+      }
+      java {
+        target("**/*.java")
+        googleJavaFormat(libs.googleJavaFormat.get().version)
+        trimTrailingWhitespace()
+        endWithNewline()
+        toggleOffOn()
+        lineEndings = LineEnding.UNIX
+        licenseHeaderFile(licenseHeaderFile)
+      }
     }
   }
 

gradle/libs.versions.toml

@@ -13,7 +13,7 @@ jsr305 = "3.0.2"
 junit = "4.13.2"
 kotlin = "1.8.20"
 kotlinpoet = "1.14.2"
-ktlint = "0.42.1"
+ktlint = "0.48.2"
 moshi = "1.13.0"
 okhttp = "4.9.3"
 okio = "3.4.0"
@@ -32,6 +32,7 @@ assertj = { module = "org.assertj:assertj-core", version.ref = "assertj" }
 contour = { module = "app.cash.contour:contour", version = "1.1.0" }
 dokka-core = { module = "org.jetbrains.dokka:dokka-core", version.ref = "dokka" }
 dokka-gradlePlugin = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "dokka" }
+googleJavaFormat = "com.google.googlejavaformat:google-java-format:1.17.0"
 grpc-genJava = { module = "io.grpc:protoc-gen-grpc-java", version.ref = "grpc" }
 grpc-netty = { module = "io.grpc:grpc-netty", version.ref = "grpc" }
 grpc-protobuf = { module = "io.grpc:grpc-protobuf", version.ref = "grpc" }
@@ -73,7 +74,7 @@ pluginz-binaryCompatibilityValidator = { module = "org.jetbrains.kotlinx.binary-
 pluginz-kotlin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
 pluginz-kotlinSerialization = { module = "org.jetbrains.kotlin:kotlin-serialization", version.ref = "kotlin" }
 pluginz-shadow = { module = "com.github.jengelman.gradle.plugins:shadow", version = "4.0.1" }
-pluginz-spotless = { module = "com.diffplug.spotless:spotless-plugin-gradle", version = "6.3.0" }
+pluginz-spotless = { module = "com.diffplug.spotless:spotless-plugin-gradle", version = "6.19.0" }
 pluginz-buildConfig = { module = "com.github.gmazzo:gradle-buildconfig-plugin", version = "3.1.0" }
 protobuf-gradlePlugin = { module = "com.google.protobuf:protobuf-gradle-plugin", version.ref = "protobufGradlePlugin" }
 protobuf-java = { module = "com.google.protobuf:protobuf-java", version.ref = "protobuf" }

gradle/license-header.txt

@@ -0,0 +1,15 @@
+/*
+ * Copyright (C) $YEAR Square, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */

samples/android-app-java-sample/src/main/java/com/squareup/wire/android/app/java/MainActivity.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2021 Square Inc.
+ * Copyright (C) 2021 Square, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ *      https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -15,10 +15,9 @@
  */
 package com.squareup.wire.android.app.java;
 
+import android.os.Bundle;
 import android.widget.TextView;
 import androidx.appcompat.app.AppCompatActivity;
-import android.os.Bundle;
-
 
 public class MainActivity extends AppCompatActivity {
 

samples/android-app-kotlin-sample/src/main/java/com/squareup/wire/android/app/kotlin/MainActivity.kt

@@ -1,11 +1,11 @@
 /*
- * Copyright 2021 Square Inc.
+ * Copyright (C) 2021 Square, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ *      https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,

samples/android-app-variants-sample/src/main/java/com/squareup/wire/android/app/variants/MainActivity.kt

@@ -1,3 +1,18 @@
+/*
+ * Copyright (C) 2023 Square, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package com.squareup.wire.android.app.variants
 
 import android.os.Bundle

samples/android-app-variants-sample/src/test/java/com/squareup/wire/android/app/variants/CommonUnitTest.kt

@@ -1,3 +1,18 @@
+/*
+ * Copyright (C) 2023 Square, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package com.squareup.wire.android.app.variants
 
 import org.junit.Test

samples/android-app-variants-sample/src/testDebug/java/com/squareup/wire/android/app/variants/DebugUnitTest.kt

@@ -1,3 +1,18 @@
+/*
+ * Copyright (C) 2023 Square, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package com.squareup.wire.android.app.variants
 
 import org.junit.Assert.fail

samples/android-app-variants-sample/src/testRelease/java/com/squareup/wire/android/app/variants/ReleaseUnitTest.kt

@@ -1,3 +1,18 @@
+/*
+ * Copyright (C) 2023 Square, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package com.squareup.wire.android.app.variants
 
 import org.junit.Assert.fail

samples/android-lib-java-sample/src/main/java/com/squareup/wire/android/lib/java/SomeObject.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2021 Square Inc.
+ * Copyright (C) 2021 Square, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ *      https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,

samples/android-lib-kotlin-sample/src/main/java/com/squareup/wire/android/lib/kotlin/SomeObject.kt

@@ -1,11 +1,11 @@
 /*
- * Copyright 2021 Square Inc.
+ * Copyright (C) 2021 Square, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ *      https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,

samples/js/src/main/kotlin/Main.kt

@@ -1,3 +1,18 @@
+/*
+ * Copyright (C) 2023 Square, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 import human.Person
 
 fun main() {

samples/native/src/nativeMain/kotlin/Main.kt

@@ -1,3 +1,18 @@
+/*
+ * Copyright (C) 2023 Square, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 import human.Person
 
 fun main() {

samples/simple-sample/src/main/java/com/squareup/dinosaurs/Sample.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2015 Square Inc.
+ * Copyright (C) 2015 Square, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ *      https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -23,24 +23,27 @@
 public final class Sample {
   public void run() throws IOException {
     // Create an immutable value object with the Builder API.
-    Dinosaur stegosaurus = new Dinosaur.Builder()
-        .name("Stegosaurus")
-        .period(Period.JURASSIC)
-        .length_meters(9.0)
-        .mass_kilograms(5_000.0)
-        .picture_urls(Arrays.asList("http://goo.gl/LD5KY5", "http://goo.gl/VYRM67"))
-        .build();
+    Dinosaur stegosaurus =
+        new Dinosaur.Builder()
+            .name("Stegosaurus")
+            .period(Period.JURASSIC)
+            .length_meters(9.0)
+            .mass_kilograms(5_000.0)
+            .picture_urls(Arrays.asList("http://goo.gl/LD5KY5", "http://goo.gl/VYRM67"))
+            .build();
 
     // Encode that value to bytes, and print that as base64.
     byte[] stegosaurusEncoded = Dinosaur.ADAPTER.encode(stegosaurus);
     System.out.println(ByteString.of(stegosaurusEncoded).base64());
 
     // Decode base64 bytes, and decode those bytes as a dinosaur.
-    ByteString tyrannosaurusEncoded = ByteString.decodeBase64("Cg1UeXJhbm5vc2F1cnVzEmhodHRwOi8vdmln"
-        + "bmV0dGUxLndpa2lhLm5vY29va2llLm5ldC9qdXJhc3NpY3BhcmsvaW1hZ2VzLzYvNmEvTGVnbzUuanBnL3Jldmlz"
-        + "aW9uL2xhdGVzdD9jYj0yMDE1MDMxOTAxMTIyMRJtaHR0cDovL3ZpZ25ldHRlMy53aWtpYS5ub2Nvb2tpZS5uZXQv"
-        + "anVyYXNzaWNwYXJrL2ltYWdlcy81LzUwL1JleHlfcHJlcGFyaW5nX2Zvcl9iYXR0bGVfd2l0aF9JbmRvbWludXNf"
-        + "cmV4LmpwZxmamZmZmZkoQCEAAAAAAJC6QCgB");
+    ByteString tyrannosaurusEncoded =
+        ByteString.decodeBase64(
+            "Cg1UeXJhbm5vc2F1cnVzEmhodHRwOi8vdmln"
+                + "bmV0dGUxLndpa2lhLm5vY29va2llLm5ldC9qdXJhc3NpY3BhcmsvaW1hZ2VzLzYvNmEvTGVnbzUuanBnL3Jldmlz"
+                + "aW9uL2xhdGVzdD9jYj0yMDE1MDMxOTAxMTIyMRJtaHR0cDovL3ZpZ25ldHRlMy53aWtpYS5ub2Nvb2tpZS5uZXQv"
+                + "anVyYXNzaWNwYXJrL2ltYWdlcy81LzUwL1JleHlfcHJlcGFyaW5nX2Zvcl9iYXR0bGVfd2l0aF9JbmRvbWludXNf"
+                + "cmV4LmpwZxmamZmZmZkoQCEAAAAAAJC6QCgB");
     Dinosaur tyrannosaurus = Dinosaur.ADAPTER.decode(tyrannosaurusEncoded.toByteArray());
 
     // Print both of our dinosaurs.

samples/wire-codegen-sample/src/main/java/com/squareup/wire/sample/ServiceGenerator.java

@@ -5,7 +5,7 @@
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- * http://www.apache.org/licenses/LICENSE-2.0
+ *      https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -15,6 +15,9 @@
  */
 package com.squareup.wire.sample;
 
+import static javax.lang.model.element.Modifier.ABSTRACT;
+import static javax.lang.model.element.Modifier.PUBLIC;
+
 import com.squareup.javapoet.ClassName;
 import com.squareup.javapoet.MethodSpec;
 import com.squareup.javapoet.TypeName;
@@ -24,9 +27,6 @@
 import com.squareup.wire.schema.Rpc;
 import com.squareup.wire.schema.Service;
 
-import static javax.lang.model.element.Modifier.ABSTRACT;
-import static javax.lang.model.element.Modifier.PUBLIC;
-
 final class ServiceGenerator {
   final JavaGenerator javaGenerator;