Moderne licensed

Lombok Best Practices

Recipe IDorg.openrewrite.java.migrate.lombok.LombokBestPracticesArtifactorg.openrewrite.recipe:rewrite-migrate-java

Applies all recipes that enforce best practices for using Lombok.

Composite recipeMSAL

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

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

rewrite {
    activeRecipe("org.openrewrite.java.migrate.lombok.LombokBestPractices")
}

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-migrate-java:3.45.0")
}

Then run

./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.migrate.lombok.LombokBestPractices

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

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

Definition

This recipe runs the following recipes in order.

Migrate Lombok to a Java 11 compatible versionorg.openrewrite.java.migrate.lombok.UpdateLombokToJava11
Use Lombok logger annotations instead of explicit fieldsorg.openrewrite.java.migrate.lombok.log.UseLombokLogAnnotations
Convert getter methods to annotationsorg.openrewrite.java.migrate.lombok.UseLombokGetter
Convert setter methods to annotationsorg.openrewrite.java.migrate.lombok.UseLombokSetter
Use @NoArgsConstructor where applicableorg.openrewrite.java.migrate.lombok.UseNoArgsConstructor
Use @RequiredArgsConstructor where applicableorg.openrewrite.java.migrate.lombok.UseRequiredArgsConstructor
Use @AllArgsConstructor where applicableorg.openrewrite.java.migrate.lombok.UseAllArgsConstructor
Change Maven dependency scope for org.projectlombok:lombok to providedorg.openrewrite.maven.ChangeDependencyScope
Change Maven dependency scope for org.projectlombok:lombok-mapstruct-binding to providedorg.openrewrite.maven.ChangeDependencyScope
Exclude Maven dependency org.projectlombok:lombokorg.openrewrite.maven.ExcludeDependency
Enable Lombok annotation processororg.openrewrite.java.migrate.EnableLombokAnnotationProcessor
Append to text fileorg.openrewrite.text.AppendToTextFile

Data tables

Structured output this recipe can produce.

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