Full name:
org.kuali.maven.plugins:graph-maven-plugin:1.0.2:flat
Description:
This mojo lays out the dependency graph in the same order they are defined in the pom's.
This style can make it easier to comprehend the dependency tree but the graph will have more nodes on it.
Attributes:
| 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/flat.png. |
| 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. |
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.
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.
Set this to false to skip executing the "dot" binary that produces dependency graphs
file:
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.
Set this to true to prevent the overall Maven build from failing if the "dot" binary returns a non-zero exit value.
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.
Set to true to retain the .dot text file Graphviz uses to draw the graph
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.
If false, artifact group id's are not displayed.
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.
Set this to false to render the graph without a title.
skip:
If true, mojo execution is skipped.
The title for the graph
Set to false to show only the dependencies for the current project
Set this to true to enable verbose mode.
