← All recipes
Open source

Repository has dependency

Recipe IDorg.openrewrite.java.dependencies.search.RepositoryHasDependency
Artifactorg.openrewrite.recipe:rewrite-java-dependencies

Searches for both Gradle and Maven modules that have a dependency matching the specified groupId and artifactId. Places a SearchResult marker on all sources within a repository with a matching dependency. This recipe is intended to be used as a precondition for other recipes. For example this could be used to limit the application of a spring boot migration to only projects that use a springframework dependency, limiting unnecessary upgrading. If the search result you want is instead just the build.gradle(.kts) or pom.xml file applying the plugin, use the FindDependency recipe instead.

Single recipeApache 2.0

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.dependencies.search.RepositoryHasDependency --recipe-option "groupIdPattern=com.fasterxml.jackson.module" --recipe-option "artifactIdPattern=jackson-module-*"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-java-dependencies:1.60.0

Options

NameTypeDescription
groupIdPatternrequiredStringGroup glob pattern used to match dependencies.
e.g. com.fasterxml.jackson.module
artifactIdPatternrequiredStringArtifact glob pattern used to match dependencies.
e.g. jackson-module-*
scopeStringMatch dependencies with the specified scope. All scopes are searched by default.
e.g. compile
versionStringMatch only dependencies with the specified version. Node-style version selectors may be used.All versions are searched by default.
e.g. 1.x

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats