Switch to Spotless for formatting Java code (#780)

.github/workflows/continuous-integration.yml

@@ -44,20 +44,12 @@ jobs:
         with:
           java-version: ${{ matrix.java }}
           distribution: 'temurin'
-      - name: Build and test using Java 11 and Error Prone ${{ matrix.epVersion }}
-        env:
-          ORG_GRADLE_PROJECT_epApiVersion: ${{ matrix.epVersion }}
-        uses: gradle/gradle-build-action@v2
-        with:
-          arguments: verGJF build
-        if: matrix.java == '11'
-      - name: Build and test using Java 17 and Error Prone ${{ matrix.epVersion }}
+      - name: Build and test using Java ${{ matrix.java }} and Error Prone ${{ matrix.epVersion }}
         env:
           ORG_GRADLE_PROJECT_epApiVersion: ${{ matrix.epVersion }}
         uses: gradle/gradle-build-action@v2
         with:
           arguments: build
-        if: matrix.java == '17'
       - name: Report jacoco coverage
         uses: gradle/gradle-build-action@v2
         env:

build.gradle

@@ -35,7 +35,7 @@ buildscript {
     }
 }
 plugins {
-  id "com.github.sherter.google-java-format" version "0.9"
+  id "com.diffplug.spotless" version "6.19.0"
   id "net.ltgt.errorprone" version "3.0.1" apply false
   id "com.github.johnrengelman.shadow" version "8.1.0" apply false
   id "com.github.kt3k.coveralls" version "2.12.0" apply false
@@ -103,14 +103,24 @@ subprojects { project ->
         google()
     }
 
+    // For some reason, spotless complains when applied to the jar-infer folder itself, even
+    // though there is no top-level :jar-infer project
+    if (project.name != "jar-infer") {
+        project.apply plugin: "com.diffplug.spotless"
+        spotless {
+            java {
+                googleJavaFormat()
+            }
+        }
+    }
 }
 
-googleJavaFormat {
-  toolVersion = "1.14.0"
-  // don't enforce formatting for generated Java code under buildSrc
-  exclude 'buildSrc/build/**/*.java'
+spotless {
+    predeclareDeps()
+}
+spotlessPredeclare {
+    java { googleJavaFormat('1.17.0') }
 }
-
 ////////////////////////////////////////////////////////////////////////
 //
 //  Google Java Format pre-commit hook installation

config/hooks/pre-commit

@@ -7,6 +7,6 @@ REPO_ROOT_DIR="$(git rev-parse --show-toplevel)"
 files=$((git diff --cached --name-only --diff-filter=ACMR | grep -Ei "\.java$") || true)
 if [ ! -z "${files}" ]; then
     comma_files=$(echo "$files" | paste -s -d "," -)
-    "${REPO_ROOT_DIR}/gradlew" goJF -DgoogleJavaFormat.include="$comma_files" &>/dev/null
+    "${REPO_ROOT_DIR}/gradlew" spotlessApply -Pspotless.ratchet.from=HEAD >/dev/null 2>&1
     git add $(echo "$files" | paste -s -d " " -)
 fi

jar-infer/jar-infer-lib/src/main/java/com/uber/nullaway/jarinfer/DefinitelyDerefedParamsDriver.java

@@ -510,6 +510,7 @@ private static String getAstubxSignature(IMethod mtd) {
         + strArgTypes
         + ")";
   }
+
   /**
    * Get simple unqualified type name.
    *

nullaway/src/main/java/com/uber/nullaway/ErrorProneCLIFlagsConfig.java

@@ -83,6 +83,7 @@ final class ErrorProneCLIFlagsConfig extends AbstractConfig {
   static final String FL_JI_REGEX_MODEL_PATH = EP_FL_NAMESPACE + ":JarInferRegexStripModelJar";
   static final String FL_JI_REGEX_CODE_PATH = EP_FL_NAMESPACE + ":JarInferRegexStripCodeJar";
   static final String FL_ERROR_URL = EP_FL_NAMESPACE + ":ErrorURL";
+
   /** --- Serialization configs --- */
   static final String FL_FIX_SERIALIZATION = EP_FL_NAMESPACE + ":SerializeFixMetadata";
 

nullaway/src/main/java/com/uber/nullaway/LibraryModels.java

@@ -151,6 +151,7 @@ public interface LibraryModels {
   final class MethodRef {
 
     public final String enclosingClass;
+
     /**
      * we store the method name separately to enable fast comparison with MethodSymbols. See {@link
      * com.uber.nullaway.handlers.LibraryModelsHandler.OptimizedLibraryModels}

nullaway/src/main/java/com/uber/nullaway/dataflow/AccessPath.java

@@ -191,6 +191,7 @@ private static AccessPath fromVanillaMethodCall(
   static AccessPath switchRoot(AccessPath origAP, Element newRoot) {
     return new AccessPath(newRoot, origAP.elements, origAP.mapGetArg);
   }
+
   /**
    * Construct the access path given a {@code base.element} structure.
    *

nullaway/src/main/java/com/uber/nullaway/dataflow/NullnessStore.java

@@ -50,6 +50,7 @@ public class NullnessStore implements Store<NullnessStore> {
   private NullnessStore(Map<AccessPath, Nullness> contents) {
     this.contents = ImmutableMap.copyOf(contents);
   }
+
   /**
    * Produce an empty store.
    *
@@ -139,6 +140,7 @@ public AccessPath getMapGetIteratorContentsAccessPath(LocalVariableNode iterator
     }
     return null;
   }
+
   /**
    * Gets the {@link Nullness} value of an access path.
    *

nullaway/src/main/java/com/uber/nullaway/fixserialization/FixSerializationConfig.java

@@ -49,6 +49,7 @@ public class FixSerializationConfig {
    * untouched.
    */
   public final boolean suggestEnabled;
+
   /**
    * If enabled, serialized information of a fix suggest will also include the enclosing method and
    * class of the element involved in error. Finding enclosing elements is costly and will only be

nullaway/src/main/java/com/uber/nullaway/fixserialization/Serializer.java

@@ -46,10 +46,13 @@
 public class Serializer {
   /** Path to write errors. */
   private final Path errorOutputPath;
+
   /** Path to write suggested fix metadata. */
   private final Path suggestedFixesOutputPath;
+
   /** Path to write suggested fix metadata. */
   private final Path fieldInitializationOutputPath;
+
   /**
    * Adapter used to serialize outputs. This adapter is capable of serializing outputs according to
    * the requested serilization version and maintaining backward compatibility with previous
@@ -66,6 +69,7 @@ public Serializer(FixSerializationConfig config, SerializationAdapter serializat
     serializeVersion(outputDirectory);
     initializeOutputFiles(config);
   }
+
   /**
    * Appends the string representation of the {@link SuggestedNullableFixInfo}.
    *

nullaway/src/main/java/com/uber/nullaway/fixserialization/location/AbstractSymbolLocation.java

@@ -38,8 +38,10 @@ public abstract class AbstractSymbolLocation implements SymbolLocation {
 
   /** Element kind of the targeted symbol */
   protected final ElementKind type;
+
   /** Path of the file containing the symbol, if available. */
   @Nullable protected final Path path;
+
   /** Enclosing class of the symbol. */
   protected final Symbol.ClassSymbol enclosingClass;
 

nullaway/src/main/java/com/uber/nullaway/fixserialization/location/MethodParameterLocation.java

@@ -33,8 +33,10 @@ public class MethodParameterLocation extends AbstractSymbolLocation {
 
   /** Symbol of the targeted method. */
   private final Symbol.MethodSymbol enclosingMethod;
+
   /** Symbol of the targeted method parameter. */
   private final Symbol.VarSymbol paramSymbol;
+
   /** Index of the method parameter in the containing method's argument list. */
   private final int index;
 

nullaway/src/main/java/com/uber/nullaway/fixserialization/out/ErrorInfo.java

@@ -45,6 +45,7 @@ public class ErrorInfo {
    * target, and this field is the Symbol for that target.
    */
   @Nullable private final Symbol nonnullTarget;
+
   /**
    * In cases where {@link ErrorInfo#nonnullTarget} is {@code null}, we serialize this value at its
    * placeholder in the output tsv file.
@@ -54,6 +55,7 @@ public class ErrorInfo {
 
   /** Offset of program point where this error is reported. */
   private final int offset;
+
   /** Path to the containing source file where this error is reported. */
   @Nullable private final Path path;
 

nullaway/src/main/java/com/uber/nullaway/fixserialization/out/FieldInitializationInfo.java

@@ -35,6 +35,7 @@ public class FieldInitializationInfo {
 
   /** Symbol of the initializer method. */
   private final SymbolLocation initializerMethodLocation;
+
   /** Symbol of the initialized class field. */
   private final Symbol field;
 

nullaway/src/main/java/com/uber/nullaway/fixserialization/out/SuggestedNullableFixInfo.java

@@ -34,6 +34,7 @@ public class SuggestedNullableFixInfo {
 
   /** SymbolLocation of the target element in source code. */
   private final SymbolLocation symbolLocation;
+
   /** Error which will be resolved by this type change. */
   private final ErrorMessage errorMessage;
 

nullaway/src/main/java/com/uber/nullaway/handlers/AbstractFieldContractHandler.java

@@ -48,6 +48,7 @@
 public abstract class AbstractFieldContractHandler extends BaseNoOpHandler {
 
   protected static final String THIS_NOTATION = "this.";
+
   /** Simple name of the annotation in {@code String} */
   protected final String annotName;
 

nullaway/src/main/java/com/uber/nullaway/handlers/StreamNullabilityPropagatorFactory.java

@@ -1,4 +1,5 @@
 package com.uber.nullaway.handlers;
+
 /*
  * Copyright (c) 2017 Uber Technologies, Inc.
  *

nullaway/src/main/java/com/uber/nullaway/handlers/stream/MaplikeMethodRecord.java

@@ -1,4 +1,5 @@
 package com.uber.nullaway.handlers.stream;
+
 /*
  * Copyright (c) 2017 Uber Technologies, Inc.
  *

nullaway/src/main/java/com/uber/nullaway/handlers/stream/MaplikeToFilterInstanceRecord.java

@@ -1,4 +1,5 @@
 package com.uber.nullaway.handlers.stream;
+
 /*
  * Copyright (c) 2017 Uber Technologies, Inc.
  *

nullaway/src/main/java/com/uber/nullaway/handlers/stream/StreamModelBuilder.java

@@ -1,4 +1,5 @@
 package com.uber.nullaway.handlers.stream;
+
 /*
  * Copyright (c) 2017 Uber Technologies, Inc.
  *

nullaway/src/main/java/com/uber/nullaway/handlers/stream/StreamTypeRecord.java

@@ -1,4 +1,5 @@
 package com.uber.nullaway.handlers.stream;
+
 /*
  * Copyright (c) 2017 Uber Technologies, Inc.
  *

sample-app/build.gradle

@@ -72,3 +72,9 @@ dependencies {
     testImplementation deps.test.junit4
 
 }
+
+spotless {
+    java {
+        target 'src/*/java/**/*.java'
+    }
+}

settings.gradle

@@ -13,7 +13,6 @@ include ':sample'
 include ':test-java-lib'
 include ':test-java-lib-lombok'
 include ':test-library-models'
-include ':compile-bench'
 include ':jar-infer:android-jarinfer-models-sdk28'
 include ':jar-infer:android-jarinfer-models-sdk29'
 include ':jar-infer:android-jarinfer-models-sdk30'