Skip to main content

Effective dependencies

org.openrewrite.maven.search.EffectiveDependencies

Emit the data of binary dependency relationships.

Recipe source

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options

TypeNameDescriptionExample
StringscopeMatch dependencies with the specified scope Valid options: compile, test, runtime, providedcompile

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.EffectiveDependenciesExample. 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.EffectiveDependenciesExample
displayName: Effective dependencies example
recipeList:
- org.openrewrite.maven.search.EffectiveDependencies:
scope: compile

Now that com.yourorg.EffectiveDependenciesExample has been defined, activate it in your build file:

  1. Add the following to your pom.xml file:
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>6.8.0</version>
<configuration>
<exportDatatables>true</exportDatatables>
<activeRecipes>
<recipe>com.yourorg.EffectiveDependenciesExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
  1. Run mvn rewrite:run 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

Dependency graph

org.openrewrite.maven.table.DependencyGraph

Relationships between dependencies.

Column NameDescription
Project nameThe name of the project that contains the dependency.
Source setThe source set that contains the dependency.
From dependencyWhat depends on the 'to' dependency.
From dependencyA dependency.

Contributors

Jonathan Schneider