Skip to main content

Add Gradle or Maven dependency

org.openrewrite.java.dependencies.AddDependency

For a Gradle project, add a gradle dependency to a build.gradle file in the correct configuration based on where it is used. Or For a maven project, Add a Maven dependency to a pom.xml file in the correct scope based on where it is used.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringgroupIdThe first part of a dependency coordinate com.google.guava:guava:VERSION.com.google.guava
StringartifactIdThe second part of a dependency coordinate com.google.guava:guava:VERSIONguava
StringversionOptional. An exact version number or node-style semver selector used to select the version number.29.X
StringversionPatternOptional. Allows 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-jre
StringonlyIfUsingOptional. Used to determine if the dependency will be added and in which scope it should be placed.org.junit.jupiter.api.*
StringclassifierOptional. A classifier to add. Commonly used to select variants of a library.test
StringfamilyPatternOptional. A pattern, applied to groupIds, used to determine which other dependencies should have aligned version numbers. Accepts '*' as a wildcard character.com.fasterxml.jackson*
StringextensionOptional. For Gradle only, The extension of the dependency to add. If omitted Gradle defaults to assuming the type is "jar".jar
StringconfigurationOptional. The Gradle dependency configuration name within which to place the dependency. When omitted the configuration will be determined by the Maven scope parameter. If that parameter is also omitted, configuration will be determined based on where types matching onlyIfUsing appear in source code.implementation
StringscopeOptional. The Maven scope within which to place the dependency. When omitted scope will be determined based on where types matching onlyIfUsing appear in source code. Valid options: compile, provided, runtime, testruntime
BooleanreleasesOnlyOptional. For Maven only, Whether to exclude snapshots from consideration when using a semver selector
StringtypeOptional. For Maven only, The type of dependency to add. If omitted Maven defaults to assuming the type is "jar". Valid options: jar, pom, warjar
BooleanoptionalOptional. Set the value of the <optional> tag. No <optional> tag will be added when this is null.
BooleanacceptTransitiveOptional. Default false. If enabled, the dependency will not be added if it is already on the classpath as a transitive dependency.true

Used by​

This recipe is used as part of the following composite recipes:

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.AddDependencyExample. 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.AddDependencyExample
displayName: Add Gradle or Maven dependency example
recipeList:
  - org.openrewrite.java.dependencies.AddDependency:
      groupId: com.google.guava
      artifactId: guava
      version: 29.X
      versionPattern: '-jre'
      onlyIfUsing: org.junit.jupiter.api.*
      classifier: test
      familyPattern: com.fasterxml.jackson*
      extension: jar
      configuration: implementation
      scope: runtime
      type: jar
      acceptTransitive: true

Now that com.yourorg.AddDependencyExample has been defined, activate it and take a dependency on org.openrewrite.recipe:rewrite-java-dependencies:1.44.0 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.AddDependencyExample")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-java-dependencies:1.44.0")
}
  1. 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.