← All recipes
Open source

Remove a Gradle or Maven dependency

Recipe IDorg.openrewrite.java.dependencies.RemoveDependencyArtifactorg.openrewrite.recipe:rewrite-java-dependencies

For Gradle project, removes a single dependency from the dependencies section of the build.gradle. For Maven project, removes a single dependency from the <dependencies> section of the pom.xml.

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

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-java-dependencies:1.63.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.dependencies.RemoveDependency --recipe-option "groupId=com.fasterxml.jackson*" --recipe-option "artifactId=jackson-module*"

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

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

Options

NameTypeDescription
groupIdrequiredStringThe first part of a dependency coordinate com.google.guava:guava:VERSION. This can be a glob expression.
e.g. com.fasterxml.jackson*
artifactIdrequiredStringThe second part of a dependency coordinate com.google.guava:guava:VERSION. This can be a glob expression.
e.g. jackson-module*
unlessUsingStringDo not remove if type is in use. Supports glob expressions.
e.g. org.aspectj.lang.*
configurationStringThe dependency configuration to remove from.
e.g. api
scopeStringOnly remove dependencies if they are in this scope. If 'runtime', this willalso remove dependencies in the 'compile' scope because 'compile' dependencies are part of the runtime dependency set
e.g. compile

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