Improve Gradle integration

Author: blacelle

lib/src/main/java/com/diffplug/spotless/java/CleanthatJavaStep.java

@@ -52,10 +52,10 @@ public static FormatterStep create(Provisioner provisioner) {
 
 	/** Creates a step which apply default CleanThat mutators. */
 	public static FormatterStep create(String version, Provisioner provisioner) {
-		return create(MAVEN_COORDINATE, version, defaultJdkVersion(), defaultExcludedMutators(), defaultMutators(), provisioner);
+		return create(MAVEN_COORDINATE, version, defaultSourceJdk(), defaultExcludedMutators(), defaultMutators(), provisioner);
 	}
 
-	public static String defaultJdkVersion() {
+	public static String defaultSourceJdk() {
 		// see IJdkVersionConstants.JDK_7
 		// https://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#source
 		// 1.7 is the default for 'maven-compiler-plugin' since 3.9.0
@@ -114,7 +114,7 @@ static final class JavaRefactorerState implements Serializable {
 		final List<String> excluded;
 
 		JavaRefactorerState(String stepName, String version, Provisioner provisioner) throws IOException {
-			this(stepName, MAVEN_COORDINATE, version, defaultJdkVersion(), defaultExcludedMutators(), defaultMutators(), provisioner);
+			this(stepName, MAVEN_COORDINATE, version, defaultSourceJdk(), defaultExcludedMutators(), defaultMutators(), provisioner);
 		}
 
 		JavaRefactorerState(String stepName,

plugin-gradle/CHANGES.md

@@ -3,6 +3,8 @@
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `3.27.0`).
 
 ## [Unreleased]
+### Added
+* CleanThat Java Refactorer ([#1560](https://github.com/diffplug/spotless/pull/1560))
 
 ## [6.14.1] - 2023-02-05
 ### Fixed

plugin-gradle/README.md

@@ -54,7 +54,7 @@ Spotless supports all of Gradle's built-in performance features (incremental bui
 - [**Quickstart**](#quickstart)
   - [Requirements](#requirements)
 - **Languages**
-  - [Java](#java) ([google-java-format](#google-java-format), [eclipse jdt](#eclipse-jdt), [clang-format](#clang-format), [prettier](#prettier), [palantir-java-format](#palantir-java-format), [formatAnnotations](#formatAnnotations))
+  - [Java](#java) ([google-java-format](#google-java-format), [eclipse jdt](#eclipse-jdt), [clang-format](#clang-format), [prettier](#prettier), [palantir-java-format](#palantir-java-format), [formatAnnotations](#formatAnnotations), [cleanthat](#cleanthat))
   - [Groovy](#groovy) ([eclipse groovy](#eclipse-groovy))
   - [Kotlin](#kotlin) ([ktfmt](#ktfmt), [ktlint](#ktlint), [diktat](#diktat), [prettier](#prettier))
   - [Scala](#scala) ([scalafmt](#scalafmt))
@@ -154,6 +154,9 @@ spotless {
 
     removeUnusedImports()
 
+    // Cleanthat will refactor your code, but it may break your style: apply it before your formatter
+    cleanthat()          // has its own section below
+
     // Choose one of these formatters.
     googleJavaFormat()   // has its own section below
     eclipse()            // has its own section below
@@ -257,6 +260,23 @@ You can use `addTypeAnnotation()` and `removeTypeAnnotation()` to override its d
 
 You can make a pull request to add new annotations to Spotless's default list.
 
+### cleanthat
+
+[homepage](https://github.com/solven-eu/cleanthat). CleanThat enables automatic refactoring of Java code. [ChangeLog](https://github.com/solven-eu/cleanthat/blob/master/CHANGES.MD)
+
+```gradle
+spotless {
+  java {
+    cleanthat()
+    // optional: you can specify a specific version and/or config file
+    cleanthat()
+      .groupArtifact('1.7')                 // default is 'io.github.solven-eu.cleanthat:java'
+      .version('2.1')                             // You may force a past of -SNAPSHOT
+      .sourceCompatibility('1.7')                 // default is '1.7'
+      .addMutator('your.custom.MagicMutator')
+      .excludeMutator('UseCollectionIsEmpty')
+```
+
 
 <a name="applying-to-groovy-source"></a>
 

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/JavaExtension.java

@@ -281,7 +281,7 @@ public class CleanthatJavaConfig {
 
 		private String version = CleanthatJavaStep.defaultVersion();
 
-		private String sourceJdk = CleanthatJavaStep.defaultJdkVersion();
+		private String sourceJdk = CleanthatJavaStep.defaultSourceJdk();
 
 		private List<String> mutators = CleanthatJavaStep.defaultMutators();
 
@@ -305,9 +305,9 @@ public CleanthatJavaConfig version(String version) {
 			return this;
 		}
 
-		public CleanthatJavaConfig sourceJdk(String sourceJdk) {
-			Objects.requireNonNull(sourceJdk);
-			this.sourceJdk = sourceJdk;
+		public CleanthatJavaConfig sourceCompatibility(String jdkVersion) {
+			Objects.requireNonNull(jdkVersion);
+			this.sourceJdk = jdkVersion;
 			replaceStep(createStep());
 			return this;
 		}

plugin-maven/CHANGES.md

@@ -4,7 +4,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 
 ## [Unreleased]
 ### Added
-* CleanThat Java Refactorer ([#???](https://github.com/diffplug/spotless/pull/???))
+* CleanThat Java Refactorer ([#1560](https://github.com/diffplug/spotless/pull/1560))
 
 ## [2.32.0] - 2023-02-05
 ### Added

plugin-maven/src/main/java/com/diffplug/spotless/maven/java/CleanthatJava.java

@@ -33,7 +33,7 @@ public class CleanthatJava implements FormatterStepFactory {
 
 	// https://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#source
 	@Parameter(property = "maven.compiler.source")
-	private String sourceJdk = CleanthatJavaStep.defaultJdkVersion();
+	private String sourceJdk = CleanthatJavaStep.defaultSourceJdk();
 
 	@Parameter
 	private List<String> mutators = CleanthatJavaStep.defaultMutators();