← All recipes
Open source

Add Maven annotation processor path

Recipe IDorg.openrewrite.java.micronaut.AddAnnotationProcessorPathArtifactorg.openrewrite.recipe:rewrite-micronaut

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

Single recipeApache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.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.micronaut.AddAnnotationProcessorPath")
}

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-micronaut:2.38.1")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.micronaut.AddAnnotationProcessorPath --recipe-option "groupId=corp.internal.openrewrite.recipe" --recipe-option "artifactId=my-new-annotation-processor" --recipe-option "version=${micronaut.validation}" --recipe-option "onlyIfUsing=jakarta.validation.constraints.*"

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

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

Options

NameTypeDescription
groupIdrequiredStringThe groupId to use.
e.g. corp.internal.openrewrite.recipe
artifactIdrequiredStringThe artifactId to use.
e.g. my-new-annotation-processor
versionrequiredStringAn exact version string for the annotation processor path.
e.g. ${micronaut.validation}
onlyIfUsingrequiredStringUsed to determine if the annotation processor will be added.
e.g. jakarta.validation.constraints.*
exclusionsListA list of exclusions to apply to the annotation processor path in the format groupId:artifactId
e.g. io.micronaut:micronaut-inject

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