removeWildcardImports: throw new AssertionError instead of removing

Author: Vincent Potucek

lib/src/main/java/com/diffplug/spotless/generic/ReplaceRegexStep.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 DiffPlug
+ * Copyright 2016-2025 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,6 +15,8 @@
  */
 package com.diffplug.spotless.generic;
 
+import static com.diffplug.spotless.Lint.atUndefinedLine;
+
 import java.io.Serializable;
 import java.util.Objects;
 import java.util.regex.Pattern;
@@ -35,6 +37,15 @@ public static FormatterStep create(String name, String regex, String replacement
 				State::toFormatter);
 	}
 
+	public static FormatterStep lint(String name, String regex, String error) {
+		Objects.requireNonNull(name, "name");
+		Objects.requireNonNull(regex, "regex");
+		Objects.requireNonNull(error, "error");
+		return FormatterStep.createLazy(name,
+				() -> new State(Pattern.compile(regex, Pattern.UNIX_LINES | Pattern.MULTILINE), error),
+				State::toLinter);
+	}
+
 	private static final class State implements Serializable {
 		private static final long serialVersionUID = 1L;
 
@@ -49,5 +60,14 @@ private static final class State implements Serializable {
 		FormatterFunc toFormatter() {
 			return raw -> regex.matcher(raw).replaceAll(replacement);
 		}
+
+		FormatterFunc toLinter() {
+			return raw -> {
+				if (regex.matcher(raw).find()) {
+					throw atUndefinedLine("", replacement).shortcut();
+				}
+				return raw;
+			};
+		}
 	}
 }

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

@@ -20,13 +20,17 @@
 
 /** Removes any wildcard import statements. */
 public final class RemoveWildcardImportsStep {
+
+	/**
+	 * Matches lines like 'import foo.*;' or 'import static foo.*;'.
+	 */
+	private static final String REGEX = "(?m)^import\\s+(?:static\\s+)?[^;\\n]*\\*;\\R?";
+	private static final String NAME = "removeWildcardImports";
+	private static final String ERROR = "Do not use wildcard imports. 'spotlessApply' cannot resolve this issue.";
+
 	private RemoveWildcardImportsStep() {}
 
 	public static FormatterStep create() {
-		// Matches lines like 'import foo.*;' or 'import static foo.*;'.
-		return ReplaceRegexStep.create(
-				"removeWildcardImports",
-				"(?m)^import\\s+(?:static\\s+)?[^;\\n]*\\*;\\R?",
-				"");
+		return ReplaceRegexStep.lint(NAME, REGEX, ERROR);
 	}
 }

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

@@ -46,6 +46,8 @@
 import com.diffplug.spotless.ResourceHarness;
 
 public class MavenIntegrationHarness extends ResourceHarness {
+
+	protected static final String PATH = "src/main/java/test.java";
 	/**
 	 * To run tests in the IDE, run {@code gradlew :plugin-maven:changelogPrint}, then
 	 * put the last version it prints into {@code SPOTLESS_MAVEN_VERSION_IDE}.  From now

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

@@ -15,19 +15,40 @@
  */
 package com.diffplug.spotless.maven.java;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
 import com.diffplug.spotless.maven.MavenIntegrationHarness;
 
 class RemoveWildcardImportsStepTest extends MavenIntegrationHarness {
 
+	private static final String ERROR = "Do not use wildcard imports. 'spotlessApply' cannot resolve this issue.";
+
+	@BeforeEach
+	void init() throws Exception {
+		writePomWithJavaSteps("<removeWildcardImports/>");
+	}
+
 	@Test
 	void testRemoveWildcardImports() throws Exception {
-		writePomWithJavaSteps("<removeWildcardImports/>");
+		setFile(PATH).toResource("java/removewildcardimports/JavaCodeWildcardsUnformatted.test");
+		assertFile(PATH).sameAsResource("java/removewildcardimports/JavaCodeWildcardsFormatted.test");
+		assertThat(mavenRunner().withArguments("spotless:apply").runHasError().stdOutUtf8()).contains(ERROR);
+	}
 
-		String path = "src/main/java/test.java";
-		setFile(path).toResource("java/removewildcardimports/JavaCodeWildcardsUnformatted.test");
+	@Test
+	void testRemoveStaticWildcardImports() throws Exception {
+		setFile(PATH).toResource("java/removewildcardimports/JavaCodeStaticWildcardsUnformatted.test");
+		assertFile(PATH).sameAsResource("java/removewildcardimports/JavaCodeStaticWildcardsFormatted.test");
+		assertThat(mavenRunner().withArguments("spotless:apply").runHasError().stdOutUtf8()).contains(ERROR);
+	}
+
+	@Test
+	void testRemoveWildcardImportsNoError() throws Exception {
+		setFile(PATH).toResource("java/removewildcardimports/JavaCodeNoWildcardsUnformatted.test");
+		assertFile(PATH).sameAsResource("java/removewildcardimports/JavaCodeNoWildcardsUnformatted.test");
 		mavenRunner().withArguments("spotless:apply").runNoError();
-		assertFile(path).sameAsResource("java/removewildcardimports/JavaCodeWildcardsFormatted.test");
 	}
 }

testlib/src/main/resources/java/removewildcardimports/JavaCodeNoWildcardsFormatted.test

@@ -0,0 +1,4 @@
+import java.util.List;
+import mylib.Helper;
+
+public class Test {}

testlib/src/main/resources/java/removewildcardimports/JavaCodeNoWildcardsUnformatted.test

@@ -0,0 +1,4 @@
+import java.util.List;
+import mylib.Helper;
+
+public class Test {}

testlib/src/main/resources/java/removewildcardimports/JavaCodeStaticWildcardsFormatted.test

@@ -0,0 +1,6 @@
+import java.util.List;
+import mylib.Helper;
+import static io.quarkus.vertx.web.Route.HttpMethod.*;
+import static org.springframework.web.reactive.function.BodyInserters.*;
+
+public class Test {}

testlib/src/main/resources/java/removewildcardimports/JavaCodeStaticWildcardsUnformatted.test

@@ -0,0 +1,6 @@
+import java.util.List;
+import mylib.Helper;
+import static io.quarkus.vertx.web.Route.HttpMethod.*;
+import static org.springframework.web.reactive.function.BodyInserters.*;
+
+public class Test {}

testlib/src/main/resources/java/removewildcardimports/JavaCodeWildcardsFormatted.test

@@ -1,4 +1,7 @@
+import java.util.*;
+import static java.util.Collections.*;
 import java.util.List;
 import mylib.Helper;
+import io.quarkus.maven.dependency.*;
 
 public class Test {}

testlib/src/main/resources/java/removewildcardimports/JavaCodeWildcardsUnformatted.test

@@ -3,7 +3,5 @@ import static java.util.Collections.*;
 import java.util.List;
 import mylib.Helper;
 import io.quarkus.maven.dependency.*;
-import static io.quarkus.vertx.web.Route.HttpMethod.*;
-import static org.springframework.web.reactive.function.BodyInserters.*;
 
 public class Test {}