[prone] Apply errorprone

Vincent Potucek · Vincent Potucek · commit adebb7690501 · 2025-10-21T11:00:07.000+02:00
diff --git a/gradle/error-prone.gradle b/gradle/error-prone.gradle
@@ -17,18 +17,86 @@ dependencies {
 }
 
 tasks.withType(JavaCompile).configureEach {
+
 	options.errorprone {
-		disableAllChecks = true // consider removal to avoid error prone error´s, following convention over configuration.
+		disable( // not patchable
+				'FormatStringConcatenation',
+				'FunctionalInterfaceMethodChanged',
+				'JavaxInjectOnAbstractMethod',
+				'OverridesJavaxInjectableMethod',
+				'ReturnValueIgnored',
+				'Slf4jLogStatement',
+				'MissingSummary',
+				// patchable
+				'LexicographicalAnnotationAttributeListing',
+				'LexicographicalAnnotationListing',
+				'NonStaticImport',
+				'Slf4jLoggerDeclaration', // logger -> log
+				'StaticImport',
+				// critical, finds lots of bugs... unused configs and stuff.
+				'Unused',
+				'UnusedMethod',
+				'UnusedParameters',
+				'UnusedVariable',
+				)
 		error(
-				'ConstantNaming',
+				'AmbiguousJsonCreator',
+				'AssertJNullnessAssertion',
+				'AutowiredConstructor',
+				'CanonicalAnnotationSyntax',
+				'CollectorMutability',
+		        'ConstantNaming',
+				'DirectReturn',
+				'EmptyMethod',
+				'ExplicitArgumentEnumeration',
+				'ExplicitEnumOrdering',
+				'IdentityConversion',
+				'ImmutablesSortedSetComparator',
+				'IsInstanceLambdaUsage',
+				'MockitoMockClassReference',
+				'MockitoStubbing',
+				'NestedOptionals',
+				'PrimitiveComparison',
 				'RedundantStringConversion',
+				'RedundantStringEscape',
+				'SelfAssignment',
+				'StringJoin',
+				'StringJoining',
 				)
+		// fixme bug: this only happens when the file is dirty!
+		// up2date checking (caching) must consider file changes, as file is currently corrupt!
+		// fix SelfTest.java:L22 ForbidGradleInternal(import org.gradle.api.internal.project.ProjectInternal;)
+		errorproneArgs.add('-XepExcludedPaths:.*/SelfTest.java')
 		if (!getenv().containsKey('CI') && getenv('IN_PLACE')?.toBoolean()) {
 			errorproneArgs.addAll(
 					'-XepPatchLocation:IN_PLACE',
 					'-XepPatchChecks:' +
-					'ConstantNaming,' +
-					'RedundantStringConversion,'
+					'AmbiguousJsonCreator,' +
+					'ArrayEquals,' +
+					'AssertJNullnessAssertion,' +
+					'AutowiredConstructor,' +
+					'CanonicalAnnotationSyntax,' +
+					'CollectorMutability,' +
+				    'ConstantNaming,' +
+					'DirectReturn,' +
+					'EmptyMethod,' +
+					'ExplicitArgumentEnumeration,' +
+					'ExplicitEnumOrdering,' +
+					'FormatStringConcatenation,' +
+					'IdentityConversion,' +
+					'ImmutablesSortedSetComparator,' +
+					'IsInstanceLambdaUsage,' +
+					'MockitoMockClassReference,' +
+					'MockitoStubbing,' +
+					'NestedOptionals,' +
+					'PrimitiveComparison,' +
+					'RedundantStringConversion,' +
+					'RedundantStringEscape,' +
+					'SelfAssignment,' +
+					'Slf4jLogStatement,' +
+					'StringJoin,' +
+					'StringJoining,' +
+					'TimeZoneUsage,'
 					)
 		}
 	}
diff --git a/gradle/rewrite.gradle b/gradle/rewrite.gradle
@@ -2,7 +2,6 @@ apply plugin: 'org.openrewrite.rewrite'
 
 rewrite {
 	activeRecipe('com.diffplug.spotless.openrewrite.SanityCheck')
-	activeStyle('com.diffplug.spotless.openrewrite.SpotlessFormat')
 	exclusions.addAll(
 			'**.dirty.java',
 			'**FormatterProperties.java',
diff --git a/lib-extra/src/test/java/com/diffplug/spotless/extra/java/EclipseJdtEqualityTest.java b/lib-extra/src/test/java/com/diffplug/spotless/extra/java/EclipseJdtEqualityTest.java
@@ -15,21 +15,20 @@
  */
 package com.diffplug.spotless.extra.java;
 
+import com.diffplug.spotless.FormatterStep;
+import com.diffplug.spotless.ResourceHarness;
+import com.diffplug.spotless.TestProvisioner;
+import com.diffplug.spotless.ThrowingEx;
 import java.io.ByteArrayOutputStream;
 import java.io.File;
 import java.io.IOException;
 import java.io.ObjectOutputStream;
 import java.io.Serializable;
+import java.util.Arrays;
 import java.util.List;
-
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
-import com.diffplug.spotless.FormatterStep;
-import com.diffplug.spotless.ResourceHarness;
-import com.diffplug.spotless.TestProvisioner;
-import com.diffplug.spotless.ThrowingEx;
-
 public class EclipseJdtEqualityTest extends ResourceHarness {
 	@Test
 	public void test() throws Exception {
@@ -43,7 +42,7 @@ public void test() throws Exception {
 
 		var serialized1 = toBytes(step1);
 		var serialized2 = toBytes(step2);
-		Assertions.assertFalse(serialized1.equals(serialized2));
+		Assertions.assertFalse(Arrays.equals(serialized1, serialized2));
 	}
 
 	private static FormatterStep withSettingsFile(File settingsFile) {
diff --git a/lib/src/compatKtLint0Dot48Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot48Dot0Adapter.java b/lib/src/compatKtLint0Dot48Dot0/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompat0Dot48Dot0Adapter.java
@@ -115,7 +115,7 @@ public String format(
 	private static EditorConfigOverride createEditorConfigOverride(final List<Rule> rules, Map<String, Object> editorConfigOverrideMap) {
 		// Get properties from rules in the rule sets
 		Stream<EditorConfigProperty<?>> ruleProperties = rules.stream()
-				.filter(rule -> rule instanceof UsesEditorConfigProperties)
+				.filter(UsesEditorConfigProperties.class::isInstance)
 				.flatMap(rule -> ((UsesEditorConfigProperties) rule).getEditorConfigProperties().stream());
 
 		// Create a mapping of properties to their names based on rule properties and default properties
diff --git a/lib/src/main/java/com/diffplug/spotless/PaddedCell.java b/lib/src/main/java/com/diffplug/spotless/PaddedCell.java
@@ -153,7 +153,7 @@ public String canonical() {
 		// @formatter:off
 		switch (type) {
 		case CONVERGE:	return steps.get(steps.size() - 1);
-		case CYCLE:		return Collections.min(steps, Comparator.comparing(String::length).thenComparing(Function.identity()));
+		case CYCLE:		return Collections.min(steps, Comparator.comparingInt(String::length).thenComparing(Function.identity()));
 		case DIVERGE:	throw new IllegalArgumentException("No canonical form for a diverging result");
 		default:	throw new IllegalArgumentException("Unknown type: " + type);
 		}
diff --git a/lib/src/main/java/com/diffplug/spotless/biome/BiomeStep.java b/lib/src/main/java/com/diffplug/spotless/biome/BiomeStep.java
@@ -299,7 +299,7 @@ private State createState() throws IOException, InterruptedException {
 		validateBiomeExecutable(resolvedPathToExe);
 		validateBiomeConfigPath(configPath, version);
 		LOGGER.debug("Using Biome executable located at  '{}'", resolvedPathToExe);
-		var exeSignature = FileSignature.signAsList(Set.of(new File(resolvedPathToExe)));
+		var exeSignature = FileSignature.signAsList(new File(resolvedPathToExe));
 		makeExecutable(resolvedPathToExe);
 		return new State(resolvedPathToExe, exeSignature, configPath, language);
 	}
diff --git a/lib/src/main/java/com/diffplug/spotless/generic/IdeaStep.java b/lib/src/main/java/com/diffplug/spotless/generic/IdeaStep.java
@@ -158,10 +158,12 @@ private static String resolveFullBinaryPathAndCheckVersion(String binaryPath) {
 					.pathToExe(pathToExe(binaryPath))
 					.versionRegex(Pattern.compile("(IntelliJ IDEA) .*"))
 					.fixCantFind(
-							"IDEA executable cannot be found on your machine, "
-									+ "please install it and put idea binary to PATH, provide a valid path to the executable or report the problem")
-					.fixWrongVersion("Provided binary is not IDEA, "
-							+ "please check it and fix the problem; or report the problem");
+							"""
+							IDEA executable cannot be found on your machine, \
+							please install it and put idea binary to PATH, provide a valid path to the executable or report the problem""")
+					.fixWrongVersion("""
+							Provided binary is not IDEA, \
+							please check it and fix the problem; or report the problem""");
 			try {
 				return exe.confirmVersionAndGetAbsolutePath();
 			} catch (IOException e) {
diff --git a/lib/src/main/java/com/diffplug/spotless/go/GofmtFormatStep.java b/lib/src/main/java/com/diffplug/spotless/go/GofmtFormatStep.java
@@ -67,8 +67,10 @@ public FormatterStep create() {
 	}
 
 	private RoundtripState createRountrip() throws IOException, InterruptedException {
-		String howToInstall = "gofmt is a part of standard go distribution. If spotless can't discover it automatically, "
-				+ "you can point Spotless to the go binary with {@code pathToExe('/path/to/go')}";
+		String howToInstall = """
+				gofmt is a part of standard go distribution. If spotless can't discover it automatically, \
+				you can point Spotless to the go binary with {@code pathToExe('/path/to/go')}\
+				""";
 		final ForeignExe exe = ForeignExe.nameAndVersion("go", version)
 				.pathToExe(pathToExe)
 				.versionFlag("version")
diff --git a/lib/src/main/java/com/diffplug/spotless/rdf/ReflectionHelper.java b/lib/src/main/java/com/diffplug/spotless/rdf/ReflectionHelper.java
@@ -205,8 +205,9 @@ public Object invoke(Object proxy, Method method, Object[] args) throws Throwabl
 				LOGGER.warn("{}({},{}): {}", this.filePath, line, col, message);
 			} else {
 				if ("warning".equals(severity)) {
-					LOGGER.error("Formatter fails because of a parser warning. To make the formatter succeed in"
-							+ "the presence of warnings, set the configuration parameter 'failOnWarning' to 'false' (default: 'true')");
+					LOGGER.error("""
+							Formatter fails because of a parser warning. To make the formatter succeed in\
+							the presence of warnings, set the configuration parameter 'failOnWarning' to 'false' (default: 'true')""");
 				}
 				throw new RuntimeException(
 						"line %d, col %d: %s (severity: %s)".formatted(line, col, message, severity));
diff --git a/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/GradleProvisioner.java b/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/GradleProvisioner.java
@@ -135,8 +135,9 @@ private static Provisioner forConfigurationContainer(Project project, Configurat
 					projName = projName + "/";
 				}
 				throw new GradleException(String.format(
-						"You need to add a repository containing the '%s' artifact in '%sbuild.gradle'.%n"
-								+ "E.g.: 'repositories { mavenCentral() }'",
+						"""
+						You need to add a repository containing the '%s' artifact in '%sbuild.gradle'.%n\
+						E.g.: 'repositories { mavenCentral() }'""",
 						mavenCoords, projName), e);
 			}
 		};
diff --git a/plugin-gradle/src/test/java/com/diffplug/gradle/spotless/GitRatchetGradleTest.java b/plugin-gradle/src/test/java/com/diffplug/gradle/spotless/GitRatchetGradleTest.java
@@ -58,7 +58,7 @@ public GradleRunner gradleRunner() throws IOException {
 
 	@ParameterizedTest
 	//@ValueSource(ints = {0, 1}) // TODO: this is a flaky configuration cache issue that started with Gradle 8.5
-	@ValueSource(ints = {0})
+	@ValueSource(ints = 0)
 	void singleProjectExhaustive(int useConfigCache) throws Exception {
 		try (Git git = initRepo()) {
 			if (useConfigCache == 1) {
@@ -158,7 +158,7 @@ private BuildResultAssertion assertFail(String... tasks) throws Exception {
 
 	@ParameterizedTest
 	//@ValueSource(ints = {0, 1}) // TODO: this is a flaky configuration cache issue that started with Gradle 8.5
-	@ValueSource(ints = {0})
+	@ValueSource(ints = 0)
 	void multiProject(int useConfigCache) throws Exception {
 		try (Git git = initRepo()) {
 			if (useConfigCache == 1) {
diff --git a/plugin-gradle/src/test/java/com/diffplug/gradle/spotless/SpotlessTaskImplTest.java b/plugin-gradle/src/test/java/com/diffplug/gradle/spotless/SpotlessTaskImplTest.java
@@ -29,17 +29,17 @@
 public class SpotlessTaskImplTest {
 	@Test
 	public void testThrowsMessageContainsFilename() throws Exception {
-		SpotlessTaskImpl task = Mockito.mock(SpotlessTaskImpl.class, Mockito.CALLS_REAL_METHODS);
+		SpotlessTaskImpl task = Mockito.mock(Mockito.CALLS_REAL_METHODS);
 		Mockito.when(task.getLogger()).thenReturn(Mockito.mock(Logger.class));
 
 		File projectDir = Path.of("unitTests", "projectDir").toFile();
-		DirectoryProperty projectDirProperty = Mockito.mock(DirectoryProperty.class, Mockito.RETURNS_DEEP_STUBS);
+		DirectoryProperty projectDirProperty = Mockito.mock(Mockito.RETURNS_DEEP_STUBS);
 		Mockito.when(projectDirProperty.get().getAsFile()).thenReturn(projectDir);
 
 		Mockito.when(task.getProjectDir()).thenReturn(projectDirProperty);
 
 		File input = Path.of("unitTests", "projectDir", "someInput").toFile();
-		Formatter formatter = Mockito.mock(Formatter.class);
+		Formatter formatter = Mockito.mock();
 
 		Assertions.assertThatThrownBy(() -> task.processInputFile(null, formatter, input, "someInput")).hasMessageContaining(input.toString());
 	}
diff --git a/plugin-gradle/src/test/java/com/diffplug/gradle/spotless/TargetExcludeIfContentContainsTest.java b/plugin-gradle/src/test/java/com/diffplug/gradle/spotless/TargetExcludeIfContentContainsTest.java
@@ -60,7 +60,10 @@ void targetExcludeIfContentContainsWithMultipleSteps() throws IOException {
 				"    target '**/*.md'",
 				"    targetExcludeIfContentContains '// Generated by Mr. Roboto'",
 				"    custom 'lowercase', { str -> str.toLowerCase() }",
-				"    licenseHeader('" + "// My CopyRights header" + "', '--')",
+				"""
+				    licenseHeader('\
+				// My CopyRights header\
+				', '--')""",
 				"  }",
 				"}");
 		String generatedContent = """
diff --git a/plugin-maven/src/test/java/com/diffplug/spotless/maven/FileLocatorTest.java b/plugin-maven/src/test/java/com/diffplug/spotless/maven/FileLocatorTest.java
@@ -40,7 +40,7 @@ class FileLocatorTest extends ResourceHarness {
 
 	@BeforeEach
 	void beforeEach() {
-		resourceManager = mock(ResourceManager.class);
+		resourceManager = mock();
 		fileLocator = new FileLocator(resourceManager, rootFolder(), rootFolder());
 	}
 
diff --git a/plugin-maven/src/test/java/com/diffplug/spotless/maven/MavenIntegrationHarness.java b/plugin-maven/src/test/java/com/diffplug/spotless/maven/MavenIntegrationHarness.java
@@ -93,14 +93,13 @@ void gitAttributes() throws IOException {
 		if (Jvm.version() >= 16) {
 			// for GJF https://github.com/diffplug/spotless/issues/834
 			setFile(".mvn/jvm.config").toContent(
-					"--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED"
-							+ " --add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED"
-							+ " --add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED"
-							+ " --add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED"
-							+ " --add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED"
-							// this last line is for Detekt
-							+ // this last line is for Detekt
-							" --add-opens java.base/java.lang=ALL-UNNAMED");
+					"""
+					--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED\
+					 --add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED\
+					 --add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED\
+					 --add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED\
+					 --add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED\
+					 --add-opens java.base/java.lang=ALL-UNNAMED""");
 		}
 		// copy the mvnw resources
 		copy("mvnw").setExecutable(true);
diff --git a/plugin-maven/src/test/java/com/diffplug/spotless/maven/incremental/FileIndexHarness.java b/plugin-maven/src/test/java/com/diffplug/spotless/maven/incremental/FileIndexHarness.java
@@ -35,8 +35,8 @@ abstract class FileIndexHarness {
 
 	protected static final PluginFingerprint FINGERPRINT = PluginFingerprint.from("foo");
 
-	protected final FileIndexConfig config = mock(FileIndexConfig.class);
-	protected final Log log = mock(Log.class);
+	protected final FileIndexConfig config = mock();
+	protected final Log log = mock();
 
 	protected Path tempDir;
 
diff --git a/plugin-maven/src/test/java/com/diffplug/spotless/maven/incremental/NoopCheckerTest.java b/plugin-maven/src/test/java/com/diffplug/spotless/maven/incremental/NoopCheckerTest.java
@@ -59,7 +59,7 @@ void beforeEach() throws Exception {
 
 	@Test
 	void deletesExistingIndexFileWhenCreated() {
-		Log log = mock(Log.class);
+		Log log = mock();
 		try (UpToDateChecker realChecker = UpToDateChecker.forProject(project, indexFile, singletonList(dummyFormatter()), log)) {
 			realChecker.setUpToDate(existingSourceFile);
 		}
@@ -76,7 +76,7 @@ void deletesExistingIndexFileWhenCreated() {
 	void doesNothingWhenIndexFileDoesNotExist() {
 		assertThat(indexFile).doesNotExist();
 
-		Log log = mock(Log.class);
+		Log log = mock();
 		try (UpToDateChecker noopChecker = UpToDateChecker.noop(project, indexFile, log)) {
 			assertThat(noopChecker).isNotNull();
 		}
diff --git a/rewrite.yml b/rewrite.yml
@@ -18,6 +18,7 @@ recipeList:
   - org.openrewrite.java.format.RemoveTrailingWhitespace
   - org.openrewrite.java.migrate.UpgradeToJava17
   - org.openrewrite.java.migrate.lang.StringRulesRecipes
+  - org.openrewrite.java.migrate.lang.UseTextBlocks
   - org.openrewrite.java.migrate.util.JavaLangAPIs
   - org.openrewrite.java.migrate.util.JavaUtilAPIs
   - org.openrewrite.java.migrate.util.MigrateInflaterDeflaterToClose
@@ -66,28 +67,3 @@ recipeList:
   - tech.picnic.errorprone.refasterrules.TimeRulesRecipes
   # - org.openrewrite.java.migrate.lang.FindVirtualThreadOpportunities # don't want to use: https://github.com/diffplug/spotless/pull/2684#discussion_r2433831887
 ---
-name: com.diffplug.spotless.openrewrite.SpotlessFormat
-styleConfigs:
-  - org.openrewrite.java.style.ImportLayoutStyle:
-      classCountToUseStarImport: 999
-      nameCountToUseStarImport: 999
-      # bug https://github.com/openrewrite/rewrite/issues/6107
-      #      layout:
-      #        - import java.*
-      #        - <blank line>
-      #        - import javax.*
-      #        - <blank line>
-      #        - import org.*
-      #        - <blank line>
-      #        - import com.*
-      #        - <blank line>
-      #        - import com.diffplug.*
-      #        - <blank line>
-      #        - import static all other imports
-      #        - <blank line>
-      #        - import all other imports
-      #        - <blank line>
-  - org.openrewrite.java.style.TabsAndIndentsStyle:
-      useTabCharacter: true
-      tabSize: 4
----
diff --git a/settings.gradle b/settings.gradle

Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,7 @@ public String canonical() {`
`153`	`153`	`// @formatter:off`
`154`	`154`	`switch (type) {`
`155`	`155`	`case CONVERGE: return steps.get(steps.size() - 1);`
`156`		`- case CYCLE: return Collections.min(steps, Comparator.comparing(String::length).thenComparing(Function.identity()));`
	`156`	`+ case CYCLE: return Collections.min(steps, Comparator.comparingInt(String::length).thenComparing(Function.identity()));`
`157`	`157`	`case DIVERGE: throw new IllegalArgumentException("No canonical form for a diverging result");`
`158`	`158`	`default: throw new IllegalArgumentException("Unknown type: " + type);`
`159`	`159`	`}`
Original file line number	Diff line number	Diff line change
`@@ -299,7 +299,7 @@ private State createState() throws IOException, InterruptedException {`
`299`	`299`	`validateBiomeExecutable(resolvedPathToExe);`
`300`	`300`	`validateBiomeConfigPath(configPath, version);`
`301`	`301`	`LOGGER.debug("Using Biome executable located at '{}'", resolvedPathToExe);`
`302`		`- var exeSignature = FileSignature.signAsList(Set.of(new File(resolvedPathToExe)));`
	`302`	`+ var exeSignature = FileSignature.signAsList(new File(resolvedPathToExe));`
`303`	`303`	`makeExecutable(resolvedPathToExe);`
`304`	`304`	`return new State(resolvedPathToExe, exeSignature, configPath, language);`
`305`	`305`	`}`
Original file line number	Diff line number	Diff line change
`@@ -135,8 +135,9 @@ private static Provisioner forConfigurationContainer(Project project, Configurat`
`135`	`135`	`projName = projName + "/";`
`136`	`136`	`}`
`137`	`137`	`throw new GradleException(String.format(`
`138`		`- "You need to add a repository containing the '%s' artifact in '%sbuild.gradle'.%n"`
`139`		`- + "E.g.: 'repositories { mavenCentral() }'",`
	`138`	`+ """`
	`139`	`+ You need to add a repository containing the '%s' artifact in '%sbuild.gradle'.%n\`
	`140`	`+ E.g.: 'repositories { mavenCentral() }'""",`
`140`	`141`	`mavenCoords, projName), e);`
`141`	`142`	`}`
`142`	`143`	`};`