obsolete - Add support for linters

CHANGES.md

@@ -13,6 +13,13 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 * **BREAKING** Removed `isClean`, `applyTo`, and `applyToAndReturnResultIfDirty` from `Formatter` because users should instead use `PaddedCell.check()`.
 * **BREAKING** Removed `FormatterStep.Strict` because it was unnecessary and unused implementation detail.
 * **BREAKING** Moved `PaddedCell.DirtyState` to its own top-level class with new methods.
+* **BREAKING** Removed `FormatExceptionPolicy` and its subclasses because exceptions are now wrapped as lints.
+* **BREAKING** Renamed `PipeStepPair` to `FenceStep` and changed its API.
+  * The old "pair" approach could not detect when a `spotless:off/on` tag pair was removed by an intermediate step, so we have no choice but to condense the "in/(all other steps)/out" into a single step.
+* **BREAKING** Removed `rootDir` property `Formatter` and its builder because it was only used to annnotate errors, which is now done by the lint phase.
+  * This also means that `DiffMessageFormatter.Builder::formatter` needs a new `Path rootDir` parameter.
+* **BREAKING** Removed deprecated methods.
+  * `FormatterFunc.Closeable::of(AutoCloseable, FormatterFunc)`
 
 ## [Unreleased]
 ### Changed

gradle.properties

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

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 DiffPlug
+ * Copyright 2016-2022 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -57,14 +57,16 @@ interface CleanProvider {
 
 	private static class CleanProviderFormatter implements CleanProvider {
 		private final Formatter formatter;
+		private final Path rootDir;
 
-		CleanProviderFormatter(Formatter formatter) {
+		CleanProviderFormatter(Path rootDir, Formatter formatter) {
+			this.rootDir = rootDir;
 			this.formatter = Objects.requireNonNull(formatter);
 		}
 
 		@Override
 		public Path getRootDir() {
-			return formatter.getRootDir();
+			return rootDir;
 		}
 
 		@Override
@@ -121,8 +123,8 @@ public Builder runToFix(String runToFix) {
 			return this;
 		}
 
-		public Builder formatter(Formatter formatter) {
-			this.formatter = new CleanProviderFormatter(formatter);
+		public Builder formatter(Path rootDir, Formatter formatter) {
+			this.formatter = new CleanProviderFormatter(rootDir, formatter);
 			return this;
 		}
 

lib-extra/src/test/java/com/diffplug/spotless/extra/GitAttributesTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 DiffPlug
+ * Copyright 2016-2022 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,23 +24,18 @@
 import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.Test;
 
-import com.diffplug.common.base.Errors;
 import com.diffplug.common.base.StringPrinter;
 import com.diffplug.spotless.LineEnding;
 import com.diffplug.spotless.ResourceHarness;
 
 class GitAttributesTest extends ResourceHarness {
 	private List<File> testFiles() {
-		try {
-			List<File> result = new ArrayList<>();
-			for (String path : TEST_PATHS) {
-				setFile(path).toContent("");
-				result.add(newFile(path));
-			}
-			return result;
-		} catch (IOException e) {
-			throw Errors.asRuntime(e);
+		List<File> result = new ArrayList<>();
+		for (String path : TEST_PATHS) {
+			setFile(path).toContent("");
+			result.add(newFile(path));
 		}
+		return result;
 	}
 
 	private static List<String> TEST_PATHS = Arrays.asList("someFile", "subfolder/someFile", "MANIFEST.MF", "subfolder/MANIFEST.MF");

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

@@ -20,6 +20,7 @@
 import java.io.OutputStream;
 import java.nio.file.Files;
 import java.util.Arrays;
+import java.util.List;
 
 import javax.annotation.Nullable;
 
@@ -137,5 +138,27 @@ public DirtyState calculateDirtyState() {
 				return isClean;
 			}
 		}
+
+		public List<Lint> calculateLintAgainstRaw() {
+			return formatter.lint(raw, file);
+		}
+
+		public List<Lint> calculateLintAgainstDirtyState(DirtyState dirtyState) {
+			if (dirtyState.isClean() || dirtyState.didNotConverge()) {
+				return calculateLintAgainstRaw();
+			} else {
+				String canonical = new String(dirtyState.canonicalBytes(), formatter.getEncoding());
+				return formatter.lint(canonical, file);
+			}
+		}
+
+		/** If {@link #calculateLintAgainstRaw()} was already called, then you might be able to reuse that value. */
+		public List<Lint> calculateLintAgainstDirtyState(DirtyState dirtyState, List<Lint> lintsAgainstRaw) {
+			if (dirtyState.isClean() || dirtyState.didNotConverge()) {
+				return lintsAgainstRaw;
+			} else {
+				return calculateLintAgainstDirtyState(dirtyState);
+			}
+		}
 	}
 }

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2021 DiffPlug
+ * Copyright 2016-2022 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,8 +16,9 @@
 package com.diffplug.spotless;
 
 import java.io.File;
+import java.util.Collections;
+import java.util.List;
 import java.util.Objects;
-import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
 import javax.annotation.Nullable;
@@ -40,16 +41,24 @@ public String getName() {
 	public @Nullable String format(String raw, File file) throws Exception {
 		Objects.requireNonNull(raw, "raw");
 		Objects.requireNonNull(file, "file");
-
-		Matcher matcher = contentPattern.matcher(raw);
-
-		if (matcher.find()) {
+		if (contentPattern.matcher(raw).find()) {
 			return delegateStep.format(raw, file);
 		} else {
 			return raw;
 		}
 	}
 
+	@Override
+	public List<Lint> lint(String content, File file) throws Exception {
+		Objects.requireNonNull(content, "content");
+		Objects.requireNonNull(file, "file");
+		if (contentPattern.matcher(content).find()) {
+			return delegateStep.lint(content, file);
+		} else {
+			return Collections.emptyList();
+		}
+	}
+
 	@Override
 	public boolean equals(Object o) {
 		if (this == o) {

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 DiffPlug
+ * Copyright 2016-2022 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,6 +16,8 @@
 package com.diffplug.spotless;
 
 import java.io.File;
+import java.util.Collections;
+import java.util.List;
 import java.util.Objects;
 
 import javax.annotation.Nullable;
@@ -45,6 +47,17 @@ public String getName() {
 		}
 	}
 
+	@Override
+	public List<Lint> lint(String content, File file) throws Exception {
+		Objects.requireNonNull(content, "content");
+		Objects.requireNonNull(file, "file");
+		if (filter.accept(file)) {
+			return delegateStep.lint(content, file);
+		} else {
+			return Collections.emptyList();
+		}
+	}
+
 	@Override
 	public boolean equals(Object o) {
 		if (this == o) {