Add an annotation processor to the Maven Compiler plugin configuration

io.quarkus.updates.core.quarkus37.AddMavenCompilerAnnotationProcessor

Add an annotation processor to the Maven Compiler plugin configuration.

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite.recipe

  • artifactId: rewrite-third-party

  • version: 0.5.1

Options

TypeNameDescriptionExample

String

groupId

The groupId of the annotation processor.

org.hibernate.orm

String

artifactId

The artifactId of the annotation processor.

hibernate-jpamodelgen

Boolean

enforceManagedVersion

Optional. If the new annotation processor has a managed version, this flag can be used to explicitly set the version on the annotation processor with the version of the managed dependency. The default for this flag is false.

String

mavenCompilerPluginVersion

Optional. The version of the Maven Compiler plugin to use if not present.

hibernate-jpamodelgen

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.AddMavenCompilerAnnotationProcessorExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.AddMavenCompilerAnnotationProcessorExample
displayName: Add an annotation processor to the Maven Compiler plugin configuration example
recipeList:
  - io.quarkus.updates.core.quarkus37.AddMavenCompilerAnnotationProcessor:
      groupId: org.hibernate.orm
      artifactId: hibernate-jpamodelgen
      mavenCompilerPluginVersion: hibernate-jpamodelgen

Now that com.yourorg.AddMavenCompilerAnnotationProcessorExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-third-party:0.5.1 in your build file:

  1. Add the following to your build.gradle file:

build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.16.1")
}

rewrite {
    activeRecipe("com.yourorg.AddMavenCompilerAnnotationProcessorExample")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-third-party:0.5.1")
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories

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.

Last updated