← All recipes
Open source

Add Gradle platform dependency

Recipe IDorg.openrewrite.gradle.AddPlatformDependency
Artifactorg.openrewrite:rewrite-gradle

Add a gradle platform dependency to a build.gradle file in the correct configuration based on where it is used.

Single recipeApache 2.0

Usage

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

mod run . --recipe org.openrewrite.gradle.AddPlatformDependency --recipe-option "groupId=com.google.guava" --recipe-option "artifactId=guava"

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

mod config recipes jar install org.openrewrite:rewrite-gradle:8.88.0

Options

NameTypeDescription
groupIdrequiredStringThe first part of a dependency coordinate 'com.google.guava:guava:VERSION'.
e.g. com.google.guava
artifactIdrequiredStringThe second part of a dependency coordinate 'com.google.guava:guava:VERSION'
e.g. guava
versionStringAn exact version number or node-style semver selector used to select the version number. You can also use latest.release for the latest available version and latest.patch if the current version is a valid semantic version. For more details, you can look at the documentation page of version selectors.
e.g. 29.X
versionPatternStringAllows version selection to be extended beyond the original Node Semver semantics. So for example, Setting 'version' to "25-29" can be paired with a metadata pattern of "-jre" to select Guava 29.0-jre
e.g. -jre
configurationStringA configuration to use when it is not what can be inferred from usage. Most of the time this will be left empty, but is used when adding a new, as yet unused, dependency.
e.g. implementation
enforcedBooleanUsed to determine whether the platform dependency should be enforcedPlatform.
e.g. true

Data tables

Structured output this recipe can produce.

  • Maven metadata failuresAttempts to resolve maven metadata that failed.org.openrewrite.maven.table.MavenMetadataFailures
  • 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