[Experimental] Add rewrite support for RemoveUnusedPrivateMethods & RemoveUnusedImports

Author: Vincent Potucek

.github/workflows/ci.yml

@@ -31,6 +31,8 @@ jobs:
         uses: gradle/actions/setup-gradle@v4
       - name: spotlessCheck
         run: ./gradlew spotlessCheck
+      - name: rewriteDryRun
+        run: ./gradlew rewriteDryRun
       - name: assemble testClasses
         run: ./gradlew assemble testClasses
   build:
@@ -66,10 +68,10 @@ jobs:
         uses: gradle/actions/setup-gradle@v4
       - name: build (maven-only)
         if: matrix.kind == 'maven'
-        run: ./gradlew :plugin-maven:build -x spotlessCheck
+        run: ./gradlew :plugin-maven:build -x spotlessCheck -x rewriteDryRun
       - name: build (everything-but-maven)
         if: matrix.kind == 'gradle'
-        run: ./gradlew build -x spotlessCheck -PSPOTLESS_EXCLUDE_MAVEN=true
+        run: ./gradlew build -x spotlessCheck -x rewriteDryRun -PSPOTLESS_EXCLUDE_MAVEN=true
       - name: test npm
         if: matrix.kind == 'npm'
         run: ./gradlew testNpm

CHANGES.md

@@ -16,6 +16,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
   * Adds support for worktrees (fixes [#1765](https://github.com/diffplug/spotless/issues/1765))
 * Bump default `google-java-format` version to latest `1.24.0` -> `1.28.0`. ([#2345](https://github.com/diffplug/spotless/pull/2345))
 * Bump default `ktlint` version to latest `1.5.0` -> `1.7.1`. ([#2555](https://github.com/diffplug/spotless/pull/2555))
+* [Experimental] Add `rewrite` support for `RemoveUnusedPrivateMethods` & `RemoveUnusedImports` ([#2576](https://github.com/diffplug/spotless/pull/2576))
 
 ## [3.3.1] - 2025-07-21
 ### Fixed

build.gradle

@@ -1,4 +1,14 @@
 apply plugin: 'dev.equo.ide'
+
+apply from: rootProject.file('gradle/changelog.gradle')
+apply from: rootProject.file('gradle/java-publish.gradle')
+apply from: rootProject.file('gradle/spotless-freshmark.gradle')
+
+allprojects {
+	apply from: rootProject.file('gradle/spotless.gradle')
+	apply from: rootProject.file('gradle/rewrite.gradle')
+}
+
 equoIde {
 	branding().title('Spotless').icon(file('_images/spotless_logo.png'))
 	welcome().openUrl('https://github.com/diffplug/spotless/blob/main/CONTRIBUTING.md')
@@ -9,21 +19,10 @@ repositories {
 	mavenCentral()
 }
 
-apply from: rootProject.file('gradle/java-publish.gradle')
-apply from: rootProject.file('gradle/changelog.gradle')
-allprojects {
-	apply from: rootProject.file('gradle/spotless.gradle')
-}
-apply from: rootProject.file('gradle/spotless-freshmark.gradle')
-
-spotless {
-	groovyGradle {
-		target '*.gradle', 'gradle/*.gradle'
-	}
-	format 'dotfiles', {
-		target '.gitignore', '.gitattributes', '.editorconfig'
-		leadingTabsToSpaces(2)
-		trimTrailingWhitespace()
-		endWithNewline()
-	}
+dependencies {
+	rewrite(
+			"org.openrewrite.recipe:rewrite-rewrite:0.10.1",
+			"org.openrewrite.recipe:rewrite-static-analysis:2.12.0",
+			"org.openrewrite.recipe:rewrite-third-party:0.24.1"
+			)
 }

gradle/rewrite.gradle

@@ -0,0 +1,55 @@
+apply plugin: 'org.openrewrite.rewrite'
+
+rewrite {
+	activeRecipe(
+			"org.openrewrite.gradle.GradleBestPractices",
+			"org.openrewrite.java.OrderImports",
+			"org.openrewrite.java.RemoveUnusedImports",
+			"org.openrewrite.java.format.RemoveTrailingWhitespace",
+			"org.openrewrite.java.recipes.JavaRecipeBestPractices",
+			"org.openrewrite.java.recipes.RecipeTestingBestPractices",
+			"org.openrewrite.staticanalysis.EmptyBlock",
+			"org.openrewrite.staticanalysis.EqualsAvoidsNull",
+			"org.openrewrite.staticanalysis.JavaApiBestPractices",
+			"org.openrewrite.staticanalysis.MissingOverrideAnnotation",
+			"org.openrewrite.staticanalysis.ModifierOrder",
+			"org.openrewrite.staticanalysis.NoFinalizer",
+			"org.openrewrite.staticanalysis.RemoveCallsToSystemGc",
+			"org.openrewrite.staticanalysis.RemoveUnneededAssertion",
+			"org.openrewrite.staticanalysis.RemoveUnusedLocalVariables",
+			"org.openrewrite.staticanalysis.RemoveUnusedPrivateFields",
+			"org.openrewrite.staticanalysis.RemoveUnusedPrivateMethods",
+			"org.openrewrite.staticanalysis.StringLiteralEquality",
+			"org.openrewrite.staticanalysis.UnnecessaryParentheses",
+			"org.openrewrite.text.EndOfLineAtEndOfFile",
+			"tech.picnic.errorprone.refasterrules.AssertJStringRulesRecipes"
+			// bugs
+			//"org.openrewrite.java.recipes.RecipeNullabilityBestPractices",
+			//"org.openrewrite.staticanalysis.CodeCleanup",
+			//"org.openrewrite.staticanalysis.UnnecessaryThrows",
+			)
+	// bugs
+	exclusions.add("**package-info.java")
+	exclusions.add("**AJacksonFormatterFunc.java")
+	exclusions.add("**gradle/java-publish.gradle")
+	failOnDryRunResults = true
+}
+
+// off switch for release: ' -x check' or ' -x rewriteDryRun'
+//tasks {
+//	check.dependsOn(rewriteDryRun)
+//}
+
+// > Task :rewriteDryRun FAILED
+//
+//2 problems were found storing the configuration cache.
+//- Task `:rewriteDryRun` of type `org.openrewrite.gradle.RewriteDryRunTask`: cannot serialize object of type 'org.gradle.api.internal.project.DefaultProject', a subtype of 'org.gradle.api.Project', as these are not supported with the configuration cache.
+//  See https://docs.gradle.org/8.14.3/userguide/configuration_cache.html#config_cache:requirements:disallowed_types
+//- Task `:rewriteDryRun` of type `org.openrewrite.gradle.RewriteDryRunTask`: invocation of 'Task.project' at execution time is unsupported.
+//  See https://docs.gradle.org/8.14.3/userguide/configuration_cache.html#config_cache:requirements:use_project_during_execution
+
+// FAILURE: Build failed with an exception.
+//
+//* What went wrong:
+//Execution failed for task ':rewriteDryRun'.
+//> java.lang.RuntimeException: Applying recipes would make changes. See logs for more details.

gradle/spotless.gradle

@@ -1,33 +1,38 @@
 apply plugin: 'com.diffplug.spotless'
+
 spotless {
+	groovyGradle {
+		target '*.gradle', 'gradle/*.gradle'
+		greclipse().configFile rootProject.files('gradle/spotless.eclipseformat.xml', 'gradle/spotless.groovyformat.prefs')
+	}
+	format 'dotfiles', {
+		target '.gitignore', '.gitattributes', '.editorconfig'
+		leadingTabsToSpaces(2)
+		trimTrailingWhitespace()
+		endWithNewline()
+	}
 	def noInternalDepsClosure = {
 		String text = it
 		/*
 		 * No good way to get around using this import:
 		 * https://github.com/gradle/gradle/issues/3191
 		 */
 		String regex = "import org\\.gradle\\.api\\.internal\\.(?!plugins\\.DslObject)(?!project\\.ProjectInternal)"
-		if ((text.contains('import org.gradle.internal.') || text.find(regex)) &&
-				!text.contains('def noInternalDepsClosure')) {
+		if ((text.contains('import org.gradle.internal.') || text.find(regex))
+				&& !text.contains('def noInternalDepsClosure')) {
 			throw new AssertionError("Accidental internal import")
 		}
 	}
-	if (project != rootProject) {
-		// the rootProject doesn't have any java
-		java {
-			ratchetFrom 'origin/main'
-			bumpThisNumberIfACustomStepChanges(1)
-			licenseHeaderFile rootProject.file('gradle/spotless.license')
-			importOrderFile   rootProject.file('gradle/spotless.importorder')
-			eclipse().configFile rootProject.file('gradle/spotless.eclipseformat.xml')
-			trimTrailingWhitespace()
-			removeUnusedImports()
-			formatAnnotations()
-			custom 'noInternalDeps', noInternalDepsClosure
-		}
-	}
-	groovyGradle {
-		target '*.gradle'
-		greclipse().configFile rootProject.files('gradle/spotless.eclipseformat.xml', 'gradle/spotless.groovyformat.prefs')
+	java {
+		target '*.gitignore'
+		ratchetFrom 'origin/main'
+		bumpThisNumberIfACustomStepChanges(1)
+		licenseHeaderFile rootProject.file('gradle/spotless.license')
+		importOrderFile   rootProject.file('gradle/spotless.importorder')
+		eclipse().configFile rootProject.file('gradle/spotless.eclipseformat.xml')
+		trimTrailingWhitespace()
+		removeUnusedImports()
+		formatAnnotations()
+		custom 'noInternalDeps', noInternalDepsClosure
 	}
 }

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

@@ -19,12 +19,12 @@
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.nio.file.Files;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
-import java.util.Map;
-import java.util.Properties;
+import java.util.*;
 
+import dev.equo.solstice.NestedJars;
+import dev.equo.solstice.ShimIdeBootstrapServices;
+import dev.equo.solstice.Solstice;
+import dev.equo.solstice.p2.CacheLocations;
 import org.codehaus.groovy.eclipse.GroovyLogManager;
 import org.codehaus.groovy.eclipse.IGroovyLogger;
 import org.codehaus.groovy.eclipse.TraceCategory;
@@ -43,11 +43,6 @@
 import org.eclipse.text.edits.TextEdit;
 import org.osgi.framework.Constants;
 
-import dev.equo.solstice.NestedJars;
-import dev.equo.solstice.ShimIdeBootstrapServices;
-import dev.equo.solstice.Solstice;
-import dev.equo.solstice.p2.CacheLocations;
-
 /** Spotless-Formatter step which calls out to the Groovy-Eclipse formatter. */
 public class GrEclipseFormatterStepImpl {
 	static {

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

@@ -20,17 +20,7 @@
 import java.util.StringTokenizer;
 
 import org.eclipse.jdt.core.Flags;
-import org.eclipse.jdt.core.dom.ASTNode;
-import org.eclipse.jdt.core.dom.AbstractTypeDeclaration;
-import org.eclipse.jdt.core.dom.AnnotationTypeMemberDeclaration;
-import org.eclipse.jdt.core.dom.BodyDeclaration;
-import org.eclipse.jdt.core.dom.EnumConstantDeclaration;
-import org.eclipse.jdt.core.dom.FieldDeclaration;
-import org.eclipse.jdt.core.dom.MethodDeclaration;
-import org.eclipse.jdt.core.dom.Modifier;
-import org.eclipse.jdt.core.dom.SingleVariableDeclaration;
-import org.eclipse.jdt.core.dom.Type;
-import org.eclipse.jdt.core.dom.VariableDeclarationFragment;
+import org.eclipse.jdt.core.dom.*;
 import org.eclipse.jdt.core.util.CompilationUnitSorter;
 import org.eclipse.jdt.internal.core.dom.NaiveASTFlattener;
 
@@ -368,8 +358,8 @@ private boolean isSortPreserved(BodyDeclaration bodyDeclaration) {
 	}
 
 	private int preserveRelativeOrder(BodyDeclaration bodyDeclaration1, BodyDeclaration bodyDeclaration2) {
-		int value1 = ((Integer) bodyDeclaration1.getProperty(CompilationUnitSorter.RELATIVE_ORDER));
-		int value2 = ((Integer) bodyDeclaration2.getProperty(CompilationUnitSorter.RELATIVE_ORDER));
+		int value1 = (Integer) bodyDeclaration1.getProperty(CompilationUnitSorter.RELATIVE_ORDER);
+		int value2 = (Integer) bodyDeclaration2.getProperty(CompilationUnitSorter.RELATIVE_ORDER);
 		return value1 - value2;
 	}
 

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

@@ -24,12 +24,7 @@
 import org.eclipse.core.resources.IResource;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IProgressMonitor;
-import org.eclipse.jdt.core.IBuffer;
-import org.eclipse.jdt.core.IBufferChangedListener;
-import org.eclipse.jdt.core.ICompilationUnit;
-import org.eclipse.jdt.core.IJavaElement;
-import org.eclipse.jdt.core.IOpenable;
-import org.eclipse.jdt.core.JavaModelException;
+import org.eclipse.jdt.core.*;
 import org.eclipse.jdt.core.dom.AST;
 import org.eclipse.jdt.internal.core.SortElementsOperation;
 

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

@@ -16,14 +16,7 @@
 package com.diffplug.spotless.extra.glue.jdt;
 
 import org.eclipse.core.runtime.Assert;
-import org.eclipse.jdt.core.dom.ASTNode;
-import org.eclipse.jdt.core.dom.AbstractTypeDeclaration;
-import org.eclipse.jdt.core.dom.AnnotationTypeDeclaration;
-import org.eclipse.jdt.core.dom.BodyDeclaration;
-import org.eclipse.jdt.core.dom.EnumConstantDeclaration;
-import org.eclipse.jdt.core.dom.EnumDeclaration;
-import org.eclipse.jdt.core.dom.Modifier;
-import org.eclipse.jdt.core.dom.TypeDeclaration;
+import org.eclipse.jdt.core.dom.*;
 
 /**
  * This class is derived and adapted code from the Eclipse JDT project (Derivative Works according to EPL 2.0 license).
@@ -48,7 +41,7 @@ && isInterfaceOrAnnotationMember(bodyDeclaration))
 	}
 
 	private static boolean isPackageVisible(BodyDeclaration bodyDeclaration) {
-		return (!isPrivate(bodyDeclaration) && !isProtected(bodyDeclaration) && !isPublic(bodyDeclaration));
+		return !isPrivate(bodyDeclaration) && !isProtected(bodyDeclaration) && !isPublic(bodyDeclaration);
 	}
 
 	private static boolean isPrivate(BodyDeclaration bodyDeclaration) {

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

@@ -15,25 +15,15 @@
  */
 package com.diffplug.spotless.extra;
 
-import java.io.ByteArrayOutputStream;
-import java.io.File;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.Serializable;
+import java.io.*;
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
 import java.util.Properties;
 
 import com.diffplug.common.base.Errors;
-import com.diffplug.spotless.FileSignature;
-import com.diffplug.spotless.FormatterFunc;
-import com.diffplug.spotless.FormatterProperties;
-import com.diffplug.spotless.FormatterStep;
-import com.diffplug.spotless.JarState;
-import com.diffplug.spotless.Provisioner;
-import com.diffplug.spotless.SerializedFunction;
+import com.diffplug.spotless.*;
 
 /**
  * Generic Eclipse based formatter step {@link State} builder.