Recipe to completely remove plugin usage from build.gradle(.kts)

[Crustack]

Hi there,
I am currently trying to come up with a recipe.yml that reliably removes checkstyle gradle plugin and its configs from any given build.gradle/build.gradle.kts.
The whole use-case is to replace checkstyle plugin with spotless plugin .

From what I understand (see #5722), I can leverage the RemoveBuildPlugin and RemoveExtension to remove the plugin declaration + extension function.
But what about usages like:

tasks.withType(Checkstyle).configureEach {
    javaLauncher = javaToolchains.launcherFor {
        languageVersion = JavaLanguageVersion.of(17)
    }
}

How can I make sure these kinds of checkstyle configs are removed as well?
Is it somehow possible to have a recipe that removes all usages of a given package? (I guess not, because from what I understand OpenRewrite has no idea where e.g. Checkstyle class originates from?)

[timtebeek]

hi! Thanks for explaining your intended use; makes sense indeed. I think this would have to be a dedicated recipe that can pull together a few existing ones like the RemoveBuildPlugin and RemoveExtension that you've already linked, plus one or more custom visitors to remove method invocations associated with specific classes for as much as type information allows. Welcome to push up a RemoveGradleCheckstyle draft PR with as much as you can manage (and crucially: tests for what you couldn't yet), and then we can see if we can fill that out to mostly work.

[Crustack]

hi! Thanks for explaining your intended use; makes sense indeed. I think this would have to be a dedicated recipe that can pull together a few existing ones like the RemoveBuildPlugin and RemoveExtension that you've already linked, plus one or more custom visitors to remove method invocations associated with specific classes for as much as type information allows. Welcome to push up a RemoveGradleCheckstyle draft PR with as much as you can manage (and crucially: tests for what you couldn't yet), and then we can see if we can fill that out to mostly work.

Thanks for your quick response. I will try to come up with a draft for it.

In the mean time, for the other part of my desired recipe, adding spotless plugin:
How can I add the plugin extension, something like this to build.gradle/build.gradle.kts:

spotless {
    java {
        cleanthat()
        removeUnusedImports()
        prettier(mapOf("prettier-plugin-java" to "latest"))
            .configFile(project.file("config/prettier.yaml"))
        formatAnnotations()
    }
}

Is there any existing recipe to do this?
I only found Migrate from Gradle Enterprise to Develocity which seems to use completely custom visitors to replace the gradleEnterprise extension with develocity, but I was wondering if there is a RemoveExtension, isnt there a AddExtension?

[timtebeek]

I don't think there is to add an extension, and custom visitors like the one you've seen might be the best pattern to copy for now. Should be even more straightforward when there is no migration of old settings to do.

The reason we recommend custom visitors is that quite quickly you'd need snippets of configuration like the one you've seen above, and then also have to handle where those should be added, taking into account multi module projects, and potentially existing / conflicting config. That quickly needs more logic than a generic declarative recipe can provide out of the box.

[Crustack]

I see, thanks for the information.
I guess I just thought if there are remove-recipes then there would also be add-recipes.
And I mean the multi module projects problem is already relevant for RemoveBuildPlugin and AddBuildPlugin, or do they have special treatment for such projects (e.g. if I use AddBuildPlugin, does it add the plugin to every build.gradle in the entire project or only the parent project)?

Anyway, I have not yet come around to setup a repo for custom Recipes/Visitors as I wanted to stick with YAML Recipes since I dont get that much time at work to develop OpenRewrite recipes.
But if I find the time I guess I will try to implement a custom Recipe analogue to Migrate from Gradle Enterprise to Develocity

The difference between Migrate from Gradle Enterprise to Develocity and my use-case is also that I dont "only" want to replace checkstyle with spotless. The recipe should be run on a lot of projects, some of them currently do not have checkstyle configured, but after the recipe ran it should have spotless plugin configured, doesnt matter if it had checkstyle configured or not before.