Add Maven annotation processor path

org.openrewrite.java.micronaut.AddAnnotationProcessorPath

Add the groupId, artifactId, version, and exclusions of a Maven annotation processor path.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe

• artifactId: rewrite-micronaut

• version: 2.3.1

Options

Type	Name	Description	Example
String	groupId	The groupId to use.	corp.internal.openrewrite.recipe
String	artifactId	The artifactId to use.	my-new-annotation-processor
String	version	An exact version string for the annotation processor path.	${micronaut.validation}
String	onlyIfUsing	Used to determine if the annotation processor will be added.	jakarta.validation.constraints.*
List	exclusions	Optional. A list of exclusions to apply to the annotation processor path in the format groupId:artifactId	io.micronaut:micronaut-inject

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.AddAnnotationProcessorPathExample. 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.AddAnnotationProcessorPathExample
displayName: Add Maven annotation processor path example
recipeList:
  - org.openrewrite.java.micronaut.AddAnnotationProcessorPath:
      groupId: corp.internal.openrewrite.recipe
      artifactId: my-new-annotation-processor
      version: ${micronaut.validation}
      onlyIfUsing: jakarta.validation.constraints.*
      exclusions: io.micronaut:micronaut-inject

Now that com.yourorg.AddAnnotationProcessorPathExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-micronaut:2.3.1 in your build file:

Gradle

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

build.gradle

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

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

repositories {
    mavenCentral()
}

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

2. Run gradle rewriteRun to run the recipe.

Maven

1. Add the following to your pom.xml file:

pom.xml

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.AddAnnotationProcessorPathExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-micronaut</artifactId>
            <version>2.3.1</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe AddAnnotationProcessorPathExample

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.