Skip to main content
Moderne OnlyThis recipe is proprietary to Moderne and runs on the Moderne platform or CLI — it isn’t part of the open-source catalog. Available with a Moderne subscription.Contact Sales

Go dependency insight

Recipe IDorg.openrewrite.golang.search.DependencyInsight
Artifactorg.openrewrite:rewrite-go

Find direct and transitive Go module dependencies matching a module path pattern. Results include dependencies that either directly match or transitively include a matching dependency.

Single recipeOpenRewriteModerne Source Available License
Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

3 parameters
1 required2 optional
ParameterExampleTypeRequired
modulePatterngithub.com/google/*StringRequired
A glob pattern to match Go module paths. Use * as a wildcard.
onlyDirecttrueBooleanOptional
If enabled, transitive dependencies will not be considered. All dependencies are searched by default.
version1.xStringOptional
Match only dependencies with the specified version. An exact version or a version range (see the [version selector syntax](https://docs.openrewrite.org/reference/dependency-version-selectors)) may be used. All versions are searched by default.

Usage

Run this recipe

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

shell
mod run . --recipe DependencyInsight --recipe-option "modulePattern=github.com/google/*" --recipe-option "version=1.x" --recipe-option "onlyDirect=true"

If the recipe is not available locally, then you can install it using:

RELEASE resolves to the newest release and LATEST to the newest build of any kind, including snapshots. Either one lets mod config recipes upgrade pull in later versions without editing this command; a pinned version stays where you put it.

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

Data tables

Go dependencies in use
org.openrewrite.golang.table.GoDependenciesInUse

Direct and transitive dependencies in use in Go modules.

ColumnDescription
Module pathThe module path of the project that contains the dependency (from the module directive in go.mod).
Project pathThe path to the go.mod file.
Dependency moduleThe module path of the Go dependency.
VersionThe resolved version of the dependency.
Version constraintThe version as declared in the require directive in go.mod.
DirectWhether this is a direct dependency (true) or a transitive dependency (false).
CountHow many times this dependency appears in the dependency graph.
Source files that had results
org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

ColumnDescription
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.
Source files that had search results
org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

ColumnDescription
Source path of search result before the runThe source path of the file with the search result markers present.
Source path of search result after run 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.
ResultThe trimmed printed tree of the LST element that the marker is attached to.
DescriptionThe content of the description of the marker.
Recipe that added the search markerThe specific recipe that added the Search marker.
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

ColumnDescription
Source pathThe file that failed to parse.
Recipe that made changesThe specific recipe that made a change.
Stack traceThe stack trace of the failure.
Recipe performance
org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

ColumnDescription
The recipeThe recipe whose stats are being measured both individually and cumulatively.
Source file countThe number of source files the recipe ran over.
Source file changed countThe number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)The total time spent across the scanning phase of this recipe.
Max scanning time (ns)The max time scanning any one source file.
Cumulative edit time (ns)The total time spent across the editing phase of this recipe.
Max edit time (ns)The max time editing any one source file.