8000 Recipe to find maven modules that have no parent by JohannisK · Pull Request #5639 · openrewrite/rewrite · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Recipe to find maven modules that have no parent #5639

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

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft
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
8000
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
/*
* Copyright 2025 the original author or authors.
* <p>
* 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
* <p>
* https://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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 org.openrewrite.maven.search;

import lombok.EqualsAndHashCode;
import lombok.Value;
import org.jspecify.annotations.Nullable;
import org.openrewrite.ExecutionContext;
import org.openrewrite.ScanningRecipe;
import org.openrewrite.Tree;
import org.openrewrite.TreeVisitor;
import org.openrewrite.java.marker.JavaProject;
import org.openrewrite.marker.SearchResult;

import java.util.HashSet;
import java.util.Optional;
import java.util.Set;

@Value
@EqualsAndHashCode(callSuper = false)
public class ModuleHasNoParent extends ScanningRecipe<ModuleHasNoParent.Accumulator> {

@Override
public String getDisplayName() {
return "Module has no parent";
}

@Override
public String getDescription() {
return "Searches for Maven modules that have no parent. " +
"Places a `SearchResult` marker on all sources within a module that has no parent. " +
"This recipe is intended to be used as a precondition for other recipes. " +
"For example: " +
"this could be used to limit the application of recipes that add a parent to projects that currently don't have one.";
}

@Value
public static class Accumulator {
Set<JavaProject> projectsWithParent;
}

@Override
public Accumulator getInitialValue(ExecutionContext ctx) {
return new Accumulator(new HashSet<>());
}

@Override
public TreeVisitor<?, ExecutionContext> getScanner(Accumulator acc) {
return new TreeVisitor<Tree, ExecutionContext>() {
@Override
public Tree visit(@Nullable Tree tree, ExecutionContext ctx) {
assert tree != null;
tree.getMarkers()
.findFirst(JavaProject.class)
.ifPresent(jp -> {
Tree t = new ParentPomInsight("*", "*", null, false).getVisitor().visit(tree, ctx);
if (t != tree) {
acc.getProjectsWithParent().add(jp);
}
});
return tree;
}
};
}

@Override
public TreeVisitor<?, ExecutionContext> getVisitor(Accumulator acc) {
return new TreeVisitor<Tree, ExecutionContext>() {
@Override
public Tree visit(@Nullable Tree tree, ExecutionContext ctx) {
assert tree != null;
Optional<JavaProject> maybeJp = tree.getMarkers().findFirst(JavaProject.class);
if (!maybeJp.isPresent()) {
return tree;
}
JavaProject jp = maybeJp.get();
if (!acc.getProjectsWithParent().contains(jp)) {
Copy link
Contributor

Choose a reason for hiding this comment

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

What is the reasoning for this recipe being a scanning recipe?
I don't see why you couldn't just call parentPomInsight here and save the scanning cycle of the recipe :)

return SearchResult.found(tree, "Module has no parent.");
}
return tree;
}
};
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ public String getDescription() {
"This recipe is intended to be used as a precondition for other recipes. " +
"For example this could be used to limit the application of a spring boot migration to only projects " +
"that apply the spring boot plugin, limiting unnecessary upgrading. " +
"If the search result you want is instead just the build.gradle(.kts) file applying the plugin, use the `FindPlugins` recipe instead.";
"If the search result you want is instead just the pom.xml file applying the plugin, " +
"use the `FindPlugins` recipe instead.";
}

@Option(displayName = "Group",
Expand Down
Loading
0