[openrewrite] add SanityCheck featuring CommonStaticAnalysis (#2651)

Author: nedtwigg

gradle/rewrite.gradle

@@ -1,46 +1,10 @@
 apply plugin: 'org.openrewrite.rewrite'
 
 rewrite {
-	activeRecipe(
-			'org.openrewrite.gradle.GradleBestPractices',
-			'org.openrewrite.java.RemoveUnusedImports',
-			'org.openrewrite.java.format.RemoveTrailingWhitespace',
-			'org.openrewrite.java.migrate.UpgradeToJava17',
-			'org.openrewrite.java.recipes.JavaRecipeBestPractices',
-			'org.openrewrite.java.recipes.RecipeTestingBestPractices',
-			'org.openrewrite.java.security.JavaSecurityBestPractices',
-			'org.openrewrite.staticanalysis.EqualsAvoidsNull',
-			'org.openrewrite.staticanalysis.JavaApiBestPractices',
-			'org.openrewrite.staticanalysis.LowercasePackage',
-			'org.openrewrite.staticanalysis.MissingOverrideAnnotation',
-			'org.openrewrite.staticanalysis.ModifierOrder',
-			'org.openrewrite.staticanalysis.NoFinalizer',
-			'org.openrewrite.staticanalysis.NoToStringOnStringType',
-			'org.openrewrite.staticanalysis.NoValueOfOnStringType',
-			'org.openrewrite.staticanalysis.RemoveUnusedLocalVariables',
-			'org.openrewrite.staticanalysis.RemoveUnusedPrivateFields',
-			'org.openrewrite.staticanalysis.RemoveUnusedPrivateMethods',
-			'org.openrewrite.staticanalysis.UnnecessaryCloseInTryWithResources',
-			'org.openrewrite.staticanalysis.UnnecessaryExplicitTypeArguments',
-			'org.openrewrite.staticanalysis.UnnecessaryParentheses',
-			'org.openrewrite.staticanalysis.UnnecessaryReturnAsLastStatement',
-			'tech.picnic.errorprone.refasterrules.BigDecimalRulesRecipes',
-			'tech.picnic.errorprone.refasterrules.CharSequenceRulesRecipes',
-			'tech.picnic.errorprone.refasterrules.ClassRulesRecipes',
-			'tech.picnic.errorprone.refasterrules.CollectionRulesRecipes',
-			'tech.picnic.errorprone.refasterrules.ComparatorRulesRecipes',
-			'tech.picnic.errorprone.refasterrules.FileRulesRecipes',
-			'tech.picnic.errorprone.refasterrules.MicrometerRulesRecipes',
-			'tech.picnic.errorprone.refasterrules.PatternRulesRecipes',
-			'tech.picnic.errorprone.refasterrules.PreconditionsRulesRecipes',
-			'tech.picnic.errorprone.refasterrules.PrimitiveRulesRecipes',
-			'tech.picnic.errorprone.refasterrules.StreamRulesRecipes',
-			'tech.picnic.errorprone.refasterrules.TimeRulesRecipes'
-			//'org.openrewrite.staticanalysis.CodeCleanup', bug
-			//'org.openrewrite.staticanalysis.CommonStaticAnalysis', bug
-			//'org.openrewrite.staticanalysis.UnnecessaryThrows', bug
-			)
+	activeRecipe('com.diffplug.spotless.openrewrite.SanityCheck')
 	exclusions.addAll(
+			'**.dirty.java',
+			'**FormatterProperties.java',
 			'**_gradle_node_plugin_example_**',
 			'**gradle/changelog.gradle',
 			'**gradle/java-publish.gradle',
@@ -50,7 +14,9 @@ rewrite {
 			'**lib/build.gradle',
 			'**package-info.java',
 			'**plugin-maven/build.gradle',
-			'**settings.gradle'
+			'**settings.gradle',
+			'**special-tests.gradle',
+			'**testlib/src/main/resources**'
 			)
 	exportDatatables = true
 	failOnDryRunResults = true

lib-extra/src/groovy/java/com/diffplug/spotless/extra/glue/groovy/GrEclipseFormatterStepImpl.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 DiffPlug
+ * Copyright 2016-2025 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -130,15 +130,15 @@ public boolean errorsDetected() {
 			synchronized (GroovyLogManager.manager) {
 				GroovyLogManager.manager.removeLogger(this);
 			}
-			return 0 != errors.size();
+			return !errors.isEmpty();
 		}
 
 		@Override
 		public String toString() {
 			StringBuilder string = new StringBuilder();
 			if (1 < errors.size()) {
 				string.append("Multiple problems detected during step execution:");
-			} else if (0 == errors.size()) {
+			} else if (errors.isEmpty()) {
 				string.append("Step sucesfully executed.");
 			}
 			for (Throwable error : errors) {

lib-extra/src/jdt/java/com/diffplug/spotless/extra/glue/jdt/DefaultJavaElementComparator.java

@@ -164,23 +164,26 @@ private int category(BodyDeclaration bodyDeclaration) {
 				return CONSTRUCTORS_INDEX;
 			}
 			int flags = method.getModifiers();
-			if (Modifier.isStatic(flags))
+			if (Modifier.isStatic(flags)) {
 				return STATIC_METHODS_INDEX;
-			else
+			} else {
 				return METHOD_INDEX;
+			}
 		}
 		case ASTNode.FIELD_DECLARATION: {
-			if (JdtFlags.isStatic(bodyDeclaration))
+			if (JdtFlags.isStatic(bodyDeclaration)) {
 				return STATIC_FIELDS_INDEX;
-			else
+			} else {
 				return FIELDS_INDEX;
+			}
 		}
 		case ASTNode.INITIALIZER: {
 			int flags = bodyDeclaration.getModifiers();
-			if (Modifier.isStatic(flags))
+			if (Modifier.isStatic(flags)) {
 				return STATIC_INIT_INDEX;
-			else
+			} else {
 				return INIT_INDEX;
+			}
 		}
 		case ASTNode.TYPE_DECLARATION:
 		case ASTNode.ENUM_DECLARATION:

lib-extra/src/jdt/java/com/diffplug/spotless/extra/glue/jdt/EclipseJdtSortMembers.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 DiffPlug
+ * Copyright 2024-2025 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,7 +33,7 @@
 import org.eclipse.jdt.core.dom.AST;
 import org.eclipse.jdt.internal.core.SortElementsOperation;
 
-public class EclipseJdtSortMembers {
+public final class EclipseJdtSortMembers {
 
 	private static final Pattern PATTERN_DO_NOT_SORT_FIELDS = Pattern.compile("@SortMembers:doNotSortFields\\s*=\\s*(false|true)");
 	private static final Pattern PATTERN_ENABLED = Pattern.compile("@SortMembers:enabled\\s*=\\s*(false|true)");
@@ -244,4 +244,6 @@ static SortProperties from(Map<String, String> properties) {
 			return new SortProperties(enabled, membersOrder, doNotSortFields, sortByVisibility, visibilityOrder);
 		}
 	}
+
+	private EclipseJdtSortMembers() {}
 }

lib-extra/src/jdt/java/com/diffplug/spotless/extra/glue/jdt/JdtFlags.java

@@ -28,22 +28,26 @@
 /**
  * This class is derived and adapted code from the Eclipse JDT project (Derivative Works according to EPL 2.0 license).
  */
-class JdtFlags {
+final class JdtFlags {
 
 	static final int VISIBILITY_CODE_INVALID = -1;
 
 	static boolean isStatic(BodyDeclaration bodyDeclaration) {
-		if (isNestedInterfaceOrAnnotation(bodyDeclaration))
+		if (isNestedInterfaceOrAnnotation(bodyDeclaration)) {
 			return true;
+		}
 		int nodeType = bodyDeclaration.getNodeType();
 		if (nodeType != ASTNode.METHOD_DECLARATION
 				&& nodeType != ASTNode.ANNOTATION_TYPE_MEMBER_DECLARATION
-				&& isInterfaceOrAnnotationMember(bodyDeclaration))
+				&& isInterfaceOrAnnotationMember(bodyDeclaration)) {
 			return true;
-		if (bodyDeclaration instanceof EnumConstantDeclaration)
+		}
+		if (bodyDeclaration instanceof EnumConstantDeclaration) {
 			return true;
-		if (bodyDeclaration instanceof EnumDeclaration && bodyDeclaration.getParent() instanceof AbstractTypeDeclaration)
+		}
+		if (bodyDeclaration instanceof EnumDeclaration && bodyDeclaration.getParent() instanceof AbstractTypeDeclaration) {
 			return true;
+		}
 		return Modifier.isStatic(bodyDeclaration.getModifiers());
 	}
 
@@ -60,8 +64,9 @@ private static boolean isProtected(BodyDeclaration bodyDeclaration) {
 	}
 
 	private static boolean isPublic(BodyDeclaration bodyDeclaration) {
-		if (isInterfaceOrAnnotationMember(bodyDeclaration))
+		if (isInterfaceOrAnnotationMember(bodyDeclaration)) {
 			return true;
+		}
 		return Modifier.isPublic(bodyDeclaration.getModifiers());
 	}
 
@@ -80,15 +85,18 @@ private static boolean isNestedInterfaceOrAnnotation(BodyDeclaration bodyDeclara
 	}
 
 	static int getVisibilityCode(BodyDeclaration bodyDeclaration) {
-		if (isPublic(bodyDeclaration))
+		if (isPublic(bodyDeclaration)) {
 			return Modifier.PUBLIC;
-		else if (isProtected(bodyDeclaration))
+		} else if (isProtected(bodyDeclaration)) {
 			return Modifier.PROTECTED;
-		else if (isPackageVisible(bodyDeclaration))
+		} else if (isPackageVisible(bodyDeclaration)) {
 			return Modifier.NONE;
-		else if (isPrivate(bodyDeclaration))
+		} else if (isPrivate(bodyDeclaration)) {
 			return Modifier.PRIVATE;
+		}
 		Assert.isTrue(false);
 		return VISIBILITY_CODE_INVALID;
 	}
+
+	private JdtFlags() {}
 }

lib-extra/src/main/java/com/diffplug/spotless/extra/EclipseBasedStepBuilder.java

@@ -78,9 +78,7 @@ public EclipseBasedStepBuilder(String formatterName, String formatterStepExt, Pr
 
 	/** Returns the FormatterStep (whose state will be calculated lazily). */
 	public FormatterStep build() {
-		var roundtrippableState = new EclipseStep(formatterVersion, formatterStepExt, FileSignature.promise(settingsFiles), JarState.promise(() -> {
-			return JarState.withoutTransitives(dependencies, jarProvisioner);
-		}));
+		var roundtrippableState = new EclipseStep(formatterVersion, formatterStepExt, FileSignature.promise(settingsFiles), JarState.promise(() -> JarState.withoutTransitives(dependencies, jarProvisioner)));
 		return FormatterStep.create(formatterName + formatterStepExt, roundtrippableState,
 				EclipseStep::state, stateToFormatter);
 	}

lib-extra/src/main/java/com/diffplug/spotless/extra/EquoBasedStepBuilder.java

@@ -61,7 +61,7 @@ public abstract class EquoBasedStepBuilder {
 	private File cacheDirectory;
 
 	/** Initialize valid default configuration, taking latest version */
-	public EquoBasedStepBuilder(
+	protected EquoBasedStepBuilder(
 			String formatterName,
 			Provisioner mavenProvisioner,
 			@Nullable String defaultVersion,

lib-extra/src/main/java/com/diffplug/spotless/extra/GitAttributesLineEndings.java

@@ -177,13 +177,15 @@ public String endingFor(File file) {
 
 	static class RuntimeInit {
 		/** /etc/gitconfig (system-global), ~/.gitconfig (each might-not exist). */
-		final FileBasedConfig systemConfig, userConfig;
+		final FileBasedConfig systemConfig;
+		final FileBasedConfig userConfig;
 
 		/** Repository specific config, can be $GIT_COMMON_DIR/config, project/.git/config or .git/worktrees/<id>/config.worktree if enabled by extension */
 		final Config repoConfig;
 
 		/** Global .gitattributes file pointed at by systemConfig or userConfig, and the file in the repo. */
-		final @Nullable File globalAttributesFile, repoAttributesFile;
+		final @Nullable File globalAttributesFile;
+		final @Nullable File repoAttributesFile;
 
 		/** git worktree root, might not exist if we're not in a git repo. */
 		final @Nullable File workTree;
@@ -235,7 +237,7 @@ private Runtime atRuntime() {
 	}
 
 	/** https://github.com/git/git/blob/1fe8f2cf461179c41f64efbd1dc0a9fb3b7a0fb1/Documentation/gitattributes.txt */
-	static class Runtime {
+	static final class Runtime {
 		/** .git/info/attributes (and the worktree with that file) */
 		final List<AttributesRule> infoRules;
 

lib-extra/src/main/java/com/diffplug/spotless/extra/GitRatchet.java

@@ -62,7 +62,7 @@ public boolean isClean(Project project, ObjectId treeSha, File file) throws IOEx
 		return isClean(project, treeSha, relativePath);
 	}
 
-	private Map<Repository, DirCache> dirCaches = new HashMap<>();
+	private final Map<Repository, DirCache> dirCaches = new HashMap<>();
 
 	/**
 	 * This is the highest-level method, which all the others serve.  Given the sha

lib-extra/src/main/java/com/diffplug/spotless/extra/GitWorkarounds.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2023 DiffPlug
+ * Copyright 2020-2025 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -202,7 +202,7 @@ private static IOException emptyFile(File commonDir) {
 			return new IOException("Empty 'commondir' file: " + commonDir.getAbsolutePath());
 		}
 
-		@SuppressFBWarnings(value = "BC_UNCONFIRMED_CAST_OF_RETURN_VALUE")
+		@SuppressFBWarnings("BC_UNCONFIRMED_CAST_OF_RETURN_VALUE")
 		@Override
 		public FileRepositoryBuilder readEnvironment(SystemReader sr) {
 			super.readEnvironment(sr);