Skip to content

RemoveWildCardImports Lint issue #2571

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

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 13 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
4 changes: 2 additions & 2 deletions lib/src/main/java/com/diffplug/spotless/Lint.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2022-2024 DiffPlug
* Copyright 2022-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 Down Expand Up @@ -91,7 +91,7 @@ public ShortcutException(Lint... lints) {
private final List<Lint> lints;

ShortcutException(Collection<Lint> lints) {
super(lints.iterator().next().detail);
super(lints.iterator().next().toString());
this.lints = List.copyOf(lints);
}

Expand Down
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,12 +15,18 @@
*/
package com.diffplug.spotless.generic;

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

import java.io.File;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.regex.Pattern;

import com.diffplug.spotless.FormatterFunc;
import com.diffplug.spotless.FormatterStep;
import com.diffplug.spotless.Lint;

public final class ReplaceRegexStep {
// prevent direct instantiation
Expand All @@ -35,6 +41,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 +64,25 @@ private static final class State implements Serializable {
FormatterFunc toFormatter() {
return raw -> regex.matcher(raw).replaceAll(replacement);
}

FormatterFunc toLinter() {
return new FormatterFunc() {
@Override
public String apply(String raw) {
return raw;
}

@Override
public List<Lint> lint(String raw, File file) {
List<Lint> lints = new ArrayList<>();
var matcher = regex.matcher(raw);
while (matcher.find()) {
int line = 1 + (int) raw.codePoints().limit(matcher.start()).filter(c -> c == '\n').count();
lints.add(atLine(line, matcher.group(0), replacement));
}
return lints;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nedtwigg
spotless:apply for maven does not show lint errors ? for gradle it does.

Copy link
Member

Choose a reason for hiding this comment

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

aha! you are correct! i will try to fix that problem this week...

Copy link
Contributor

@Pankraz76 Pankraz76 Aug 6, 2025

Choose a reason for hiding this comment

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

is it resolved so we can continue, or is the issue bigger than expected?

}
};
}
}
}
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 @@ -97,7 +97,7 @@ void removeWildCardImports() throws IOException {
"}");

setFile("test.java").toResource("java/removewildcardimports/JavaCodeWildcardsUnformatted.test");
gradleRunner().withArguments("spotlessApply").build();
gradleRunner().withArguments("spotlessApply").buildAndFail();
assertFile("test.java").sameAsResource("java/removewildcardimports/JavaCodeWildcardsFormatted.test");
}

Expand Down
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";
Copy link
Contributor

Choose a reason for hiding this comment

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

undo by inline. Thanks

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks

/**
* 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
@@ -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 {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/*
* Copyright 2025 DiffPlug
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.diffplug.spotless.generic;

import org.junit.jupiter.api.Test;

import com.diffplug.common.base.StringPrinter;
import com.diffplug.spotless.FormatterStep;
import com.diffplug.spotless.StepHarness;

class ReplaceRegexStepTest {
@Test
void formatter() throws Exception {
FormatterStep step = ReplaceRegexStep.create("replace", "bad", "good");
StepHarness.forStep(step)
.test("bad bad", "good good");
}

@Test
void lint() throws Exception {
FormatterStep step = ReplaceRegexStep.lint("regex", "bad", "no bad words");
StepHarness.forStep(step)
.expectLintsOf(StringPrinter.buildStringFromLines(
"bad",
"x bad y",
"ok"))
.toBe("L1 regex(bad) no bad words\nL2 regex(bad) no bad words");
}
}
Loading