What is a build.gradle identified as?

[Tajae1532]

Hello I'm working on a recipe that finds build.gradle and build.gradle.kts files and I want to know what are they under? I have tried sourceFile, sourcePath and PlainText but none of them pick it up.

[timtebeek]

hi @Tajae1532 ! I find it helps to look at existing recipes when exploring a new recipe. For build.gradle files look at this example:

rewrite/rewrite-gradle/src/main/java/org/openrewrite/gradle/ChangeDependency.java

Lines 157 to 164 in 1095923

	public TreeVisitor<?, ExecutionContext> getVisitor() {
	return Preconditions.check(new FindGradleProject(FindGradleProject.SearchCriteria.Marker).getVisitor(), new GroovyIsoVisitor<ExecutionContext>() {
	final DependencyMatcher depMatcher = requireNonNull(DependencyMatcher.build(oldGroupId + ":" + oldArtifactId).getValue());
	GradleProject gradleProject;
	@Override
	public G.CompilationUnit visitCompilationUnit(G.CompilationUnit cu, ExecutionContext ctx) {

For .kts files look here:

• Dependency management support for Gradle Kotlin scripts (.kts) #3291

[Tajae1532]

Hello, this is part of a greater recipe. What I mean is I want to independently find build.gradle files
An if check

[timtebeek]

It's not clear to me what you're asking; might it help to look at the FindGradleProject recipe also used above?

rewrite/rewrite-gradle/src/main/java/org/openrewrite/gradle/search/FindGradleProject.java

Line 32 in 1095923

public class FindGradleProject extends Recipe {

[Tajae1532]

For example if I wanted to look for Dockerfile we can say
if (text.sourcePath.fileName.toString() == "Dockerfile")

or if I wanted to find a pom.xml we can say
if (tree.sourcePath.endsWith("pom.xml")

or even a Jenkinsfile we can say
if (sourceFile.sourcePath.fileName.toString() == "Jenkinsfile")

The question I'm asking is what is the equivalent for finding build.gradle files

[timtebeek]

The equivalent would the that return Preconditions.check(new FindGradleProject(FindGradleProject.SearchCriteria.Marker).getVisitor(), ... the actual visitor you want to run...);. I'll connect you with a colleague of yours for these patterns.

[shanman190]

As Tim was eluding to, understanding your context better would help.

As a for instance, for imperative recipes there is the helper visitor IsBuildGradle which just inspects the source path. If you're wanting to act as a precondition, FindSourceFiles can be a friend. Then lastly there is the FindGradleProject recipe which introspects deeper than just the source path itself by checking that the LST SourceFile also has a GradleProject marker.

As Tim said, looking at the implementations of various existing recipes can be helpful in finding these sort of features.