Java 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.java.recipes.JavaRecipeBestPractices")
}

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.java.recipes.JavaRecipeBestPractices

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.

• Add a blank line around fields with annotationsorg.openrewrite.java.recipes.BlankLinesAroundFieldsWithAnnotations
• Correctly spaced descriptionsorg.openrewrite.java.recipes.CorrectlySpacedDescriptions
• Use a standard name for ExecutionContextorg.openrewrite.java.recipes.ExecutionContextParameterName
• Inline nested visitor classes into the returning methodorg.openrewrite.java.recipes.InlineNestedVisitorClass
• Use J.Literal.isLiteralValue(expression, null)org.openrewrite.java.recipes.IsLiteralNullRecipe
• Find missing @Option example valuesorg.openrewrite.java.recipes.MissingOptionExample
• Recipe classes should not have mutable static fieldsorg.openrewrite.java.recipes.NoMutableStaticFieldsInRecipes
• Use of @EqualsAndHashCode on Recipeorg.openrewrite.java.recipes.RecipeEqualsAndHashCodeCallSuper
• Recipe classes should be publicorg.openrewrite.java.recipes.RecipeClassesShouldBePublic
• Reorder maybeRemoveImport before maybeAddImportorg.openrewrite.java.recipes.RemoveImportBeforeAddImport
• Replace getDisplayName() and getDescription() methods with fieldsorg.openrewrite.java.recipes.UseDisplayNameAndDescriptionFields
• Replace getEstimatedEffortPerOccurrence() method with fieldorg.openrewrite.java.recipes.UseEstimatedEffortPerOccurrenceField
• Use StringUtils utility methodsorg.openrewrite.java.recipes.UseStringUtilsRecipes
• Replace getTags() method with fieldorg.openrewrite.java.recipes.UseTagsField
• Use JavaTemplate.apply() static methodorg.openrewrite.java.recipes.UseJavaTemplateStaticApply
• Use Tree.randomId() in LST constructorsorg.openrewrite.java.recipes.UseTreeRandomId
• Use visit with parent cursor when calling from another visitororg.openrewrite.java.recipes.UseVisitWithParentCursor
• Fix missing bracesorg.openrewrite.staticanalysis.NeedBraces
• Remove System.out#println statementsorg.openrewrite.staticanalysis.RemoveSystemOutPrintln
• Remove @NlsRewrite annotations from Recipe classesorg.openrewrite.java.recipes.RemoveNlsRewriteAnnotations

Data tables

Structured output this recipe can produce.

• 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