graph:condensed

Full name:

org.kuali.maven.plugins:graph-maven-plugin:1.0.4:condensed

Description:

This mojo lays out the dependency graph in condensed mode.

Each dependency appears on the graph once. Graphviz algorithms present the connections between the dependencies as a directed hierarchical graph.

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/condensed.png.

Optional Parameters

Name Type Since Description
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]

Exclude patterns override include patterns and work "top down". If a dependency matches any exclude pattern, it, and all dependencies below it, are removed from the display.

If not provided, no artifacts are excluded.

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


executeDot boolean -

Set this to false to skip executing the "dot" binary that produces dependency graphs


Default value is: true.
hide String -

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

Hide patterns override show patterns and work "top down". If a dependency matches any hide pattern, it, and all dependencies below it, are removed from the display.

If not provided, no dependencies are hidden.

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.


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]

Include patterns work "bottom up" and are overridden by exclude patterns. If an artifact matches an include pattern, it, and all of the dependencies in the path from it back to the root of the dependency tree are displayed.

If not provided all dependencies are included.

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 text file Graphviz uses to draw the graph


Default value is: false.
show String -

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

Show patterns work "bottom up" and are overridden by hide patterns. If a dependency matches any show criteria, it, and all of the dependencies in the direct path from it back to the root of the dependency tree are displayed.

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.


showGroupIds boolean -

If false, artifact group id's are not displayed.


Default value is: true.
showLegend boolean -

By default, the criteria used to filter the dependency tree are shown as a legend. Set this to false to prevent filter criteria from being shown.


Default value is: true.
showTitle boolean -

Set this to false to render the graph without a title.


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 -

Set to false to show only the dependencies for the current project


Default value is: true.
verbose boolean -

Set this to true to enable verbose mode.


Default value is: false.

Parameter Details

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]

Exclude patterns override include patterns and work "top down". If a dependency matches any exclude pattern, it, and all dependencies below it, are removed from the display.

If not provided, no artifacts are excluded.

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}

executeDot:

Set this to false to skip executing the "dot" binary that produces dependency graphs

  • 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/condensed.png

hide:

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

Hide patterns override show patterns and work "top down". If a dependency matches any hide pattern, it, and all dependencies below it, are removed from the display.

If not provided, no dependencies are hidden.

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}

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]

Include patterns work "bottom up" and are overridden by exclude patterns. If an artifact matches an include pattern, it, and all of the dependencies in the path from it back to the root of the dependency tree are displayed.

If not provided all dependencies are included.

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 text file Graphviz uses to draw the graph

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

show:

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

Show patterns work "bottom up" and are overridden by hide patterns. If a dependency matches any show criteria, it, and all of the dependencies in the direct path from it back to the root of the dependency tree are displayed.

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}

showGroupIds:

If false, artifact group id's are not displayed.

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

showLegend:

By default, the criteria used to filter the dependency tree are shown as a legend. Set this to false to prevent filter criteria from being shown.

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

showTitle:

Set this to false to render the graph without a title.

  • 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:

Set to false to show only the dependencies for the current project

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

verbose:

Set this to true to enable verbose mode.

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