depgraph:reactor

Full name:

com.github.ferstl:depgraph-maven-plugin:4.0.3:reactor

Description:

Creates a dependency graph of the Maven rector in a multimodule project.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • Since version: 4.0.0.

Optional Parameters

Name Type Since Description
<createImage> boolean 1.0.0 Only relevant when graphFormat=dot: If set to true and Graphviz is installed on the system where this plugin is executed, the dot file will be converted to a graph image using Graphviz' dot executable.
Default value is: false.
User property is: createImage.
<customStyleConfiguration> String 2.0.0 Only relevant when graphFormat=dot: Path to a custom style configuration in JSON format.
User property is: customStyleConfiguration.
<dotArguments> String 4.0.0 Only relevant when graphFormat=dot and createImage=true: Additional arguments for the dot executable (besides -T and -o).
User property is: dotArguments.
<dotExecutable> File 1.0.0 Only relevant when graphFormat=dot and createImage=true: Path to the dot executable. Use this option in case createImage is set to true and the dot executable is not on the system PATH.
User property is: dotExecutable.
<graphFormat> String 2.1.0 Format of the graph, either "dot" (default), "gml", "puml", "json" or "text".
Default value is: dot.
User property is: graphFormat.
<imageFormat> String 1.0.0 Only relevant when graphFormat=dot: The format for the graph image when createImage is set to true.
Default value is: png.
User property is: imageFormat.
<outputDirectory> File 2.2.0 Output directory to write the dependency graph to. The default is the project's build directory. For goals that don't require a project the current directory will be used.
Default value is: ${project.build.directory}.
User property is: outputDirectory.
<outputFileName> String 2.2.0 The name of the dependency graph file. A file extension matching the configured graphFormat will be added if not specified.
Default value is: dependency-graph.
User property is: outputFileName.
<printStyleConfiguration> boolean 2.0.0 Only relevant when graphFormat=dot: If set to true the effective style configuration used to create this graph will be printed on the console.
Default value is: false.
User property is: printStyleConfiguration.
<showAllAttributesForJson> boolean 3.0.0 If set to true (which is the default) and the graph format is 'json', the graph will show any information that is possible. The idea behind this option is, that the consumer of the JSON data, for example a Javascript library, will do its own filtering of the data.
Default value is: true.
User property is: showAllAttributesForJson.
<showGroupIds> boolean 4.0.0 If set to true, the created graph will show the groupId on all artifacts.
Default value is: false.
User property is: showGroupIds.
<showVersions> boolean 4.0.0 If set to true, the created graph will show version information an all artifacts.
Default value is: false.
User property is: showVersions.
<skip> boolean 3.3.0 Skip execution when set to true.
Default value is: false.
User property is: depgraph.skip.
<useArtifactIdInFileName> boolean 2.2.0 Indicates whether the project's artifact ID should be used as file name for the generated graph files.
  • This flag does not have an effect when the (deprecated) outputFile parameter is used.
  • When set to true, the content of the outputFileName parameter is ignored.

Default value is: false.
User property is: useArtifactIdInFileName.

Parameter Details

<createImage>

Only relevant when graphFormat=dot: If set to true and Graphviz is installed on the system where this plugin is executed, the dot file will be converted to a graph image using Graphviz' dot executable.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: createImage
  • Default: false

<customStyleConfiguration>

Only relevant when graphFormat=dot: Path to a custom style configuration in JSON format.
  • Type: java.lang.String
  • Since: 2.0.0
  • Required: No
  • User Property: customStyleConfiguration

<dotArguments>

Only relevant when graphFormat=dot and createImage=true: Additional arguments for the dot executable (besides -T and -o).
  • Type: java.lang.String
  • Since: 4.0.0
  • Required: No
  • User Property: dotArguments

<dotExecutable>

Only relevant when graphFormat=dot and createImage=true: Path to the dot executable. Use this option in case createImage is set to true and the dot executable is not on the system PATH.
  • Type: java.io.File
  • Since: 1.0.0
  • Required: No
  • User Property: dotExecutable

<graphFormat>

Format of the graph, either "dot" (default), "gml", "puml", "json" or "text".
  • Type: java.lang.String
  • Since: 2.1.0
  • Required: No
  • User Property: graphFormat
  • Default: dot

<imageFormat>

Only relevant when graphFormat=dot: The format for the graph image when createImage is set to true.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: imageFormat
  • Default: png

<outputDirectory>

Output directory to write the dependency graph to. The default is the project's build directory. For goals that don't require a project the current directory will be used.
  • Type: java.io.File
  • Since: 2.2.0
  • Required: No
  • User Property: outputDirectory
  • Default: ${project.build.directory}

<outputFileName>

The name of the dependency graph file. A file extension matching the configured graphFormat will be added if not specified.
  • Type: java.lang.String
  • Since: 2.2.0
  • Required: No
  • User Property: outputFileName
  • Default: dependency-graph

<printStyleConfiguration>

Only relevant when graphFormat=dot: If set to true the effective style configuration used to create this graph will be printed on the console.
  • Type: boolean
  • Since: 2.0.0
  • Required: No
  • User Property: printStyleConfiguration
  • Default: false

<showAllAttributesForJson>

If set to true (which is the default) and the graph format is 'json', the graph will show any information that is possible. The idea behind this option is, that the consumer of the JSON data, for example a Javascript library, will do its own filtering of the data.
  • Type: boolean
  • Since: 3.0.0
  • Required: No
  • User Property: showAllAttributesForJson
  • Default: true

<showGroupIds>

If set to true, the created graph will show the groupId on all artifacts.
  • Type: boolean
  • Since: 4.0.0
  • Required: No
  • User Property: showGroupIds
  • Default: false

<showVersions>

If set to true, the created graph will show version information an all artifacts.
  • Type: boolean
  • Since: 4.0.0
  • Required: No
  • User Property: showVersions
  • Default: false

<skip>

Skip execution when set to true.
  • Type: boolean
  • Since: 3.3.0
  • Required: No
  • User Property: depgraph.skip
  • Default: false

<useArtifactIdInFileName>

Indicates whether the project's artifact ID should be used as file name for the generated graph files.
  • This flag does not have an effect when the (deprecated) outputFile parameter is used.
  • When set to true, the content of the outputFileName parameter is ignored.
  • Type: boolean
  • Since: 2.2.0
  • Required: No
  • User Property: useArtifactIdInFileName
  • Default: false