Skip to main content

OpenRewrite recipe best practices

org.openrewrite.recipes.rewrite.OpenRewriteRecipeBestPractices

Best practices for OpenRewrite recipe development.

Recipe source​

GitHub: recipebestpractice.yml, Issue Tracker, Maven Central

info

This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.

This recipe is available under the Moderne Source Available License.

Definition​

Usage​

This recipe has no required configuration options. It can be activated by adding a dependency on `org.openrewrite.recipe:rewrite-rewrite` in your build file or by running a shell command (in which case no build changes are needed):

  1. Add the following to your build.gradle file:
    build.gradle
    plugins {
        id("org.openrewrite.rewrite") version("latest.release")
    }

    rewrite {
        activeRecipe("org.openrewrite.recipes.rewrite.OpenRewriteRecipeBestPractices")
        setExportDatatables(true)
    }

    repositories {
        mavenCentral()
    }

    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-rewrite:0.25.0")
    }
  2. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Deprecated method delegations​

org.openrewrite.java.recipes.DeprecatedMethodDelegations

Deprecated methods that delegate to another method in the same class, suitable for inlining via InlineMethodCalls.

Column NameDescription
Method patternThe method pattern of the deprecated method.
ReplacementThe replacement expression to inline.
Recipe YAMLA YAML snippet that can be copied into a recipe list.