Merge remote-tracking branch 'origin/main' into EnforceVar_jdk11

Author: blacelle

.github/workflows/ci.yml

@@ -6,6 +6,8 @@ on:
   pull_request:
   push:
     branches: [main]
+  workflow_dispatch:
+
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
@@ -31,9 +33,9 @@ jobs:
         with:
           gradle-home-cache-cleanup: true
       - name: spotlessCheck
-        run: ./gradlew spotlessCheck --build-cache
+        run: ./gradlew spotlessCheck
       - name: assemble testClasses
-        run: ./gradlew assemble testClasses --build-cache
+        run: ./gradlew assemble testClasses
   build:
     needs: sanityCheck
     strategy:
@@ -69,13 +71,13 @@ jobs:
           gradle-home-cache-cleanup: true
       - name: build (maven-only)
         if: matrix.kind == 'maven'
-        run: ./gradlew :plugin-maven:build -x spotlessCheck --build-cache
+        run: ./gradlew :plugin-maven:build -x spotlessCheck
       - name: build (everything-but-maven)
         if: matrix.kind == 'gradle'
-        run: ./gradlew build -x spotlessCheck --build-cache -PSPOTLESS_EXCLUDE_MAVEN=true
+        run: ./gradlew build -x spotlessCheck -PSPOTLESS_EXCLUDE_MAVEN=true
       - name: test npm
         if: matrix.kind == 'npm'
-        run: ./gradlew testNpm --build-cache
+        run: ./gradlew testNpm
       - name: junit result
         uses: mikepenz/action-junit-report@v3
         if: always() # always run even if the previous step fails

CHANGES.md

@@ -10,6 +10,19 @@ This document is intended for Spotless developers.
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`).
 
 ## [Unreleased]
+### Changes
+* We are now opting in to Gradle's new stable configuration cache. ([#1591](https://github.com/diffplug/spotless/pull/1591))
+
+## [2.36.0] - 2023-02-27
+### Added
+* `gradlew equoIde` opens a repeatable clean Spotless dev environment. ([#1523](https://github.com/diffplug/spotless/pull/1523))
+* `cleanthat` added `includeDraft` option, to include draft mutators from composite mutators. ([#1574](https://github.com/diffplug/spotless/pull/1574))
+* `npm`-based formatters now support caching of `node_modules` directory ([#1590](https://github.com/diffplug/spotless/pull/1590))
+### Fixed
+* `JacksonJsonFormatterFunc` handles json files with an Array as root. ([#1585](https://github.com/diffplug/spotless/pull/1585))
+### Changes
+* Bump default `cleanthat` version to latest `2.1` -> `2.6` ([#1569](https://github.com/diffplug/spotless/pull/1569) and [#1574](https://github.com/diffplug/spotless/pull/1574))
+* Reduce logging-noise created by `npm`-based formatters ([#1590](https://github.com/diffplug/spotless/pull/1590) fixes [#1582](https://github.com/diffplug/spotless/issues/1582))
 
 ## [2.35.0] - 2023-02-10
 ### Added

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to Spotless
 
-Pull requests are welcome, preferably against `main`.  Feel free to develop spotless any way you like.
+Pull requests are welcome, preferably against `main`.  Feel free to develop spotless any way you like, but if you like Eclipse and Gradle Buildship then [`gradlew equoIde` will install an IDE and set it up for you](https://github.com/equodev/equo-ide).
 
 ## How Spotless works
 

_ext/gradle/p2-fat-jar-setup.gradle

@@ -12,7 +12,7 @@ ext {
 		p2Dependencies = "p2Dependencies not defined in project"
 	}
 
-	// Some JARs may include JARs themselfs, which shall be unpacked and added to the embedded class folder. 
+	// Some JARs may include JARs themselfs, which shall be unpacked and added to the embedded class folder.
 	if (!project.hasProperty('internalJars')) {
 		internalJars = []
 	}
@@ -35,13 +35,13 @@ ext {
 			'META-INF/*.SF', // ... so all signatures are filtered
 		]
 	}
-	
+
 	// Map fat-JAR resources path if JAR file name does not correspond to plugin package name (e.g. required for internal plugins)
 	if (!project.hasProperty('fatJarResourcesMap')) {
 		fatJarResourcesMap = [:]
 	}
-	  
-	
+
+
 	// The directory contains all external classes for the fat-jar
 	embeddedClassesDirName = 'build/embeddedClasses'
 	embeddedClassesDir = project.file(embeddedClassesDirName)
@@ -163,3 +163,7 @@ apply plugin: 'idea'
 // Encure that the dependent classes are preovided for compilation if project is build via Eclipse instead of command line
 tasks.idea.dependsOn(unjarEmbeddedClasses)
 
+tasks.named('ideaModule') {
+	notCompatibleWithConfigurationCache("https://github.com/gradle/gradle/issues/13480")
+}
+

build.gradle

@@ -1,3 +1,17 @@
+plugins {
+	// https://github.com/equodev/equo-ide/blob/main/plugin-gradle/CHANGELOG.md
+	id 'dev.equo.ide'                          version '0.16.0'
+}
+equoIde {
+	branding().title('Spotless').icon(file('_images/spotless_logo.png'))
+	welcome().openUrl('https://github.com/diffplug/spotless/blob/main/CONTRIBUTING.md')
+	gradleBuildship()
+}
+
+repositories {
+	mavenCentral()
+}
+
 apply from: rootProject.file('gradle/java-publish.gradle')
 apply from: rootProject.file('gradle/changelog.gradle')
 allprojects {

gradle.properties

@@ -1,5 +1,9 @@
 # To fix metaspace errors
-org.gradle.jvmargs=-Xmx2g -XX:MaxMetaspaceSize=1024m -Dfile.encoding=UTF-8
+org.gradle.jvmargs=-Xmx4g -XX:MaxMetaspaceSize=1024m -Dfile.encoding=UTF-8
+org.gradle.parallel=true
+org.gradle.caching=true
+org.gradle.unsafe.configuration-cache=true
+
 name=spotless
 description=Spotless - keep your code spotless with Gradle
 org=diffplug

gradle/java-publish.gradle

@@ -200,6 +200,10 @@ if (System.env['JITPACK'] == 'true' || version.endsWith('-SNAPSHOT')) {
 	}
 }
 
+tasks.withType(Sign).configureEach {
+	notCompatibleWithConfigurationCache("https://github.com/gradle/gradle/issues/13470")
+}
+
 tasks.withType(AbstractArchiveTask).configureEach {
 	preserveFileTimestamps = false
 	reproducibleFileOrder = true

gradle/java-setup.gradle

@@ -30,6 +30,7 @@ tasks.withType(com.github.spotbugs.snom.SpotBugsTask).configureEach {
 	reports {
 		html.enabled = true
 	}
+	notCompatibleWithConfigurationCache("https://github.com/spotbugs/spotbugs-gradle-plugin/issues/670")
 }
 
 tasks.named('spotbugsMain') {

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

lib/build.gradle

@@ -56,6 +56,8 @@ tasks.named("check").configure {
 
 dependencies {
 	compileOnly 'org.slf4j:slf4j-api:2.0.0'
+	testCommonImplementation 'org.slf4j:slf4j-api:2.0.0'
+
 	// zero runtime reqs is a hard requirements for spotless-lib
 	// if you need a dep, put it in lib-extra
 	testCommonImplementation "org.junit.jupiter:junit-jupiter:$VER_JUNIT"
@@ -108,8 +110,8 @@ dependencies {
 
 	gsonCompileOnly 'com.google.code.gson:gson:2.10.1'
 
-	cleanthatCompileOnly 'io.github.solven-eu.cleanthat:java:2.2'
-	compatCleanthat2Dot1CompileAndTestOnly 'io.github.solven-eu.cleanthat:java:2.2'
+	cleanthatCompileOnly 'io.github.solven-eu.cleanthat:java:2.6'
+	compatCleanthat2Dot1CompileAndTestOnly 'io.github.solven-eu.cleanthat:java:2.6'
 }
 
 // we'll hold the core lib to a high standard

lib/src/cleanthat/java/com/diffplug/spotless/glue/java/JavaCleanthatRefactorerFunc.java

@@ -42,15 +42,17 @@ public class JavaCleanthatRefactorerFunc implements FormatterFunc {
 	private String jdkVersion;
 	private List<String> included;
 	private List<String> excluded;
+	private boolean includeDraft;
 
-	public JavaCleanthatRefactorerFunc(String jdkVersion, List<String> included, List<String> excluded) {
+	public JavaCleanthatRefactorerFunc(String jdkVersion, List<String> included, List<String> excluded, boolean includeDraft) {
 		this.jdkVersion = jdkVersion == null ? IJdkVersionConstants.JDK_8 : jdkVersion;
 		this.included = included == null ? Collections.emptyList() : included;
 		this.excluded = excluded == null ? Collections.emptyList() : excluded;
+		this.includeDraft = includeDraft;
 	}
 
 	public JavaCleanthatRefactorerFunc() {
-		this(IJdkVersionConstants.JDK_8, Arrays.asList(JavaRefactorerProperties.WILDCARD), Arrays.asList());
+		this(IJdkVersionConstants.JDK_8, Arrays.asList("SafeAndConsensual"), Arrays.asList(), false);
 	}
 
 	@Override
@@ -79,9 +81,11 @@ private String doApply(String input) throws InterruptedException, IOException {
 		refactorerProperties.setIncluded(included);
 		refactorerProperties.setExcluded(excluded);
 
+		refactorerProperties.setIncludeDraft(includeDraft);
+
 		JavaRefactorer refactorer = new JavaRefactorer(engineProperties, refactorerProperties);
 
-		LOGGER.debug("Processing sourceJdk={} included={} excluded={}", jdkVersion, included, excluded);
+		LOGGER.debug("Processing sourceJdk={} included={} excluded={}", jdkVersion, included, excluded, includeDraft);
 		LOGGER.debug("Available mutators: {}", JavaRefactorer.getAllIncluded());
 
 		// Spotless calls steps always with LF eol.

lib/src/jackson/java/com/diffplug/spotless/glue/json/AJacksonFormatterFunc.java

@@ -16,7 +16,6 @@
 package com.diffplug.spotless.glue.json;
 
 import java.io.IOException;
-import java.util.Map;
 
 import com.fasterxml.jackson.core.JsonFactory;
 import com.fasterxml.jackson.core.JsonProcessingException;
@@ -49,7 +48,7 @@ public String apply(String input) throws Exception {
 	protected String format(ObjectMapper objectMapper, String input) throws IllegalArgumentException, IOException {
 		try {
 			// ObjectNode is not compatible with SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS
-			Map objectNode = objectMapper.readValue(input, Map.class);
+			Object objectNode = objectMapper.readValue(input, inferType(input));
 			String output = objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(objectNode);
 
 			return output;
@@ -58,6 +57,13 @@ protected String format(ObjectMapper objectMapper, String input) throws IllegalA
 		}
 	}
 
+	/**
+	 *
+	 * @param input
+	 * @return the {@link Class} into which the String has to be deserialized
+	 */
+	protected abstract Class<?> inferType(String input);
+
 	/**
 	 * @return a {@link JsonFactory}. May be overridden to handle alternative formats.
 	 * @see <a href="https://github.com/FasterXML/jackson-dataformats-text">jackson-dataformats-text</a>

lib/src/jackson/java/com/diffplug/spotless/glue/json/JacksonJsonFormatterFunc.java

@@ -15,6 +15,9 @@
  */
 package com.diffplug.spotless.glue.json;
 
+import java.util.Collection;
+import java.util.Map;
+
 import com.fasterxml.jackson.core.JsonFactory;
 import com.fasterxml.jackson.core.JsonFactoryBuilder;
 import com.fasterxml.jackson.core.JsonGenerator;
@@ -37,6 +40,15 @@ public JacksonJsonFormatterFunc(JacksonJsonConfig jacksonConfig) {
 		this.jacksonConfig = jacksonConfig;
 	}
 
+	@Override
+	protected Class<?> inferType(String input) {
+		if (input.trim().startsWith("[")) {
+			return Collection.class;
+		} else {
+			return Map.class;
+		}
+	}
+
 	/**
 	 * @return a {@link JsonFactory}. May be overridden to handle alternative formats.
 	 * @see <a href="https://github.com/FasterXML/jackson-dataformats-text">jackson-dataformats-text</a>

lib/src/jackson/java/com/diffplug/spotless/glue/yaml/JacksonYamlFormatterFunc.java

@@ -58,13 +58,18 @@ protected JsonFactory makeJsonFactory() {
 		return yamlFactoryBuilder.build();
 	}
 
+	@Override
+	protected Class<?> inferType(String input) {
+		return JsonNode.class;
+	}
+
 	@Override
 	protected String format(ObjectMapper objectMapper, String input) throws IllegalArgumentException, IOException {
 		try {
 			// https://stackoverflow.com/questions/25222327/deserialize-pojos-from-multiple-yaml-documents-in-a-single-file-in-jackson
 			// https://github.com/FasterXML/jackson-dataformats-text/issues/66#issuecomment-375328648
 			JsonParser yamlParser = objectMapper.getFactory().createParser(input);
-			List<JsonNode> documents = objectMapper.readValues(yamlParser, JsonNode.class).readAll();
+			List<?> documents = objectMapper.readValues(yamlParser, inferType(input)).readAll();
 
 			// https://github.com/FasterXML/jackson-dataformats-text/issues/66#issuecomment-554265055
 			// https://github.com/FasterXML/jackson-dataformats-text/issues/66#issuecomment-554265055