Skip to content

Prevent LombokValToFinalVar from removing star imports #986

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.

Sign up for GitHub

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

Merged
timtebeek merged 3 commits into from
Feb 17, 2026
+143 −1
Merged

Prevent LombokValToFinalVar from removing star imports #986

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3813539
Prevent LombokValToFinalVar from removing star imports
Jenson3210 Feb 17, 2026
cf89ffd
Apply suggestions from code review
Jenson3210 Feb 17, 2026
c55978f
Apply suggestion from @Jenson3210
Jenson3210 Feb 17, 2026
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
8 changes: 7 additions & 1 deletion src/main/java/org/openrewrite/java/migrate/lombok/LombokValToFinalVar.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,13 @@ public TreeVisitor<?, ExecutionContext> getVisitor() {
private static class LombokValToFinalVarVisitor extends JavaIsoVisitor<ExecutionContext> {
@Override
public J.CompilationUnit visitCompilationUnit(J.CompilationUnit compilationUnit, ExecutionContext ctx) {
maybeRemoveImport(LOMBOK_VAR);
for (J.Import imp : compilationUnit.getImports()) {
if (!imp.isStatic() && LOMBOK_VAR.equals(imp.getTypeName()) &&
!"*".equals(imp.getQualid().getSimpleName())) {
maybeRemoveImport(LOMBOK_VAR);
break;
}
}
return super.visitCompilationUnit(compilationUnit, ctx);
Copy link
Member

@timtebeek timtebeek Feb 17, 2026

Choose a reason for hiding this comment

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

Would this be easier perhaps than manually inspecting the imports?

Suggested change
return super.visitCompilationUnit(compilationUnit, ctx);
J.CompilationUnit cu = super.visitCompilationUnit(compilationUnit, ctx);
if (cu != compilationUnit) {
maybeRemoveImport(LOMBOK_VAR);
}
return cu;

Copy link
Contributor Author

@Jenson3210 Jenson3210 Feb 17, 2026

Choose a reason for hiding this comment

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

Can't do this as star imports would be removed causing the bug to reappear

}

Expand Down
136 changes: 136 additions & 0 deletions src/test/java/org/openrewrite/java/migrate/lombok/LombokValToFinalVarTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import org.openrewrite.java.JavaParser;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;
import org.openrewrite.test.TypeValidation;

import static org.openrewrite.java.Assertions.java;
import static org.openrewrite.java.Assertions.version;
Expand Down Expand Up @@ -113,6 +114,141 @@ void bar() {
);
}

@Test
void preserveStarImportWithoutVarUsage() {
//language=java
rewriteRun(
spec -> spec.parser(JavaParser.fromJavaVersion())
.typeValidationOptions(TypeValidation.none()),
version(
java(
"""
import lombok.*;

@AllArgsConstructor
@NoArgsConstructor
@ToString
@Data
@EqualsAndHashCode
public class AuthHeaders {
String authHeader;
String token;
}
"""
),
17
)
);
}

@Test
void preserveStarImportWithVarUsage() {
//language=java
rewriteRun(
spec -> spec.parser(JavaParser.fromJavaVersion())
.typeValidationOptions(TypeValidation.none()),
version(
java(
"""
import lombok.*;

@Data
class A {
void bar() {
var foo = "foo";
}
}
"""
),
17
)
);
}

@Test
void removeExplicitVarImport() {
//language=java
rewriteRun(
spec -> spec.parser(JavaParser.fromJavaVersion())
.typeValidationOptions(TypeValidation.none()),
version(
java(
"""
import lombok.var;
class A {
void bar() {
var foo = "foo";
}
}
""",
"""
class A {
void bar() {
var foo = "foo";
}
}
"""
),
17
)
);
}

@Test
void removeStarImportWhenOnlyValUsed() {
//language=java
rewriteRun(
spec -> spec.parser(JavaParser.fromJavaVersion())
.typeValidationOptions(TypeValidation.none()),
version(
java(
"""
import lombok.*;
class A {
void bar() {
val foo = "foo";
}
}
""",
"""
class A {
void bar() {
final var foo = "foo";
}
}
"""
),
17
)
);
}

@Test
void starImportRemainsWhenOnlyVarUsed() {
// When `import lombok.*;` exists only for `var`, the star import remains unused after
// the recipe runs. This is acceptable: removing a star import with incomplete type info
// risks breaking compilation by dropping imports that
// other lombok types still need. An unused import is preferable to broken code.
//language=java
rewriteRun(
spec -> spec.parser(JavaParser.fromJavaVersion())
.typeValidationOptions(TypeValidation.none()),
version(
java(
"""
import lombok.*;
class A {
void bar() {
var foo = "foo";
}
}
"""
),
17
)
);
}

@Nested
@SuppressWarnings({"StatementWithEmptyBody", "RedundantOperationOnEmptyContainer"})
class ValInLoop {
Expand Down
Loading