Skip to main content

Add lombok-mapstruct-binding when both MapStruct and Lombok are used

org.openrewrite.java.migrate.AddLombokMapstructBinding

Add the lombok-mapstruct-binding annotation processor as needed when both MapStruct and Lombok are used.

Tags​

Recipe source​

GitHub: java-version-17.yml, Issue Tracker, Code Genome Project

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. Moderne customers can download precompiled artifacts from The Code Genome Project. For non-commercial use you can build the artifact from source locally.

Definition​

Preconditions

Recipes

Used by​

This recipe is used as part of the following composite recipes:

Examples​

Example 1​

AddLombokMapstructBindingTest#addForGradle

Before​
build.gradle
plugins { id 'java' }
repositories { mavenCentral() }
dependencies {
    implementation "org.projectlombok:lombok:1.18.42"
    implementation "org.mapstruct:mapstruct:1.6.3"
}
After​
build.gradle
plugins { id 'java' }
repositories { mavenCentral() }
dependencies {
    annotationProcessor "org.projectlombok:lombok-mapstruct-binding:0.2.0"

    implementation "org.projectlombok:lombok:1.18.42"
    implementation "org.mapstruct:mapstruct:1.6.3"
}
Unchanged​
project
Example 2​

AddLombokMapstructBindingTest#addForGradle

Before​
build.gradle
plugins { id 'java' }
repositories { mavenCentral() }
dependencies {
    implementation "org.projectlombok:lombok:1.18.42"
    implementation "org.mapstruct:mapstruct:1.6.3"
}
After​
build.gradle
plugins { id 'java' }
repositories { mavenCentral() }
dependencies {
    annotationProcessor "org.projectlombok:lombok-mapstruct-binding:0.2.0"

    implementation "org.projectlombok:lombok:1.18.42"
    implementation "org.mapstruct:mapstruct:1.6.3"
}
Unchanged​
project

Usage​

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

OpenRewrite artifacts are distributed through the Code Genome Project repository (https://artifacts.codegenomeproject.org/maven), which requires authentication. Sign in to the Code Genome Project to create a download token, then in the snippets below replace USERNAME with the email or username you signed in with and TOKEN with that token. See the quickstart guide for details.

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

    rewrite {
        activeRecipe("org.openrewrite.java.migrate.AddLombokMapstructBinding")
        setExportDatatables(true)
    }

    repositories {
        mavenCentral()
        maven {
            url = "https://artifacts.codegenomeproject.org/maven"
            credentials {
                username = "USERNAME"
                password = "TOKEN"
            }
        }
    }

    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-migrate-java:3.41.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​

Maven metadata failures​

org.openrewrite.maven.table.MavenMetadataFailures

Attempts to resolve maven metadata that failed.

Column NameDescription
Group idThe groupId of the artifact for which the metadata download failed.
Artifact idThe artifactId of the artifact for which the metadata download failed.
VersionThe version of the artifact for which the metadata download failed.
Maven repositoryThe URL of the Maven repository that the metadata download failed on.
SnapshotsDoes the repository support snapshots.
ReleasesDoes the repository support releases.
FailureThe reason the metadata download failed.