Adjust existing steps to be lint-friendly (#2305)

nedtwigg · web-flow · commit b47e70eeecb4 · 2024-10-21T08:18:45.000-07:00
diff --git a/lib/src/compatDiktat1Dot2Dot5/java/com/diffplug/spotless/glue/diktat/compat/DiktatCompat1Dot2Dot5Adapter.java b/lib/src/compatDiktat1Dot2Dot5/java/com/diffplug/spotless/glue/diktat/compat/DiktatCompat1Dot2Dot5Adapter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 DiffPlug
+ * Copyright 2023-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -77,9 +77,7 @@ public String format(final File file, final String content, final boolean isScri
 				false,
 				new EditorConfigOverride(),
 				false));
-
-		DiktatReporting.reportIfRequired(errors, LintError::getLine, LintError::getCol, LintError::getDetail);
-
+		DiktatReporting.reportIfRequired(errors, LintError::getLine, LintError::getRuleId, LintError::getDetail);
 		return result;
 	}
 }
diff --git a/lib/src/compatDiktat2Dot0Dot0/java/com/diffplug/spotless/glue/diktat/compat/DiktatCompat2Dot0Dot0Adapter.java b/lib/src/compatDiktat2Dot0Dot0/java/com/diffplug/spotless/glue/diktat/compat/DiktatCompat2Dot0Dot0Adapter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 DiffPlug
+ * Copyright 2023-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -49,7 +49,7 @@ public DiktatCompat2Dot0Dot0Adapter(@Nullable File configFile) {
 	public String format(File file, String content, boolean isScript) {
 		errors.clear();
 		String result = processor.fix(content, file.toPath(), formatterCallback);
-		DiktatReporting.reportIfRequired(errors, DiktatError::getLine, DiktatError::getCol, DiktatError::getDetail);
+		DiktatReporting.reportIfRequired(errors, DiktatError::getLine, DiktatError::getRuleId, DiktatError::getDetail);
 		return result;
 	}
 
diff --git a/lib/src/compatDiktatApi/java/com/diffplug/spotless/glue/diktat/compat/DiktatReporting.java b/lib/src/compatDiktatApi/java/com/diffplug/spotless/glue/diktat/compat/DiktatReporting.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 DiffPlug
+ * Copyright 2023-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,28 +15,45 @@
  */
 package com.diffplug.spotless.glue.diktat.compat;
 
+import java.io.Serializable;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.function.Function;
 import java.util.function.ToIntFunction;
 
-interface DiktatReporting {
+public interface DiktatReporting {
+	class Lint implements Serializable {
+		private static final long serialVersionUID = 1L;
+		public final int line;
+		public final String ruleId;
+		public final String detail;
+
+		Lint(int line, String ruleId, String detail) {
+			this.line = line;
+			this.ruleId = ruleId;
+			this.detail = detail;
+		}
+	}
+
+	class LintException extends RuntimeException {
+		public final List<Lint> lints;
+
+		LintException(List<Lint> lints) {
+			this.lints = lints;
+		}
+	}
+
 	static <T> void reportIfRequired(
 			List<T> errors,
 			ToIntFunction<T> lineGetter,
-			ToIntFunction<T> columnGetter,
+			Function<T, String> codeGetter,
 			Function<T, String> detailGetter) {
 		if (!errors.isEmpty()) {
-			StringBuilder error = new StringBuilder();
-			error.append("There are ").append(errors.size()).append(" unfixed errors:");
+			var lints = new ArrayList<Lint>();
 			for (T er : errors) {
-				error.append(System.lineSeparator())
-						.append("Error on line: ").append(lineGetter.applyAsInt(er))
-						.append(", column: ").append(columnGetter.applyAsInt(er))
-						.append(" cannot be fixed automatically")
-						.append(System.lineSeparator())
-						.append(detailGetter.apply(er));
+				lints.add(new Lint(lineGetter.applyAsInt(er), codeGetter.apply(er), detailGetter.apply(er)));
 			}
-			throw new AssertionError(error);
+			throw new LintException(lints);
 		}
 	}
 }
diff --git a/lib/src/compatKtLintApi/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompatReporting.java b/lib/src/compatKtLintApi/java/com/diffplug/spotless/glue/ktlint/compat/KtLintCompatReporting.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 DiffPlug
+ * Copyright 2022-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,11 +15,25 @@
  */
 package com.diffplug.spotless.glue.ktlint.compat;
 
-final class KtLintCompatReporting {
+public final class KtLintCompatReporting {
 
 	private KtLintCompatReporting() {}
 
 	static void report(int line, int column, String ruleId, String detail) {
-		throw new AssertionError("Error on line: " + line + ", column: " + column + "\nrule: " + ruleId + "\n" + detail);
+		throw new KtlintSpotlessException(line, ruleId, detail);
+	}
+
+	public static class KtlintSpotlessException extends RuntimeException {
+		private static final long serialVersionUID = 1L;
+
+		public final int line;
+		public final String ruleId;
+		public final String detail;
+
+		KtlintSpotlessException(int line, String ruleId, String detail) {
+			this.line = line;
+			this.ruleId = ruleId;
+			this.detail = detail;
+		}
 	}
 }
diff --git a/lib/src/diktat/java/com/diffplug/spotless/glue/diktat/DiktatFormatterFunc.java b/lib/src/diktat/java/com/diffplug/spotless/glue/diktat/DiktatFormatterFunc.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021-2023 DiffPlug
+ * Copyright 2021-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,11 +16,14 @@
 package com.diffplug.spotless.glue.diktat;
 
 import java.io.File;
+import java.util.stream.Collectors;
 
 import com.diffplug.spotless.FormatterFunc;
+import com.diffplug.spotless.Lint;
 import com.diffplug.spotless.glue.diktat.compat.DiktatCompat1Dot2Dot5Adapter;
 import com.diffplug.spotless.glue.diktat.compat.DiktatCompat2Dot0Dot0Adapter;
 import com.diffplug.spotless.glue.diktat.compat.DiktatCompatAdapter;
+import com.diffplug.spotless.glue.diktat.compat.DiktatReporting;
 
 public class DiktatFormatterFunc implements FormatterFunc.NeedsFile {
 	private final DiktatCompatAdapter adapter;
@@ -40,6 +43,10 @@ public DiktatFormatterFunc(
 
 	@Override
 	public String applyWithFile(String unix, File file) {
-		return adapter.format(file, unix, isScript);
+		try {
+			return adapter.format(file, unix, isScript);
+		} catch (DiktatReporting.LintException e) {
+			throw Lint.shortcut(e.lints.stream().map(lint -> Lint.atLine(lint.line, lint.ruleId, lint.detail)).collect(Collectors.toList()));
+		}
 	}
 }
diff --git a/lib/src/gson/java/com/diffplug/spotless/glue/gson/GsonFormatterFunc.java b/lib/src/gson/java/com/diffplug/spotless/glue/gson/GsonFormatterFunc.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 DiffPlug
+ * Copyright 2023-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -32,7 +32,7 @@
 
 public class GsonFormatterFunc implements FormatterFunc {
 
-	private static final String FAILED_TO_PARSE_ERROR_MESSAGE = "Unable to format JSON";
+	private static final String FAILED_TO_PARSE_ERROR_MESSAGE = "Unable to parse JSON";
 
 	private final Gson gson;
 	private final GsonConfig gsonConfig;
@@ -56,7 +56,7 @@ public String apply(String inputString) {
 		} else {
 			JsonElement jsonElement = gson.fromJson(inputString, JsonElement.class);
 			if (jsonElement == null) {
-				throw new AssertionError(FAILED_TO_PARSE_ERROR_MESSAGE);
+				throw new IllegalArgumentException(FAILED_TO_PARSE_ERROR_MESSAGE);
 			}
 			if (gsonConfig.isSortByKeys()) {
 				jsonElement = sortByKeys(jsonElement);
diff --git a/lib/src/ktlint/java/com/diffplug/spotless/glue/ktlint/KtlintFormatterFunc.java b/lib/src/ktlint/java/com/diffplug/spotless/glue/ktlint/KtlintFormatterFunc.java
@@ -21,6 +21,7 @@
 
 import com.diffplug.spotless.FileSignature;
 import com.diffplug.spotless.FormatterFunc;
+import com.diffplug.spotless.Lint;
 import com.diffplug.spotless.glue.ktlint.compat.*;
 
 public class KtlintFormatterFunc implements FormatterFunc.NeedsFile {
@@ -65,10 +66,14 @@ public String applyWithFile(String unix, File file) throws NoSuchFieldException,
 		if (editorConfigPath != null) {
 			absoluteEditorConfigPath = editorConfigPath.getOnlyFile().toPath();
 		}
-		return adapter.format(
-				unix,
-				file.toPath(),
-				absoluteEditorConfigPath,
-				editorConfigOverrideMap);
+		try {
+			return adapter.format(
+					unix,
+					file.toPath(),
+					absoluteEditorConfigPath,
+					editorConfigOverrideMap);
+		} catch (KtLintCompatReporting.KtlintSpotlessException e) {
+			throw Lint.atLine(e.line, e.ruleId, e.detail).shortcut();
+		}
 	}
 }
diff --git a/lib/src/main/java/com/diffplug/spotless/Jvm.java b/lib/src/main/java/com/diffplug/spotless/Jvm.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -61,6 +61,8 @@ public static int version() {
 	 * @param <V> Version type of formatter
 	 */
 	public static class Support<V> {
+		static final String LINT_CODE = "jvm-version";
+
 		private final String fmtName;
 		private final Comparator<? super V> fmtVersionComparator;
 		private final NavigableMap<Integer, V> jvm2fmtMaxVersion;
@@ -139,7 +141,7 @@ public void assertFormatterSupported(V formatterVersion) {
 			Objects.requireNonNull(formatterVersion);
 			String error = buildUnsupportedFormatterMessage(formatterVersion);
 			if (!error.isEmpty()) {
-				throw new IllegalArgumentException(error);
+				throw Lint.atUndefinedLine(LINT_CODE, error).shortcut();
 			}
 		}
 
diff --git a/lib/src/main/java/com/diffplug/spotless/LintState.java b/lib/src/main/java/com/diffplug/spotless/LintState.java
@@ -62,7 +62,15 @@ public Map<FormatterStep, List<Lint>> getLints(Formatter formatter) {
 		return result;
 	}
 
-	public String asString(File file, Formatter formatter) {
+	public String asStringDetailed(File file, Formatter formatter) {
+		return asString(file, formatter, false);
+	}
+
+	public String asStringOneLine(File file, Formatter formatter) {
+		return asString(file, formatter, true);
+	}
+
+	private String asString(File file, Formatter formatter, boolean oneLine) {
 		if (!isHasLints()) {
 			return "(none)";
 		} else {
@@ -84,7 +92,16 @@ public String asString(File file, Formatter formatter) {
 						}
 						result.append(" ");
 						result.append(step.getName()).append("(").append(lint.getRuleId()).append(") ");
-						result.append(lint.getDetail());
+
+						int firstNewline = lint.getDetail().indexOf('\n');
+						if (firstNewline == -1) {
+							result.append(lint.getDetail());
+						} else if (oneLine) {
+							result.append(lint.getDetail(), 0, firstNewline);
+							result.append(" (...)");
+						} else {
+							result.append(lint.getDetail());
+						}
 						result.append("\n");
 					}
 				}
diff --git a/lib/src/main/java/com/diffplug/spotless/generic/FenceStep.java b/lib/src/main/java/com/diffplug/spotless/generic/FenceStep.java
@@ -210,9 +210,8 @@ protected String assembleGroups(String unix) {
 				} else {
 					pattern = regex.pattern();
 				}
-				throw new Lint.ShortcutException(Lint.create("fenceRemoved",
-						"An intermediate step removed a match of " + pattern,
-						startLine, endLine));
+				throw Lint.atLineRange(startLine, endLine, "fenceRemoved",
+						"An intermediate step removed a match of " + pattern).shortcut();
 			}
 		}
 
diff --git a/lib/src/main/java/com/diffplug/spotless/kotlin/DiktatStep.java b/lib/src/main/java/com/diffplug/spotless/kotlin/DiktatStep.java
@@ -16,7 +16,6 @@
 package com.diffplug.spotless.kotlin;
 
 import java.io.File;
-import java.io.IOException;
 import java.io.Serializable;
 import java.lang.reflect.Constructor;
 import java.util.*;
@@ -95,7 +94,7 @@ static final class State implements Serializable {
 		private final boolean isScript;
 		private final @Nullable FileSignature config;
 
-		State(JarState jar, String versionDiktat, boolean isScript, @Nullable FileSignature config) throws IOException {
+		State(JarState jar, String versionDiktat, boolean isScript, @Nullable FileSignature config) {
 			this.jar = jar;
 			this.versionDiktat = versionDiktat;
 			this.isScript = isScript;
diff --git a/plugin-maven/src/test/java/com/diffplug/spotless/maven/kotlin/KtlintTest.java b/plugin-maven/src/test/java/com/diffplug/spotless/maven/kotlin/KtlintTest.java
@@ -15,8 +15,7 @@
  */
 package com.diffplug.spotless.maven.kotlin;
 
-import static org.junit.jupiter.api.Assertions.assertTrue;
-
+import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.Test;
 
 import com.diffplug.spotless.ProcessRunner;
@@ -89,7 +88,7 @@ void testWithCustomRuleSetApply() throws Exception {
 				"</ktlint>");
 		setFile("src/main/kotlin/Main.kt").toResource("kotlin/ktlint/listScreen.dirty");
 		ProcessRunner.Result result = mavenRunner().withArguments("spotless:check").runHasError();
-		assertTrue(result.toString().contains("Composable functions that return Unit should start with an uppercase letter."));
+		Assertions.assertThat(result.toString()).contains("Composable functions that return Unit should start with an uppercase letter.");
 	}
 
 	private void checkKtlintOfficialStyle() throws Exception {
diff --git a/testlib/src/main/java/com/diffplug/spotless/StepHarness.java b/testlib/src/main/java/com/diffplug/spotless/StepHarness.java
@@ -98,7 +98,7 @@ public StringSelfie expectLintsOf(String before) {
 	}
 
 	static StringSelfie expectLintsOf(LintState state, Formatter formatter) {
-		String assertAgainst = state.asString(Formatter.NO_FILE_SENTINEL, formatter);
+		String assertAgainst = state.asStringOneLine(Formatter.NO_FILE_SENTINEL, formatter);
 		String cleaned = assertAgainst.replace("NO_FILE_SENTINEL:", "");
 
 		int numLines = 1;
diff --git a/testlib/src/test/java/com/diffplug/spotless/JvmTest.java b/testlib/src/test/java/com/diffplug/spotless/JvmTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021-2023 DiffPlug
+ * Copyright 2021-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -94,9 +94,9 @@ void supportListsMinimumJvmIfOnlyHigherJvmSupported() {
 		assertNull(testSupport.getRecommendedFormatterVersion(), "No formatter version is supported");
 
 		for (String fmtVersion : Arrays.asList("1.2", "1.2.3", "1.2-SNAPSHOT", "1.2.3-SNAPSHOT")) {
-			String proposal = assertThrows(Exception.class, () -> {
+			String proposal = assertThrows(Lint.ShortcutException.class, () -> {
 				testSupport.assertFormatterSupported(fmtVersion);
-			}).getMessage();
+			}).getLints().get(0).getDetail();
 			assertThat(proposal).contains(String.format("on JVM %d", Jvm.version()));
 			assertThat(proposal).contains(String.format("%s %s requires JVM %d+", TEST_NAME, fmtVersion, higherJvmVersion));
 			assertThat(proposal).contains(String.format("try %s alternatives", TEST_NAME));
@@ -112,9 +112,9 @@ void supportListsMinimumJvmIfOnlyHigherJvmSupported() {
 		}
 
 		for (String fmtVersion : Arrays.asList("1.2.4", "2", "1.2.5-SNAPSHOT")) {
-			String proposal = assertThrows(Exception.class, () -> {
+			String proposal = assertThrows(Lint.ShortcutException.class, () -> {
 				testSupport.assertFormatterSupported(fmtVersion);
-			}).getMessage();
+			}).getLints().get(0).getDetail();
 			assertThat(proposal).contains(String.format("%s %s requires JVM %d+", TEST_NAME, fmtVersion, higherJvmVersion + 1));
 
 			proposal = assertThrows(Exception.class, () -> {
diff --git a/testlib/src/test/java/com/diffplug/spotless/generic/FenceStepTest.java b/testlib/src/test/java/com/diffplug/spotless/generic/FenceStepTest.java
@@ -89,7 +89,7 @@ void broken() {
 				"spotless:off",
 				"D E F",
 				"spotless:on",
-				"G H I")).toBe("1-6 fence(fenceRemoved) An intermediate step removed a match of spotless:off spotless:on");
+				"G H I")).toBe("L1-6 fence(fenceRemoved) An intermediate step removed a match of spotless:off spotless:on");
 	}
 
 	@Test
diff --git a/testlib/src/test/java/com/diffplug/spotless/java/GoogleJavaFormatStepTest.java b/testlib/src/test/java/com/diffplug/spotless/java/GoogleJavaFormatStepTest.java
diff --git a/testlib/src/test/java/com/diffplug/spotless/json/JsonSimpleStepTest.java b/testlib/src/test/java/com/diffplug/spotless/json/JsonSimpleStepTest.java
diff --git a/testlib/src/test/java/com/diffplug/spotless/json/gson/GsonStepTest.java b/testlib/src/test/java/com/diffplug/spotless/json/gson/GsonStepTest.java
diff --git a/testlib/src/test/java/com/diffplug/spotless/kotlin/DiktatStepTest.java b/testlib/src/test/java/com/diffplug/spotless/kotlin/DiktatStepTest.java
diff --git a/testlib/src/test/java/com/diffplug/spotless/kotlin/KtLintStepTest.java b/testlib/src/test/java/com/diffplug/spotless/kotlin/KtLintStepTest.java
diff --git a/testlib/src/test/java/com/diffplug/spotless/npm/PrettierFormatterStepTest.java b/testlib/src/test/java/com/diffplug/spotless/npm/PrettierFormatterStepTest.java

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2023 DiffPlug`
	`2`	`+ * Copyright 2023-2024 DiffPlug`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -77,9 +77,7 @@ public String format(final File file, final String content, final boolean isScri`
`77`	`77`	`false,`
`78`	`78`	`new EditorConfigOverride(),`
`79`	`79`	`false));`
`80`		`-`
`81`		`- DiktatReporting.reportIfRequired(errors, LintError::getLine, LintError::getCol, LintError::getDetail);`
`82`		`-`
	`80`	`+ DiktatReporting.reportIfRequired(errors, LintError::getLine, LintError::getRuleId, LintError::getDetail);`
`83`	`81`	`return result;`
`84`	`82`	`}`
`85`	`83`	`}`
Original file line number	Diff line number	Diff line change
`@@ -210,9 +210,8 @@ protected String assembleGroups(String unix) {`
`210`	`210`	`} else {`
`211`	`211`	`pattern = regex.pattern();`
`212`	`212`	`}`
`213`		`- throw new Lint.ShortcutException(Lint.create("fenceRemoved",`
`214`		`- "An intermediate step removed a match of " + pattern,`
`215`		`- startLine, endLine));`
	`213`	`+ throw Lint.atLineRange(startLine, endLine, "fenceRemoved",`
	`214`	`+ "An intermediate step removed a match of " + pattern).shortcut();`
`216`	`215`	`}`
`217`	`216`	`}`
`218`	`217`