Removing build.gradle configuration along with plugin

[nspyke]

I'm evaluating the use of OpenRewrite in my organization.
When running the Remove Gradle Plugin it remove the plugin from the plugins block at the top of my build.gradle file, but it leaves the plugin configuration further down.

From what I can tell from this recipes tests, it is not designed to remove the configuration.
What is the recommended approach to do this, as the Gradle build will fail if I do not also remove the configuration?

For example,

---
type: specs.openrewrite.org/v1beta/recipe
name: GradlePlugins
displayName: Update and remove Gradle plugins
recipeList:
  - org.openrewrite.gradle.plugins.RemoveBuildPlugin:
      pluginId: com.github.ben-manes.versions 

This removes id 'com.github.ben-manes.versions' version '0.36.0' from

plugins {
  id 'java'
  id 'com.github.ben-manes.versions' version '0.36.0'
}

as expected.

However, it leaves the related plugin configuration,

dependencyTrack {
  projectName = project.name
  projectVersion = project.ext.buildNumber
  apiKey = project.property('dependency.track.api.key')
}

Is there another recipe that I can run that removes the dependencyTrack Groovy block?
Or am I needing to look at writing something custom?

[timtebeek]

hi @nspyke ; Indeed that recipe does not remove any associated configuration just yet, as I don't think we have a clear link between those two. It should be fairly straightforward to write a recipe to remove the config as well; that's mapped as a method invocation, so could be removed with for instance this recipe:

rewrite/rewrite-java/src/main/java/org/openrewrite/java/RemoveMethodInvocations.java

Lines 27 to 52 in 4c870fa

	public class RemoveMethodInvocations extends Recipe {
	@Option(displayName = "Method pattern",
	description = "A pattern to match method invocations for removal. " + MethodMatcher.METHOD_PATTERN_DESCRIPTION,
	example = "java.lang.StringBuilder append(java.lang.String)")
	String methodPattern;
	@Override
	public String getDisplayName() {
	return "Remove method invocations";
	}
	@Override
	public String getDescription() {
	return "Remove method invocations if syntactically safe.";
	}
	@Override
	public Validated<Object> validate() {
	return super.validate().and(MethodMatcher.validate(methodPattern));
	}
	@Override
	public TreeVisitor<?, ExecutionContext> getVisitor() {
	return Preconditions.check(new UsesMethod<>(methodPattern),
	new RemoveMethodInvocationsVisitor(singletonList(methodPattern)));
	}

If that fails then a small dedicated recipe could work as well; you'll want to use GroovyVisitor, override visitMethodInvocation and return null there.

[nspyke]

Thanks @timtebeek. This looks like something that would be great to have as a built-in Gradle/Groovy recipe.

[timtebeek]

There's now a new recipe that allows you to remove gradle build extensions:

• Remove Gradle buildCache configuration #5826

Next release to follow this Wednesday. Hope that helps you there!