Links

Gradle dependency insight

org.openrewrite.gradle.search.DependencyInsight Find direct and transitive dependencies matching a group, artifact, and optionally a configuration name. Results include dependencies that either directly match or transitively include a matching dependency.

Source

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

Options

Type
Name
Description
String
groupIdPattern
Group glob pattern used to match dependencies.
String
artifactIdPattern
Artifact glob pattern used to match dependencies.
String
configuration
Optional. Match dependencies with the specified scope. If not specified, all configurations will be searched.

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.DependencyInsightExample. 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.DependencyInsightExample
displayName: Gradle dependency insight example
recipeList:
- org.openrewrite.gradle.search.DependencyInsight:
groupIdPattern: com.fasterxml.jackson.module
artifactIdPattern: jackson-module-*
configuration: compileClasspath
Now that com.yourorg.DependencyInsightExample 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.DependencyInsightExample")
}
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.DependencyInsightExample</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.DependencyInsightExample

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.