← All recipes
Moderne licensed

Module has dependency

Recipe IDorg.openrewrite.golang.search.ModuleHasDependencyArtifactorg.openrewrite:rewrite-go

Searches for Go modules that have a dependency matching the specified module path. Places a SearchResult marker on all sources within a module 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 migration to only modules that use a specific version of a library. If the search result you want is instead just the require directive in go.mod, use the DependencyInsight recipe instead.

Single recipeMSAL

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

settings.gradle.kts

pluginManagement {
    repositories {
        maven {
            url = uri("https://artifacts.codegenomeproject.org/maven")
            credentials {
                username = providers.gradleProperty("codeGenomeUsername").get()
                password = providers.gradleProperty("codeGenomeToken").get()
            }
        }
        gradlePluginPortal()
    }
}

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.golang.search.ModuleHasDependency")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite:rewrite-go:8.93.8")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

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

mod run . --recipe org.openrewrite.golang.search.ModuleHasDependency --recipe-option "modulePattern=github.com/aws/aws-sdk-go-v2*"

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

mod config recipes jar install org.openrewrite:rewrite-go:RELEASE

Options

NameTypeDescription
modulePatternrequiredStringA glob pattern to match Go module paths. Use * as a wildcard.
e.g. github.com/aws/aws-sdk-go-v2*
versionStringMatch only dependencies with the specified version. An exact version or a version range (see the version selector syntax) may be used. Direct dependencies are compared by the version in their require directive. All versions are searched by default.
e.g. 1.x
onlyDirectBooleanIf enabled, transitive dependencies will not be considered. All dependencies are searched by default.
e.g. true

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