Merge branch 'main' into serializable-refactor

Author: nedtwigg

CHANGES.md

@@ -10,6 +10,10 @@ 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]
+### Added
+* New static method to `DiffMessageFormatter` which allows to retrieve diffs with their line numbers ([#1960](https://github.com/diffplug/spotless/issues/1960))
+### Changes
+* Use palantir-java-format 2.39.0 on Java 21. ([#1948](https://github.com/diffplug/spotless/pull/1948))
 
 ## [2.43.1] - 2023-12-04
 ### Fixed

lib-extra/build.gradle

@@ -7,7 +7,7 @@ version = rootProject.spotlessChangelog.versionNext
 apply from: rootProject.file('gradle/java-setup.gradle')
 apply from: rootProject.file('gradle/java-publish.gradle')
 
-String VER_SOLSTICE = '1.7.4'
+String VER_SOLSTICE = '1.7.5'
 dependencies {
 	api projects.lib
 	// misc useful utilities

lib-extra/src/main/java/com/diffplug/spotless/extra/integration/DiffMessageFormatter.java

@@ -24,9 +24,11 @@
 import java.nio.file.Path;
 import java.util.List;
 import java.util.ListIterator;
+import java.util.Map;
 import java.util.Objects;
 
 import org.eclipse.jgit.diff.DiffFormatter;
+import org.eclipse.jgit.diff.Edit;
 import org.eclipse.jgit.diff.EditList;
 import org.eclipse.jgit.diff.MyersDiff;
 import org.eclipse.jgit.diff.RawText;
@@ -234,6 +236,19 @@ private void addIntendedLine(String indent, String line) {
 	 * sequence (\n, \r, \r\n).
 	 */
 	private String diff(File file) throws IOException {
+		return diff(formatter, file).getValue();
+	}
+
+	/**
+	 * Returns a map entry with value being a git-style diff between the contents of the given file and what those contents would
+	 * look like if formatted using the given formatter. Does not end with any newline
+	 * sequence (\n, \r, \r\n). The key of the map entry is the 0-based line where the first difference occurred.
+	 */
+	public static Map.Entry<Integer, String> diff(Formatter formatter, File file) throws IOException {
+		return diff(new CleanProviderFormatter(formatter), file);
+	}
+
+	private static Map.Entry<Integer, String> diff(CleanProvider formatter, File file) throws IOException {
 		String raw = new String(Files.readAllBytes(file.toPath()), formatter.getEncoding());
 		String rawUnix = LineEnding.toUnix(raw);
 		String formatted = formatter.getFormatted(file, rawUnix);
@@ -248,13 +263,13 @@ private String diff(File file) throws IOException {
 	}
 
 	/**
-	 * Returns a git-style diff between the two unix strings.
+	 * Returns a map entry with value being a git-style diff between the two unix strings and key being the 0-based line of the first difference (in the dirty string)
 	 * <p>
 	 * Output has no trailing newlines.
 	 * <p>
 	 * Boolean args determine whether whitespace or line endings will be visible.
 	 */
-	private static String diffWhitespaceLineEndings(String dirty, String clean, boolean whitespace, boolean lineEndings) throws IOException {
+	private static Map.Entry<Integer, String> diffWhitespaceLineEndings(String dirty, String clean, boolean whitespace, boolean lineEndings) throws IOException {
 		dirty = visibleWhitespaceLineEndings(dirty, whitespace, lineEndings);
 		clean = visibleWhitespaceLineEndings(clean, whitespace, lineEndings);
 
@@ -271,7 +286,11 @@ private static String diffWhitespaceLineEndings(String dirty, String clean, bool
 
 		// we don't need the diff to show this, since we display newlines ourselves
 		formatted = formatted.replace("\\ No newline at end of file\n", "");
-		return NEWLINE_MATCHER.trimTrailingFrom(formatted);
+		return Map.entry(getLineOfFirstDifference(edits), NEWLINE_MATCHER.trimTrailingFrom(formatted));
+	}
+
+	private static int getLineOfFirstDifference(EditList edits) {
+		return edits.stream().mapToInt(Edit::getBeginA).min().getAsInt();
 	}
 
 	private static final CharMatcher NEWLINE_MATCHER = CharMatcher.is('\n');

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

@@ -30,7 +30,7 @@ private PalantirJavaFormatStep() {}
 	private static final String DEFAULT_STYLE = "PALANTIR";
 	private static final String NAME = "palantir-java-format";
 	public static final String MAVEN_COORDINATE = "com.palantir.javaformat:palantir-java-format:";
-	private static final Jvm.Support<String> JVM_SUPPORT = Jvm.<String> support(NAME).add(8, "1.1.0").add(11, "2.28.0").add(21, "2.38.0");
+	private static final Jvm.Support<String> JVM_SUPPORT = Jvm.<String> support(NAME).add(8, "1.1.0").add(11, "2.28.0").add(21, "2.39.0");
 
 	/** Creates a step which formats everything - code, import order, and unused imports. */
 	public static FormatterStep create(Provisioner provisioner) {

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]
+### Changes
+* Use palantir-java-format 2.39.0 on Java 21. ([#1948](https://github.com/diffplug/spotless/pull/1948))
 
 ## [6.23.3] - 2023-12-04
 **BREAKING CHANGE** `6.23.0` made breaking changes to the ABI of the `KotlinExtension` and `GroovyExtension`. Those are reflected retroactively now.

plugin-gradle/src/test/java/com/diffplug/gradle/spotless/GradleIntegrationHarness.java

@@ -119,6 +119,7 @@ protected GradleRunner gradleRunner() throws IOException {
 		return GradleRunner.create()
 				.withGradleVersion(GradleVersionSupport.MINIMUM.version)
 				.withProjectDir(rootFolder())
+				.withTestKitDir(getTestKitDir())
 				.withPluginClasspath();
 	}
 
@@ -221,4 +222,12 @@ static String buildResultToString(BuildResult result) {
 			}
 		});
 	}
+
+	private static File getTestKitDir() {
+		String gradleUserHome = System.getenv("GRADLE_USER_HOME");
+		if (gradleUserHome == null || gradleUserHome.isEmpty()) {
+			gradleUserHome = new File(System.getProperty("user.home"), ".gradle").getAbsolutePath();
+		}
+		return new File(gradleUserHome, "testkit");
+	}
 }

plugin-maven/CHANGES.md

@@ -3,6 +3,10 @@
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`).
 
 ## [Unreleased]
+### Added
+* M2E support: Emit file specific errors during incremental build. ([#1960](https://github.com/diffplug/spotless/issues/1960))
+### Changes
+* Use palantir-java-format 2.39.0 on Java 21. ([#1948](https://github.com/diffplug/spotless/pull/1948))
 
 ## [2.41.1] - 2023-12-04
 ### Fixed

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

@@ -19,10 +19,12 @@
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugins.annotations.LifecyclePhase;
 import org.apache.maven.plugins.annotations.Mojo;
+import org.sonatype.plexus.build.incremental.BuildContext;
 
 import com.diffplug.spotless.Formatter;
 import com.diffplug.spotless.PaddedCell;
@@ -54,13 +56,17 @@ protected void process(Iterable<File> files, Formatter formatter, UpToDateChecke
 				PaddedCell.DirtyState dirtyState = PaddedCell.calculateDirtyState(formatter, file);
 				if (!dirtyState.isClean() && !dirtyState.didNotConverge()) {
 					problemFiles.add(file);
+					if (buildContext.isIncremental()) {
+						Map.Entry<Integer, String> diffEntry = DiffMessageFormatter.diff(formatter, file);
+						buildContext.addMessage(file, diffEntry.getKey() + 1, 0, diffEntry.getValue(), BuildContext.SEVERITY_ERROR, null);
+					}
 					counter.cleaned();
 				} else {
 					counter.checkedButAlreadyClean();
 					upToDateChecker.setUpToDate(file.toPath());
 				}
 			} catch (IOException | RuntimeException e) {
-				throw new MojoExecutionException("Unable to format file " + file, e);
+				throw new MojoExecutionException("Unable to check file " + file, e);
 			}
 		}
 

plugin-maven/src/test/java/com/diffplug/spotless/maven/java/PalantirJavaFormatTest.java

@@ -34,7 +34,7 @@ void specificVersionDefaultStyle() throws Exception {
 	void specificJava11Version2() throws Exception {
 		writePomWithJavaSteps(
 				"<palantirJavaFormat>",
-				"  <version>2.38.0</version>",
+				"  <version>2.39.0</version>",
 				"</palantirJavaFormat>");
 
 		runTest("java/palantirjavaformat/JavaCodeFormatted.test");

settings.gradle

@@ -6,23 +6,23 @@ pluginManagement {
 }
 
 plugins {
-	id 'com.diffplug.spotless' version '6.22.0' apply false
+	id 'com.diffplug.spotless' version '6.23.3' apply false
 	// https://plugins.gradle.org/plugin/com.gradle.plugin-publish
 	id 'com.gradle.plugin-publish' version '1.2.1' apply false
 	// https://github.com/gradle-nexus/publish-plugin/releases
 	id 'io.github.gradle-nexus.publish-plugin' version '2.0.0-rc-1' apply false
 	// https://github.com/spotbugs/spotbugs-gradle-plugin/releases
-	id 'com.github.spotbugs' version '6.0.1' apply false
+	id 'com.github.spotbugs' version '6.0.2' apply false
 	// https://github.com/diffplug/spotless-changelog/blob/main/CHANGELOG.md
 	id 'com.diffplug.spotless-changelog' version '3.0.2' apply false
 	// https://github.com/radarsh/gradle-test-logger-plugin/blob/develop/CHANGELOG.md
 	id 'com.adarshr.test-logger' version '4.0.0' apply false
 	// https://github.com/davidburstrom/version-compatibility-gradle-plugin/tags
 	id 'io.github.davidburstrom.version-compatibility' version '0.5.0' apply false
 	// https://plugins.gradle.org/plugin/com.gradle.enterprise
-	id 'com.gradle.enterprise' version '3.15.1'
+	id 'com.gradle.enterprise' version '3.16'
 	// https://github.com/equodev/equo-ide/blob/main/plugin-gradle/CHANGELOG.md
-	id 'dev.equo.ide' version '1.7.3' apply false
+	id 'dev.equo.ide' version '1.7.5' apply false
 }
 
 dependencyResolutionManagement {