Skip to main content

Remove direct dependencies that are managed by a BOM with incompatible versions

org.openrewrite.gradle.RemoveBomManagedDirectDependencies

Removes directly declared dependencies when they have a version that is incompatible with the version managed by an imported BOM (platform or enforcedPlatform). This is useful during framework upgrades (e.g., Spring Boot) where transitive dependencies receive major version bumps and explicitly declared older versions should be removed to use the BOM-managed versions instead. A dependency is only removed when it would still be reachable transitively through another direct dependency in every configuration where it is declared, so the BOM-managed version takes its place rather than the dependency disappearing from the classpath.

Recipe source​

GitHub: RemoveBomManagedDirectDependencies.java, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringbomGroupPatternGroup ID glob pattern for BOMs to consider. For example, org.springframework.boot to match Spring Boot BOMs.org.springframework.boot
StringbomArtifactPatternOptional. Artifact ID glob pattern for BOMs to consider. For example, *-dependencies to match Spring Boot's BOM.*-dependencies
StringdependencyGroupPatternOptional. Group ID glob pattern for dependencies to check against BOM. Use * to match all dependencies.*
StringdependencyArtifactPatternOptional. Artifact ID glob pattern for dependencies to check against BOM. Use * to match all dependencies.*

Example​

Parameters​
ParameterValue
bomGroupPatternorg.springframework.boot
bomArtifactPattern*-dependencies
dependencyGroupPattern*
dependencyArtifactPattern*
Before​
build.gradle
plugins {
    id "java"
}

repositories {
    mavenCentral()
}

dependencies {
    implementation(platform("org.springframework.boot:spring-boot-dependencies:3.3.3"))
    implementation("org.springframework.boot:spring-boot-starter-web")
    implementation("org.apache.tomcat.embed:tomcat-embed-core:9.0.50")
}
After​
build.gradle
plugins {
    id "java"
}

repositories {
    mavenCentral()
}

dependencies {
    implementation(platform("org.springframework.boot:spring-boot-dependencies:3.3.3"))
    implementation("org.springframework.boot:spring-boot-starter-web")
}

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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.RemoveBomManagedDirectDependenciesExample. 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.RemoveBomManagedDirectDependenciesExample
displayName: Remove direct dependencies that are managed by a BOM with incompatible versions example
recipeList:
  - org.openrewrite.gradle.RemoveBomManagedDirectDependencies:
      bomGroupPattern: org.springframework.boot
      bomArtifactPattern: '*-dependencies'
      dependencyGroupPattern: '*'
      dependencyArtifactPattern: '*'

This recipe has no required configuration parameters and comes from a rewrite core library. It can be activated directly without adding any dependencies.

Now that com.yourorg.RemoveBomManagedDirectDependenciesExample has been defined, activate it in your build file:

  1. Add the following to your build.gradle file:
    build.gradle
    plugins {
        id("org.openrewrite.rewrite") version("latest.release")
    }

    rewrite {
        activeRecipe("com.yourorg.RemoveBomManagedDirectDependenciesExample")
        setExportDatatables(true)
    }

    repositories {
        mavenCentral()
    }
  2. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.