Effective dependencies

org.openrewrite.maven.search.EffectiveDependencies

Emit the data of binary dependency relationships.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-maven

• version: 8.24.0

Options

Type	Name	Description	Example
String	scope	Match dependencies with the specified scope Valid options: compile, test, runtime, provided	compile

Data Tables (Only available on the Moderne platform)

Dependency graph

Relationships between dependencies.

Column Name	Description
Project name	The name of the project that contains the dependency.
Source set	The source set that contains the dependency.
From dependency	What depends on the 'to' dependency.
From dependency	A dependency.

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.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:

Maven

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>5.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.EffectiveDependenciesExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe EffectiveDependenciesExample

See how this recipe works across multiple open-source repositories

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.

Contributors

Jonathan Schneider