Built by Maven

toolbox:project-dependency-graph

Full name:

eu.maveniverse.maven.plugins:toolbox:0.13.4:project-dependency-graph

Description:

Renders project interdependencies of Maven Projects as image.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator goal.
  • The goal is thread-safe and supports parallel builds.

Required Parameters

Name Type Since Description
<excludeDependencyMatcherSpec> String - The exclusion dependency matcher (inverted!) to apply to graph. Default is none().
Default: none()
User Property: excludeDependencyMatcherSpec
<excludeSubprojectsMatcherSpec> String - The exclusion artifact matcher (inverted!) to apply to reactor modules. Default is none().
Default: none()
User Property: excludeSubprojectsMatcherSpec
<output> File - The location to write resulting image to.
Default: ${project.build.directory}/project-dependency-graph.svg
User Property: output
<showExternal> boolean - Set it true to include external direct dependencies as well.
Default: false
User Property: showExternal

Optional Parameters

Name Type Since Description
<dryRun> boolean - Option to run potentially destructive commands without performing any IO.
Default: false
User Property: dryRun
<extraRepositories> String - Appends extra repositories to context.
User Property: extraRepositories
<failOnLogicalFailure> boolean - Makes command fail on "logical" failure.
Default: true
User Property: failOnLogicalFailure
<forceStdout> boolean - No description.
User Property: forceStdout
<repositoryVendor> String - The repository vendor to use for Search RR backend ("central", "nx2" or any other extractor). If empty, heuristics will be applied to figure out.
User Property: toolbox.search.backend.type
<selector> String - Set the project selector, like -rf Maven command uses it, can be :A or G:A. If the selector is set, it must match exactly one project within reactor, otherwise it will fail. By default, selector is null, and no selected project will be set.
User Property: selector
<verbosity> Output$Verbosity - No description.
Default: NORMAL
User Property: verbosity

Parameter Details

<dryRun>

Option to run potentially destructive commands without performing any IO.
  • Type: boolean
  • Required: No
  • User Property: dryRun
  • Default: false

<excludeDependencyMatcherSpec>

The exclusion dependency matcher (inverted!) to apply to graph. Default is none().
  • Type: java.lang.String
  • Required: Yes
  • User Property: excludeDependencyMatcherSpec
  • Default: none()

<excludeSubprojectsMatcherSpec>

The exclusion artifact matcher (inverted!) to apply to reactor modules. Default is none().
  • Type: java.lang.String
  • Required: Yes
  • User Property: excludeSubprojectsMatcherSpec
  • Default: none()

<extraRepositories>

Appends extra repositories to context.
  • Type: java.lang.String
  • Required: No
  • User Property: extraRepositories

<failOnLogicalFailure>

Makes command fail on "logical" failure.
  • Type: boolean
  • Required: No
  • User Property: failOnLogicalFailure
  • Default: true

<forceStdout>

No description.
  • Type: boolean
  • Required: No
  • User Property: forceStdout

<output>

The location to write resulting image to.
  • Type: java.io.File
  • Required: Yes
  • User Property: output
  • Default: ${project.build.directory}/project-dependency-graph.svg

<repositoryVendor>

The repository vendor to use for Search RR backend ("central", "nx2" or any other extractor). If empty, heuristics will be applied to figure out.
  • Type: java.lang.String
  • Required: No
  • User Property: toolbox.search.backend.type

<selector>

Set the project selector, like -rf Maven command uses it, can be :A or G:A. If the selector is set, it must match exactly one project within reactor, otherwise it will fail. By default, selector is null, and no selected project will be set.
  • Type: java.lang.String
  • Required: No
  • User Property: selector

<showExternal>

Set it true to include external direct dependencies as well.
  • Type: boolean
  • Required: Yes
  • User Property: showExternal
  • Default: false

<verbosity>

No description.
  • Type: eu.maveniverse.maven.toolbox.shared.output.Output$Verbosity
  • Required: No
  • User Property: verbosity
  • Default: NORMAL