Moderne licensed

Add an API dependency for explicit imports

Recipe IDorg.openrewrite.java.migrate.javax.AddApiDependencyForImportsArtifactorg.openrewrite.recipe:rewrite-migrate-java

Add an API dependency to the nearest Maven module importing the package, including imports whose types could not be resolved by the parser because the JDK used to provide them. A module that already has the API in the needed scope, or from a dependency it declares as provided, is left alone.

Single 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.javax.AddApiDependencyForImports")
}

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.46.0")
}

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.migrate.javax.AddApiDependencyForImports --recipe-option "packageName=jakarta.xml.bind" --recipe-option "groupId=jakarta.xml.bind" --recipe-option "artifactId=jakarta.xml.bind-api" --recipe-option "version=3.0.x"

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

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

Options

Name	Type	Description
`packageName`required	`String`	The package whose imports need the API. A `jakarta` package also matches imports of its `javax` predecessor. e.g. `jakarta.xml.bind`
`groupId`required	`String`	The group ID of the API dependency. e.g. `jakarta.xml.bind`
`artifactId`required	`String`	The artifact ID of the API dependency. e.g. `jakarta.xml.bind-api`
`version`required	`String`	The version of the API dependency to add. e.g. `3.0.x`

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