graph:dependencies

Full name:

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

Description:

(no description)

Attributes:

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

Optional Parameters

Name Type Since Description
depth int - Restricts the depth of the dependency tree. To show only the dependencies of your project, set this to 1. To show the dependencies of your project and their direct dependencies, set this to 2.
Default value is: -1.
direction Direction - The direction for the graph layout. Top to bottom, left to right, bottom to top, and right to left.
Default value is: TB.
excludes String -

Comma delimited list of artifact patterns to exclude. Excludes overrides includes and works "top down". If a dependency matches the excludes criteria, it, and all dependencies below it, are removed from the display. If not provided, no artifacts are excluded.

The pattern syntax has the form: 
[groupId]:[artifactId]:[type]:[classifier]:[version]

Each pattern segment is optional and supports * wildcards. An empty pattern segment is treated as a wildcard.
file File - The file the graph will be written to
Default value is: ${project.build.directory}/graph/dependencies.png.
hide String -

Comma delimited list of dependency qualifiers used for "hiding" artifacts. Hide overrides show and works "top down". If a dependency matches the hide criteria, it, and dependencies below it, are removed from the display. If not provided, no dependencies are hidden.

The pattern syntax has the form: 
[scope]:[optional|required]:[state]
Scopes: compile,provided,runtime,test,system,import
States: normal,conflict,cyclic,duplicate

Each pattern segment is optional and supports * wildcards. An empty pattern segment is treated as a wildcard.
includes String -

Comma delimited list of artifact patterns to include. Includes works "bottom up" and can be overridden by excludes. If an artifact matches the includes criteria, it, and all of the dependencies in the direct path from it back to the root of the dependency tree are displayed.

The pattern syntax has the form: 
[groupId]:[artifactId]:[type]:[classifier]:[version]

Each pattern segment is optional and supports * wildcards. An empty pattern segment is treated as a wildcard.
keepDotFile boolean - Set to true to retain the .dot file used to draw the graph
Default value is: false.
show String -

Comma delimited list of dependency qualifiers used for "showing" artifacts. Show works "bottom up" and can be overridden by hide. If a dependency matches the show criteria, it, and all of the dependencies in the direct path from it back to the root of the dependency tree are displayed.

The pattern syntax has the form: 
[scope]:[optional|required]:[state]
Scopes: compile,provided,runtime,test,system,import
States: normal,conflict,cyclic,duplicate

Each pattern segment is optional and supports * wildcards. An empty pattern segment is treated as a wildcard.
title String - The title for the graph
Default value is: Dependency Graph for ${project.name}.
transitive boolean - Set to false to show only the dependencies for the current project
Default value is: true.

Parameter Details

depth:

Restricts the depth of the dependency tree. To show only the dependencies of your project, set this to 1. To show the dependencies of your 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. Top to bottom, left to right, bottom to top, and right to left.
  • Type: org.kuali.maven.plugins.graph.pojo.Direction
  • Required: No
  • Expression: ${graph.direction}
  • Default: TB

excludes:

Comma delimited list of artifact patterns to exclude. Excludes overrides includes and works "top down". If a dependency matches the excludes criteria, it, and all dependencies below it, are removed from the display. If not provided, no artifacts are excluded.

The pattern syntax has the form: 
[groupId]:[artifactId]:[type]:[classifier]:[version]

Each pattern segment is optional and supports * wildcards. An empty pattern segment is treated as a wildcard.

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

file:

The file the graph will be written to
  • Type: java.io.File
  • Required: No
  • Expression: ${graph.file}
  • Default: ${project.build.directory}/graph/dependencies.png

hide:

Comma delimited list of dependency qualifiers used for "hiding" artifacts. Hide overrides show and works "top down". If a dependency matches the hide criteria, it, and dependencies below it, are removed from the display. If not provided, no dependencies are hidden.

The pattern syntax has the form: 
[scope]:[optional|required]:[state]
Scopes: compile,provided,runtime,test,system,import
States: normal,conflict,cyclic,duplicate

Each pattern segment is optional and supports * wildcards. An empty pattern segment is treated as a wildcard.

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

includes:

Comma delimited list of artifact patterns to include. Includes works "bottom up" and can be overridden by excludes. If an artifact matches the includes criteria, it, and all of the dependencies in the direct path from it back to the root of the dependency tree are displayed.

The pattern syntax has the form: 
[groupId]:[artifactId]:[type]:[classifier]:[version]

Each pattern segment is optional and supports * wildcards. An empty pattern segment is treated as a wildcard.

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

keepDotFile:

Set to true to retain the .dot file used to draw the graph
  • Type: boolean
  • Required: No
  • Expression: ${graph.keepDotFile}
  • Default: false

show:

Comma delimited list of dependency qualifiers used for "showing" artifacts. Show works "bottom up" and can be overridden by hide. If a dependency matches the show criteria, it, and all of the dependencies in the direct path from it back to the root of the dependency tree are displayed.

The pattern syntax has the form: 
[scope]:[optional|required]:[state]
Scopes: compile,provided,runtime,test,system,import
States: normal,conflict,cyclic,duplicate

Each pattern segment is optional and supports * wildcards. An empty pattern segment is treated as a wildcard.

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

title:

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

transitive:

Set to false to show only the dependencies for the current project
  • Type: boolean
  • Required: No
  • Expression: ${graph.transitive}
  • Default: true