graph:reactor

Full name:

org.fusesource.mvnplugins:maven-graph-plugin:1.4:reactor

Description:

Generates a graph image of the aggregate dependencies all the projects in current reactor (aka multi project) build using the graphviz tool 'dot'. You must have the 'dot' executable installed and in your path before using this goal.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Executes as an aggregator plugin.
  • Requires dependency resolution of artifacts in scope: compile|test|runtime.

Optional Parameters

Name Type Since Description
cascade boolean - If true then the 'test scope' and 'optional' attributes are cascaded down to the dependencies of the original node.

Default value is: true.
direction String - The direction that the graph will be laid out in. it can be one of the following values:
TB LR BT RL
top to bottom, from left to right, from bottom to top, and from right to left, respectively

Default value is: TB.
hideOmitted boolean - If set to true, ommitted dependencies will not be drawn. Dependencies are marked as ommitted if it would result in a resolution conflict.

Default value is: true.
hideOptional boolean - If set to true optional dependencies are not drawn.

Default value is: false.
hidePoms boolean - If set to true pom dependencies are not drawn.

Default value is: true.
hideScopes String - A comma seperated list of scopes. Dependencies which mach the specified scopes will not be drawn.
For example: runtime,test

hideTransitive boolean - If set to true then depdencies not explicitly defined in the projects pom will not be drawn.

Default value is: false.
label String - The label for the graph.

Default value is: Depedency Graph for ${project.name}.
target File - The file the diagram will be written to. Must use a file extension that the dot command supports or just the '.dot' extension.

Default value is: ${project.build.directory}/reactor-graph.png.

Parameter Details

cascade:

If true then the 'test scope' and 'optional' attributes are cascaded down to the dependencies of the original node.
  • Type: boolean
  • Required: No
  • Expression: ${graph.cascade}
  • Default: true

direction:

The direction that the graph will be laid out in. it can be one of the following values:
TB LR BT RL
top to bottom, from left to right, from bottom to top, and from right to left, respectively
  • Type: java.lang.String
  • Required: No
  • Expression: ${graph.direction}
  • Default: TB

hideOmitted:

If set to true, ommitted dependencies will not be drawn. Dependencies are marked as ommitted if it would result in a resolution conflict.
  • Type: boolean
  • Required: No
  • Expression: ${hide-omitted}
  • Default: true

hideOptional:

If set to true optional dependencies are not drawn.
  • Type: boolean
  • Required: No
  • Expression: ${hide-optional}
  • Default: false

hidePoms:

If set to true pom dependencies are not drawn.
  • Type: boolean
  • Required: No
  • Expression: ${hide-poms}
  • Default: true

hideScopes:

A comma seperated list of scopes. Dependencies which mach the specified scopes will not be drawn.
For example: runtime,test
  • Type: java.lang.String
  • Required: No
  • Expression: ${hide-scope}

hideTransitive:

If set to true then depdencies not explicitly defined in the projects pom will not be drawn.
  • Type: boolean
  • Required: No
  • Expression: ${hide-transitive}
  • Default: false

label:

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

target:

The file the diagram will be written to. Must use a file extension that the dot command supports or just the '.dot' extension.
  • Type: java.io.File
  • Required: No
  • Expression: ${graph.target}
  • Default: ${project.build.directory}/reactor-graph.png