graph:dependencies

Full name:

org.kuali.maven.plugins:graph-maven-plugin:1.0.5-SNAPSHOT:dependencies

Description:

This mojo produces customizable graphs of Maven dependency trees.

By default, the complete dependency tree (including transitive dependencies) is graphed. Graphs can be filtered with include/exclude criteria for artifacts (eg -Dgraph.includes=org.apache.*) and with show/hide criteria for Maven scope and optional settings (eg -Dgraph.show=compile,runtime)

Two layout styles are supported. In LINKED mode, relationships between shared dependencies are included in the graph. In FLAT mode, dependencies are displayed how they are defined in pom's.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile|test|runtime.

Required Parameters

Name Type Since Description
direction Direction -

The direction for the graph layout. Valid values are TB, LR, BT, RL. Top to bottom, left to right, bottom to top, and right to left, respectively.


Default value is: TB.
file File -

The file the graph will be written to


Default value is: ${project.build.directory}/graph/dependencies.png.
layout LayoutStyle -

The style for the graph layout. Valid options are LINKED and FLAT

In LINKED mode, each dependency appears on the graph only once. The relationships for shared dependencies are presented by Graphviz algorithms as a directed hierarchical graph.

For a transitive dependency, LINKED mode graphs illustrate why Maven includes it in the build.

For shared dependencies (eg commons-logging), LINKED mode graphs also illuminate the decision making Maven makes when resolving conflicts over differing versions of the same artifact.

In FLAT mode, dependencies are displayed exactly how they are defined in the pom's. This style can make it easier to comprehend the dependency tree but relationships between shared dependencies are not drawn.


Default value is: LINKED.

Optional Parameters

Name Type Since Description
cascadeOptional boolean -

If true, any dependency marked as optional will have all of its transitive dependencies displayed as optional also.


Default value is: true.
depth int -

Restricts the depth of the dependency tree.

To show only the dependencies of the current project, set this to 1. To show the dependencies of the current project and their direct dependencies, set this to 2.


Default value is: -1.
excludes String -

Comma delimited list of artifact patterns to exclude. The pattern syntax has the form - [groupId]:[artifactId]:[type]:[classifier]:[version]

Each pattern segment is optional and supports the use of the asterisk "*" as a wildcard. An empty pattern segment is treated as a wildcard.

For example:

Exclude commons-logging     -Dgraph.excludes=commons-logging
Exclude logging in general  -Dgraph.excludes=commons-logging,org.slf4j,log4j
Exclude war files           -Dgraph.excludes=*:*:war
Exclude source              -Dgraph.excludes=:::sources

If exclude patterns are provided, a match with any exclude pattern will prevent a dependency (and the dependency tree beneath it) from being displayed.

Exclude patterns override include patterns.

If not provided, no artifacts are excluded.
executeDot boolean -

Set this to false to skip executing the "dot" binary that produces an image from the .dot text file


Default value is: true.
hide String -

Comma delimited list of patterns for hiding artifacts. The pattern syntax has the form - [scope]:[optional|required]

Scopes: compile,provided,runtime,test,system,import

Each pattern segment is optional and supports the use of the asterisk "*" as a wildcard. An empty pattern segment is treated as a wildcard.

For example:

Hide test dependencies             -Dgraph.hide=test
Hide test & provided dependencies  -Dgraph.hide=test,provided
Hide optional dependencies         -Dgraph.hide=*:optional
Hide required dependencies         -Dgraph.hide=*:required

If hide patterns are provided, a match with any hide pattern will prevent a dependency (and the dependency tree beneath it) from being displayed.

Hide patterns override show patterns.

If not provided, no dependencies are hidden.
ignoreDotFailure boolean -

Set this to true to prevent the overall Maven build from failing if the "dot" binary returns a non-zero exit value.


Default value is: false.
includes String -

Comma delimited list of patterns for including artifacts. The pattern syntax has the form - [groupId]:[artifactId]:[type]:[classifier]:[version]

Each pattern segment is optional and supports the use of the asterisk "*" as a wildcard. An empty pattern segment is treated as a wildcard.

If include patterns are provided, a dependency must match one of the include patterns or it (along with the dependency tree beneath it) will be hidden.

If not provided all dependencies are included.

Include patterns are overridden by exclude patterns.
keepDotFile boolean -

Set to true to retain the .dot text file Graphviz uses to draw the graph


Default value is: false.
show String -

Comma delimited list of patterns for showing artifacts. The pattern syntax has the form - [scope]:[optional|required]

Scopes: compile,provided,runtime,test,system,import

Each pattern segment is optional and supports the use of the asterisk "*" as a wildcard. An empty pattern segment is treated as a wildcard.

If show patterns are provided a dependency must match one of the show patterns or it (along with the dependency tree beneath it) will be hidden.

Show patterns are overridden by hide patterns.

If not provided, all artifacts are shown.
showConflicts boolean -

If true, dependency conflicts are displayed on the graph


Default value is: true.
showDuplicates boolean -

If true, duplicate dependencies are displayed on the graph.


Default value is: false.
showGroupIds boolean -

If true, artifact group id's are displayed on the graph.


Default value is: true.
showLegend boolean -

If true, any criteria used to filter the dependency tree are shown as a legend.


Default value is: true.
showTitle boolean -

If true, the title for the graph will be displayed.


Default value is: true.
skip boolean -

If true, mojo execution is skipped.


Default value is: false.
title String -

The title for the graph


Default value is: Dependency Graph for ${project.name}.
transitive boolean -

If true, transitive dependencies are graphed.


Default value is: true.
verbose boolean -

If true, metadata about the dependency tree is displayed.


Default value is: false.

Parameter Details

cascadeOptional:

If true, any dependency marked as optional will have all of its transitive dependencies displayed as optional also.

  • Type: boolean
  • Required: No
  • Expression: ${graph.cascadeOptional}
  • Default: true

depth:

Restricts the depth of the dependency tree.

To show only the dependencies of the current project, set this to 1. To show the dependencies of the current project and their direct dependencies, set this to 2.

  • Type: int
  • Required: No
  • Expression: ${graph.depth}
  • Default: -1

direction:

The direction for the graph layout. Valid values are TB, LR, BT, RL. Top to bottom, left to right, bottom to top, and right to left, respectively.

  • Type: org.kuali.maven.plugins.graph.pojo.Direction
  • Required: Yes
  • Expression: ${graph.direction}
  • Default: TB

excludes:

Comma delimited list of artifact patterns to exclude. The pattern syntax has the form - [groupId]:[artifactId]:[type]:[classifier]:[version]

Each pattern segment is optional and supports the use of the asterisk "*" as a wildcard. An empty pattern segment is treated as a wildcard.

For example:

Exclude commons-logging     -Dgraph.excludes=commons-logging
Exclude logging in general  -Dgraph.excludes=commons-logging,org.slf4j,log4j
Exclude war files           -Dgraph.excludes=*:*:war
Exclude source              -Dgraph.excludes=:::sources

If exclude patterns are provided, a match with any exclude pattern will prevent a dependency (and the dependency tree beneath it) from being displayed.

Exclude patterns override include patterns.

If not provided, no artifacts are excluded.

  • Type: java.lang.String
  • Required: No
  • Expression: ${graph.excludes}

executeDot:

Set this to false to skip executing the "dot" binary that produces an image from the .dot text file

  • Type: boolean
  • Required: No
  • Expression: ${graph.executeDot}
  • Default: true

file:

The file the graph will be written to

  • Type: java.io.File
  • Required: Yes
  • Expression: ${graph.file}
  • Default: ${project.build.directory}/graph/dependencies.png

hide:

Comma delimited list of patterns for hiding artifacts. The pattern syntax has the form - [scope]:[optional|required]

Scopes: compile,provided,runtime,test,system,import

Each pattern segment is optional and supports the use of the asterisk "*" as a wildcard. An empty pattern segment is treated as a wildcard.

For example:

Hide test dependencies             -Dgraph.hide=test
Hide test & provided dependencies  -Dgraph.hide=test,provided
Hide optional dependencies         -Dgraph.hide=*:optional
Hide required dependencies         -Dgraph.hide=*:required

If hide patterns are provided, a match with any hide pattern will prevent a dependency (and the dependency tree beneath it) from being displayed.

Hide patterns override show patterns.

If not provided, no dependencies are hidden.

  • Type: java.lang.String
  • Required: No
  • Expression: ${graph.hide}

ignoreDotFailure:

Set this to true to prevent the overall Maven build from failing if the "dot" binary returns a non-zero exit value.

  • Type: boolean
  • Required: No
  • Expression: ${graph.ignoreDotFailure}
  • Default: false

includes:

Comma delimited list of patterns for including artifacts. The pattern syntax has the form - [groupId]:[artifactId]:[type]:[classifier]:[version]

Each pattern segment is optional and supports the use of the asterisk "*" as a wildcard. An empty pattern segment is treated as a wildcard.

If include patterns are provided, a dependency must match one of the include patterns or it (along with the dependency tree beneath it) will be hidden.

If not provided all dependencies are included.

Include patterns are overridden by exclude patterns.

  • Type: java.lang.String
  • Required: No
  • Expression: ${graph.includes}

keepDotFile:

Set to true to retain the .dot text file Graphviz uses to draw the graph

  • Type: boolean
  • Required: No
  • Expression: ${graph.keepDotFile}
  • Default: false

layout:

The style for the graph layout. Valid options are LINKED and FLAT

In LINKED mode, each dependency appears on the graph only once. The relationships for shared dependencies are presented by Graphviz algorithms as a directed hierarchical graph.

For a transitive dependency, LINKED mode graphs illustrate why Maven includes it in the build.

For shared dependencies (eg commons-logging), LINKED mode graphs also illuminate the decision making Maven makes when resolving conflicts over differing versions of the same artifact.

In FLAT mode, dependencies are displayed exactly how they are defined in the pom's. This style can make it easier to comprehend the dependency tree but relationships between shared dependencies are not drawn.

  • Type: org.kuali.maven.plugins.graph.pojo.LayoutStyle
  • Required: Yes
  • Expression: ${graph.layout}
  • Default: LINKED

show:

Comma delimited list of patterns for showing artifacts. The pattern syntax has the form - [scope]:[optional|required]

Scopes: compile,provided,runtime,test,system,import

Each pattern segment is optional and supports the use of the asterisk "*" as a wildcard. An empty pattern segment is treated as a wildcard.

If show patterns are provided a dependency must match one of the show patterns or it (along with the dependency tree beneath it) will be hidden.

Show patterns are overridden by hide patterns.

If not provided, all artifacts are shown.

  • Type: java.lang.String
  • Required: No
  • Expression: ${graph.show}

showConflicts:

If true, dependency conflicts are displayed on the graph

  • Type: boolean
  • Required: No
  • Expression: ${graph.showConflicts}
  • Default: true

showDuplicates:

If true, duplicate dependencies are displayed on the graph.

  • Type: boolean
  • Required: No
  • Expression: ${graph.showDuplicates}
  • Default: false

showGroupIds:

If true, artifact group id's are displayed on the graph.

  • Type: boolean
  • Required: No
  • Expression: ${graph.showGroupIds}
  • Default: true

showLegend:

If true, any criteria used to filter the dependency tree are shown as a legend.

  • Type: boolean
  • Required: No
  • Expression: ${graph.showLegend}
  • Default: true

showTitle:

If true, the title for the graph will be displayed.

  • Type: boolean
  • Required: No
  • Expression: ${graph.showTitle}
  • Default: true

skip:

If true, mojo execution is skipped.

  • Type: boolean
  • Required: No
  • Expression: ${graph.skip}
  • Default: false

title:

The title for the graph

  • Type: java.lang.String
  • Required: No
  • Expression: ${graph.title}
  • Default: Dependency Graph for ${project.name}

transitive:

If true, transitive dependencies are graphed.

  • Type: boolean
  • Required: No
  • Expression: ${graph.transitive}
  • Default: true

verbose:

If true, metadata about the dependency tree is displayed.

  • Type: boolean
  • Required: No
  • Expression: ${graph.verbose}
  • Default: false