Skip to main content

Module has dependency

org.openrewrite.gradle.search.ModuleHasDependency

Searches for Gradle Projects (modules) that have a dependency matching the specified id or implementing class. Places a SearchResult marker on all sources within a project 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 spring-boot-starter, limiting unnecessary upgrading. If the search result you want is instead just the build.gradle(.kts) file that use the dependency, use the FindDependency recipe instead.

Recipe source​

GitHub, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringgroupIdPatternGroup glob pattern used to match dependencies.com.fasterxml.jackson.module
StringartifactIdPatternArtifact glob pattern used to match dependencies.jackson-module-*
StringversionOptional. Match only dependencies with the specified version. Node-style version selectors may be used.All versions are searched by default.1.x
StringconfigurationOptional. Match dependencies with the specified scope. If not specified, all configurations will be searched.compileClasspath

Example​

Parameters​
ParameterValue
groupIdPatternorg.openrewrite.recipe
artifactIdPatternrewrite-spring
versionnull
configurationnull
Before​
build.gradle
plugins {
    id 'java'
}
repositories {
    mavenCentral()
}
dependencies {
    implementation 'org.openrewrite.recipe:rewrite-spring:6.7.0'
}
After​
build.gradle
/*~~(Module has dependency: org.openrewrite.recipe:rewrite-spring)~~>*/plugins {
    id 'java'
}
repositories {
    mavenCentral()
}
dependencies {
    implementation 'org.openrewrite.recipe:rewrite-spring:6.7.0'
}
Unchanged​
build.gradle
plugins {
  id 'java'
}
repositories {
  mavenCentral()
}
dependencies {
    implementation 'org.openrewrite:rewrite-gradle:8.52.0'
}
Before​
class A {}
After​
/*~~(Module has dependency: org.openrewrite.recipe:rewrite-spring)~~>*/class A {}
Unchanged​
class B {}
Unchanged​
multi-project-build
Unchanged​
other-project
Unchanged​
project-applies-openrewrite-plugin
Unchanged​
include 'project-applies-openrewrite-plugin'
include 'other-project'

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.ModuleHasDependencyExample. 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.ModuleHasDependencyExample
displayName: Module has dependency example
recipeList:
  - org.openrewrite.gradle.search.ModuleHasDependency:
      groupIdPattern: com.fasterxml.jackson.module
      artifactIdPattern: jackson-module-*
      version: 1.x
      configuration: compileClasspath

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

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.7.0")
}

rewrite {
    activeRecipe("com.yourorg.ModuleHasDependencyExample")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}
  1. Run gradle rewriteRun 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​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.