Find Gradle dependency
** org.openrewrite.gradle.search.FindDependency** _Finds dependencies declared in build.gradle files. See the reference on Gradle configurations or the diagram below for a description of what configuration to use. A project's compile and runtime classpath is based on these configurations.
A project's test classpath is based on these configurations.
_

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-gradle
  • version: 7.24.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
configuration
Optional. The dependency configuration to search for dependencies in.

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.FindDependencyExample. Here's how you can define and customize such a recipe within your rewrite.yml:
rewrite.yml
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.FindDependencyExample
4
displayName: Find Gradle dependency example
5
recipeList:
6
- org.openrewrite.gradle.search.FindDependency:
7
groupId: com.google.guava
8
artifactId: guava
9
configuration: api
Copied!
Now that com.yourorg.FindDependencyExample has been defined activate it and take a dependency on org.openrewrite:rewrite-gradle:7.24.0 in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
id("org.openrewrite.rewrite") version("5.22.2")
3
}
4
5
rewrite {
6
activeRecipe("com.yourorg.FindDependencyExample")
7
}
8
9
repositories {
10
mavenCentral()
11
}
12
13
dependencies {
14
rewrite("org.openrewrite:rewrite-gradle:7.24.0")
15
}
Copied!
pom.xml
1
<project>
2
<build>
3
<plugins>
4
<plugin>
5
<groupId>org.openrewrite.maven</groupId>
6
<artifactId>rewrite-maven-plugin</artifactId>
7
<version>4.25.0</version>
8
<configuration>
9
<activeRecipes>
10
<recipe>com.yourorg.FindDependencyExample</recipe>
11
</activeRecipes>
12
</configuration>
13
<dependencies>
14
<dependency>
15
<groupId>org.openrewrite</groupId>
16
<artifactId>rewrite-gradle</artifactId>
17
<version>7.24.0</version>
18
</dependency>
19
</dependencies>
20
</plugin>
21
</plugins>
22
</build>
23
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipescom.yourorg.FindDependencyExample
Export as PDF
Copy link