OpenRewrite recipe best practices

Add to your build

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

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

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-rewrite:0.33.0")
}

./gradlew rewriteRun

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.recipes.rewrite.OpenRewriteRecipeBestPractices

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-rewrite:RELEASE

Definition

This recipe runs the following recipes in order.

• Set the Develocity server https://community.develocity.cloud/org.openrewrite.gradle.plugins.SetDevelocityServer
• Set the Develocity projectId openrewriteorg.openrewrite.gradle.plugins.SetDevelocityProjectId
• Inline calls to deprecated OpenRewrite methodsorg.openrewrite.recipes.rewrite.InlineMethods
• Generate InlineMethodCalls recipes for deprecated delegating methodsorg.openrewrite.java.recipes.GenerateDeprecatedMethodRecipes
• Java Recipe best practicesorg.openrewrite.java.recipes.JavaRecipeBestPractices
• Recipe testing best practicesorg.openrewrite.java.recipes.RecipeTestingBestPractices
• Recipe nullability best practicesorg.openrewrite.java.recipes.RecipeNullabilityBestPractices
• Remove elements annotated with @ToBeRemoved past their dateorg.openrewrite.java.recipes.RemoveToBeRemoved
• Migrate tests to Java 21org.openrewrite.java.recipes.UpgradeTestsToJava21
• Extract documentation examples from testsorg.openrewrite.java.recipes.ExamplesExtractor
• Order importsorg.openrewrite.java.OrderImports
• Remove unused importsorg.openrewrite.java.RemoveUnusedImports
• Simplify single-element annotationorg.openrewrite.java.SimplifySingleElementAnnotation
• End files with a single newlineorg.openrewrite.java.format.EmptyNewlineAtEndOfFile
• Remove trailing whitespaceorg.openrewrite.java.format.RemoveTrailingWhitespace
• Inline variableorg.openrewrite.staticanalysis.InlineVariable
• Operator wrappingorg.openrewrite.staticanalysis.OperatorWrap
• Remove unused local variablesorg.openrewrite.staticanalysis.RemoveUnusedLocalVariables
• Remove unused private fieldsorg.openrewrite.staticanalysis.RemoveUnusedPrivateFields
• Remove unused private methodsorg.openrewrite.staticanalysis.RemoveUnusedPrivateMethods
• Unwrap else block after return or throw statementorg.openrewrite.staticanalysis.UnwrapElseAfterReturn
• Equals avoids nullorg.openrewrite.staticanalysis.EqualsAvoidsNull
• Add missing @Override to overriding and implementing methodsorg.openrewrite.staticanalysis.MissingOverrideAnnotation
• Week Year (YYYY) should not be used for date formattingorg.openrewrite.staticanalysis.ReplaceWeekYearWithYear
• hashCode() should not be called on array instancesorg.openrewrite.staticanalysis.RemoveHashCodeCallsFromArrayInstances
• Remove toString() calls on arraysorg.openrewrite.staticanalysis.RemoveToStringCallsFromArrayInstances
• Replaces Object.notify() with Object.notifyAll()org.openrewrite.staticanalysis.UseObjectNotifyAll
• Remove garbage collection invocationsorg.openrewrite.staticanalysis.RemoveCallsToSystemGc
• Remove Object.finalize() invocationsorg.openrewrite.staticanalysis.RemoveCallsToObjectFinalize
• URL Equals and Hash Codeorg.openrewrite.staticanalysis.URLEqualsHashCodeRecipes
• Simplify lambda blocks to expressionsorg.openrewrite.staticanalysis.LambdaBlockToExpression
• Use method references in lambdaorg.openrewrite.staticanalysis.ReplaceLambdaWithMethodReference
• Use the diamond operatororg.openrewrite.staticanalysis.UseDiamondOperator
• Remove unnecessary parenthesesorg.openrewrite.staticanalysis.UnnecessaryParentheses
• Remove redundant null checks before instanceoforg.openrewrite.staticanalysis.RemoveRedundantNullCheckBeforeInstanceof
• Replace StringBuilder#append with Stringorg.openrewrite.staticanalysis.ReplaceStringBuilderWithString
• Use Collection interfacesorg.openrewrite.staticanalysis.UseCollectionInterfaces
• Enum values should be compared with "=="org.openrewrite.staticanalysis.CompareEnumsWithEqualityOperator
• Combine semantically equal catch blocksorg.openrewrite.staticanalysis.CombineSemanticallyEqualCatchBlocks
• Use String::replace() when first parameter is not a real regular expressionorg.openrewrite.staticanalysis.UseStringReplace
• Use StandardCharset constantsorg.openrewrite.staticanalysis.UseStandardCharset
• Use System.lineSeparator()org.openrewrite.staticanalysis.UseSystemLineSeparator
• Remove redundant castsorg.openrewrite.staticanalysis.RemoveRedundantTypeCast
• Replace java.util.Stack with java.util.Dequeorg.openrewrite.staticanalysis.ReplaceStackWithDeque
• Replace invocations of Collections#sort(List, Comparator) with List#sort(Comparator)org.openrewrite.staticanalysis.UseListSort
• Use String.contentEquals(CharSequence) instead of String.equals(CharSequence.toString())org.openrewrite.staticanalysis.EqualsToContentEquals
• Use static import java.util.stream.Collectors *(..)org.openrewrite.java.UseStaticImport
• Use static import java.util.Collections *(..)org.openrewrite.java.UseStaticImport

Data tables

Structured output this recipe can produce.

• Deprecated method delegationsDeprecated methods that delegate to another method in the same class, suitable for inlining via `InlineMethodCalls`.org.openrewrite.java.recipes.DeprecatedMethodDelegations
• Maven metadata failuresAttempts to resolve maven metadata that failed.org.openrewrite.maven.table.MavenMetadataFailures
• Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
• Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
• Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
• Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats