com.diffplug.spotless 5.0

Author: nedtwigg

.circleci/config.yml

@@ -92,17 +92,6 @@ jobs:
           command: ./gradlew :plugin-maven:check --build-cache
       - store_test_results:
           path: plugin-maven/build/test-results/test
-  test_gradle_modern_8:
-    << : *env_gradle
-    steps:
-      - checkout
-      - *restore_cache_wrapper
-      - *restore_cache_deps
-      - run:
-          name: gradlew :plugin-gradle:modernTest
-          command: ./gradlew :plugin-gradle:modernTest --build-cache
-      - store_test_results:
-          path: plugin-gradle/build/test-results/modernTest
   test_npm_8:
     << : *env_gradle
     docker:
@@ -223,9 +212,6 @@ workflows:
       - test_npm_8:
           requires:
             - assemble_testClasses
-      - test_gradle_modern_8:
-          requires:
-            - assemble_testClasses
   deploy:
     jobs:
       - changelog_print:

plugin-gradle/CHANGES-5.x-PREVIEW.md

@@ -2,10 +2,37 @@
 
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `3.27.0`).
 
-**5.x preview:** If you are using Gradle 5.4+, you can preview thew upcoming `com.diffplug.spotless` plugin by adding `-PspotlessModern`, see [CHANGES-5.x-PREVIEW.md](CHANGES-5.x-PREVIEW.md) for details.
-
 ## [Unreleased]
 
+This release is *exactly* the same as `4.5.1`, except:
+
+- it now has plugin id `com.diffplug.spotless`, rather than `com.diffplug.gradle.spotless` ([why](https://dev.to/nedtwigg/names-in-java-maven-and-gradle-2fm2))
+- the minimum required Gradle has bumped from `2.14` to `5.4`
+- all deprecated functionality has been removed
+- `-PspotlessModern=true` (introduced in [`4.3.0`](#430---2020-06-05)) is now always on
+
+If `id 'com.diffplug.gradle.spotless' version '4.5.1'` works without deprecation warnings, then you can upgrade to `id 'com.diffplug.spotless' version '5.0.0'` and no changes will be required.
+
+* **BREAKING** All deprecated functionality has been removed ([#640](https://github.com/diffplug/spotless/pull/640)).
+  * (dev-only) `SpotlessTask` was deleted, and `SpotlessTaskModern` was renamed to `SpotlessTask` (ditto for `SpotlessPlugin` and `SpotlessExtension`).
+* Introduced in earlier versions, but formerly gated behind `-PspotlessModern=true`
+  * We now calculate incremental builds using the new `InputChanges` rather than the deprecated `IncrementalTaskInputs`. ([#607](https://github.com/diffplug/spotless/pull/607))
+  * We now use Gradle's config avoidance APIs. ([#617](https://github.com/diffplug/spotless/pull/617))
+  * Spotless no longer creates any tasks eagerly. ([#622](https://github.com/diffplug/spotless/pull/622))
+  * **BREAKING** The closures inside each format specification are now executed lazily on task configuration. ([#618](https://github.com/diffplug/spotless/pull/618))
+
+```groovy
+String isEager = 'nope'
+spotless {
+    java {
+        isEager = 'yup'
+    }
+}
+println "isEager $isEager"
+// 'com.diffplug.gradle.spotless' -> isEager yup
+// 'com.diffplug.spotless'        -> isEager nope
+```
+
 ## [4.5.1] - 2020-07-04
 ### Fixed
 * Git-native handling of line endings was broken, now fixed ([#639](https://github.com/diffplug/spotless/pull/639)).

plugin-gradle/CHANGES.md

@@ -120,7 +120,9 @@ Spotless supports all of Gradle's built-in performance features (incremental bui
 
 ### Requirements
 
-Spotless requires JRE 8+, and Gradle 2.14+.  Some steps require JRE 11+, `Unsupported major.minor version` means you're using a step that needs a newer JRE.
+Spotless requires JRE 8+, and Gradle 5.4+.  Some steps require JRE 11+, `Unsupported major.minor version` means you're using a step that needs a newer JRE.
+
+If you're stuck on an older version of Gradle, `id 'com.diffplug.gradle.spotless' version '4.5.1'` supports all the way back to Gradle 2.x`.
 
 <a name="applying-to-java-source"></a>
 

plugin-gradle/README.md

@@ -41,13 +41,6 @@ task npmTest(type: Test) {
 	}
 }
 
-task modernTest(type: Test) {
-	systemProperty 'spotlessModern', 'true'
-	useJUnit {
-		excludeCategories 'com.diffplug.spotless.category.NpmTest', 'com.diffplug.gradle.spotless.ExcludeFromPluginGradleModern'
-	}
-}
-
 // make it easy for eclipse to run against latest build
 tasks.eclipse.dependsOn(pluginUnderTestMetadata)
 
@@ -57,11 +50,17 @@ tasks.eclipse.dependsOn(pluginUnderTestMetadata)
 gradlePlugin {
 	plugins {
 		spotlessPlugin {
-			id = 'com.diffplug.gradle.spotless'
+			id = 'com.diffplug.spotless'
 			implementationClass = 'com.diffplug.gradle.spotless.SpotlessPlugin'
 			displayName = 'Spotless formatting plugin'
 			description = project.description
 		}
+		spotlessPluginLegacy {
+			id = 'com.diffplug.gradle.spotless'
+			implementationClass = 'com.diffplug.gradle.spotless.SpotlessPluginRedirect'
+			displayName = 'Spotless formatting plugin (legacy)'
+			description = project.description
+		}
 	}
 }
 if (version.endsWith('-SNAPSHOT')) {
@@ -87,6 +86,9 @@ if (version.endsWith('-SNAPSHOT')) {
 		]
 		plugins {
 			spotlessPlugin {
+				id = 'com.diffplug.spotless'
+			}
+			spotlessPluginLegacy {
 				id = 'com.diffplug.gradle.spotless'
 			}
 		}

plugin-gradle/build.gradle

@@ -24,7 +24,7 @@
 public class Antlr4Extension extends FormatExtension implements HasBuiltinDelimiterForLicense {
 	static final String NAME = "antlr4";
 
-	public Antlr4Extension(SpotlessExtensionBase rootExtension) {
+	public Antlr4Extension(SpotlessExtension rootExtension) {
 		super(rootExtension);
 	}
 

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

@@ -17,11 +17,6 @@
 
 import static com.diffplug.gradle.spotless.PluginGradlePreconditions.requireElementsNonNull;
 
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.List;
-import java.util.stream.Collectors;
-
 import org.gradle.api.Project;
 
 import com.diffplug.spotless.cpp.CppDefaults;
@@ -31,32 +26,18 @@
 public class CppExtension extends FormatExtension implements HasBuiltinDelimiterForLicense {
 	static final String NAME = "cpp";
 
-	public CppExtension(SpotlessExtensionBase spotless) {
+	public CppExtension(SpotlessExtension spotless) {
 		super(spotless);
 	}
 
 	public EclipseConfig eclipseCdt() {
-		return new EclipseConfig(EclipseCdtFormatterStep.defaultVersion());
+		return eclipseCdt(EclipseCdtFormatterStep.defaultVersion());
 	}
 
 	public EclipseConfig eclipseCdt(String version) {
 		return new EclipseConfig(version);
 	}
 
-	/** Use {@link #eclipseCdt} instead. */
-	@Deprecated
-	public EclipseConfig eclipse() {
-		getProject().getLogger().warn("Spotless: in the `cpp { }` block, use `eclipseCdt()` instead of `eclipse()`");
-		return new EclipseConfig(EclipseCdtFormatterStep.defaultVersion());
-	}
-
-	/** Use {@link #eclipseCdt} instead. */
-	@Deprecated
-	public EclipseConfig eclipse(String version) {
-		getProject().getLogger().warn("Spotless: in the `cpp { }` block, use `eclipseCdt('" + version + "')` instead of `eclipse('" + version + "')`");
-		return new EclipseConfig(version);
-	}
-
 	public class EclipseConfig {
 		private final EclipseBasedStepBuilder builder;
 
@@ -77,29 +58,11 @@ public void configFile(Object... configFiles) {
 	@Override
 	protected void setupTask(SpotlessTask task) {
 		if (target == null) {
-			/*
-			 * The org.gradle.language.c and org.gradle.language.cpp source sets are seldom used.
-			 * Most Gradle C/C++ use external CMake builds (so the source location is unknown to Gradle).
-			 * Hence file extension based filtering is used in line with the org.eclipse.core.contenttype.contentTypes<
-			 * defined by the CDT plugin.
-			 */
-			noDefaultTarget();
-			target(FILE_FILTER.toArray());
+			throw noDefaultTargetException();
 		}
 		super.setupTask(task);
 	}
 
-	/**
-	 * Filter based on Eclipse-CDT <code>org.eclipse.core.contenttype.contentTypes</code>
-	 * extension <code>cSource</code>, <code>cHeader</code>, <code>cxxSource</code> and <code>cxxHeader</code>.
-	 */
-	@Deprecated
-	private static final List<String> FILE_FILTER = Collections.unmodifiableList(
-			Arrays.asList("c", "h", "C", "cpp", "cxx", "cc", "c++", "h", "hpp", "hh", "hxx", "inc")
-					.stream().map(s -> {
-						return "**/*." + s;
-					}).collect(Collectors.toList()));
-
 	@Override
 	public LicenseHeaderConfig licenseHeader(String licenseHeader) {
 		return licenseHeader(licenseHeader, CppDefaults.DELIMITER_EXPR);