Links

Add Gradle dependency

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

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-gradle
  • version: 7.35.0

Options

Type
Name
Description
String
groupId
The first part of a dependency coordinate 'com.google.guava:guava:VERSION'.
String
artifactId
The second part of a dependency coordinate 'com.google.guava:guava:VERSION'
String
version
An exact version number or node-style semver selector used to select the version number.
String
versionPattern
Optional. 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
String
configuration
Optional. A 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 of yet unused dependency.
String
onlyIfUsing
Used to determine if the dependency will be added and in which scope it should be placed.
String
classifier
Optional. A Maven classifier to add. Mostly commonly used to select shaded to test variants of a library.
String
extension
Optional. The extension of the dependency to add. If omitted Gradle defaults to assuming the type is "jar".
String
familyPattern
Optional. A pattern, applied to groupIds, used to determine which other dependencies should have aligned version numbers. Accepts '*' as a wildcard character.

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. 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 dependency example
recipeList:
- org.openrewrite.gradle.AddDependency:
groupId: com.google.guava
artifactId: guava
version: 29.X
versionPattern: '-jre'
configuration: implementation
onlyIfUsing: org.junit.jupiter.api.*
classifier: test
extension: jar
familyPattern: com.fasterxml.jackson*
Now that com.yourorg.AddDependencyExample has been defined activate it and take a dependency on org.openrewrite:rewrite-gradle:7.35.0 in your build file:
Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.34.0")
}
rewrite {
activeRecipe("com.yourorg.AddDependencyExample")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite:rewrite-gradle:7.35.0")
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.39.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.AddDependencyExample</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite</groupId>
<artifactId>rewrite-gradle</artifactId>
<version>7.35.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
Recipes can also be activated directly from the command line by adding the argument -Drewrite.activeRecipes=com.yourorg.AddDependencyExample

See how this recipe works across multiple open-source repositories

Moderne Link Image
The Moderne public SaaS instance 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.