Skip to content

removeWildcardImports: throw new AssertionError instead of removing #2557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -15,6 +15,9 @@
*/
package com.diffplug.spotless.generic;

import static com.diffplug.spotless.Lint.atLine;
import static com.diffplug.spotless.Lint.atUndefinedLine;

import java.io.Serializable;
import java.util.Objects;
import java.util.regex.Pattern;
Expand All @@ -35,6 +38,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;

Expand All @@ -49,5 +61,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 atLine(11111,"", replacement).shortcut();
}
return raw;
};
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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 (e.g. java.util.*) - replace with specific class imports (e.g. java.util.List) as 'spotlessApply' cannot auto-fix this";

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);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,49 @@
*/
package com.diffplug.spotless.maven.java;

import static org.assertj.core.api.Assertions.assertThat;

import com.diffplug.spotless.FormatterStep;

import com.diffplug.spotless.StepHarnessWithFile;
import com.diffplug.spotless.TestProvisioner;
import com.diffplug.spotless.kotlin.KtLintStep;

import org.assertj.core.api.AbstractStringAssert;
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 (e.g. java.util.*) - replace with specific class imports (e.g. java.util.List) as 'spotlessApply' cannot auto-fix this";

@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");
AbstractStringAssert<?> abstractStringAssert = assertThat(mavenRunner().withArguments("spotless:apply").runHasError().stdOutUtf8());
abstractStringAssert
.contains(ERROR)
.contains("11111")
;

String path = "src/main/java/test.java";
setFile(path).toResource("java/removewildcardimports/JavaCodeWildcardsUnformatted.test");
FormatterStep step = KtLintStep.create("0.49.0", TestProvisioner.mavenCentral());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

meant to validate only the removeWildcardImports behavior, Is it just for testing...... pulling in a KtLint step is not required here.

StepHarnessWithFile.forStep(this, step)
.testResource("java/removewildcardimports/JavaCodeWildcardsUnformatted.test", "java/removewildcardimports/JavaCodeWildcardsFormatted.test")
.expectLintsOfResource("kotlin/ktlint/unsolvable.dirty").toBe("L1 ktlint(standard:no-wildcard-imports) Wildcard import");
}

@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");
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import java.util.List;
import mylib.Helper;

public class Test {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import java.util.List;
import mylib.Helper;

public class Test {}
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
import java.util.*;
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 {}
Loading