Full name:
com.github.ferstl:depgraph-maven-plugin:4.0.3:graph
Description:
Attributes:
Name | Type | Since | Description |
---|---|---|---|
<classpathScope> |
String |
4.0.0 |
The scope of the artifacts that should be included in the graph. An
empty string indicates all scopes (default). The scopes being
interpreted are the scopes as Maven sees them, not as specified in
the pom. In summary:
scope parameter
which was introduced in version 1.0.0.User property is: classpathScope . |
<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 . |
<excludeOptionalDependencies> |
boolean |
3.2.0 |
Indicates whether optional dependencies should be excluded from the
graph. Default value is: false .User property is: excludeOptionalDependencies . |
<excludes> |
List |
1.0.0 |
List of artifacts to be excluded in the form of
groupId:artifactId:type:classifier .User property is: excludes . |
<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 . |
<includes> |
List |
1.0.0 |
List of artifacts to be included in the form of
groupId:artifactId:type:classifier .User property is: includes . |
<mergeClassifiers> |
boolean |
3.0.0 |
Merge dependencies with multiple classifiers into one graph node
instead of having a node per classifier. Default value is: false .User property is: mergeClassifiers . |
<mergeTypes> |
boolean |
3.0.0 |
Merge dependencies with multiple types into one graph node instead
of having a node per type. Default value is: false .User property is: mergeTypes . |
<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 . |
<scope> |
String |
1.0.0 |
Deprecated. Use classpathScope instead.User property is: scope . |
<scopes> |
List |
4.0.0 |
List of dependency scopes to be included in the graph. If empty,
all scopes are included. User property is: scopes . |
<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 . |
<showClassifiers> |
boolean |
3.0.0 |
If set to true , the created graph will show classifier
information an all artifacts.Default value is: false .User property is: showClassifiers . |
<showConflicts> |
boolean |
1.0.0 |
If set to true , the graph will additionally contain
conflicting dependencies.The option showAllAttributesForJson does not enable
this flag.Default value is: false .User property is: showConflicts . |
<showDuplicates> |
boolean |
1.0.0 |
If set to true , the graph will additionally contain
duplicate dependencies.The option showAllAttributesForJson does not enable
this flag.Default value is: false .User property is: showDuplicates . |
<showGroupIds> |
boolean |
1.0.3 |
If set to true , the created graph will show the
groupId on all artifacts.Default value is: false .User property is: showGroupIds . |
<showOptional> |
boolean |
3.2.0 |
If set to true , the created graph will mark optional
dependencies.Default value is: true .User property is: showOptional . |
<showTypes> |
boolean |
3.0.0 |
If set to true , the created graph will show type
information an all artifacts.Default value is: false .User property is: showTypes . |
<showVersions> |
boolean |
1.0.0 |
If set to true , the created graph will show version
information an all artifacts. Depending on the flags
showDuplicates and showConflicts , the
version will either be shown directly in the artifact nodes or on
the dependency edges.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 . |
<targetIncludes> |
List |
1.0.4 |
List of artifacts, in the form of
groupId:artifactId:type:classifier , to restrict the
dependency graph only to artifacts that depend on them.User property is: targetIncludes . |
<transitiveExcludes> |
List |
3.0.0 |
List of artifacts in the form of
groupId:artifactId:type:classifier to be excluded if
they are transitive.User property is: transitiveExcludes . |
<transitiveIncludes> |
List |
3.0.0 |
List of artifacts in the form of
groupId:artifactId:type:classifier to be included if
they are transitive.User property is: transitiveIncludes . |
<useArtifactIdInFileName> |
boolean |
2.2.0 |
Indicates whether the project's artifact ID should be used as file
name for the generated graph files.
Default value is: false .User property is: useArtifactIdInFileName . |
compile
: Equivalent to
`-Dscopes=compile,provided,system`provided
: Equivalent to `-Dscopes=provided`runtime
: Equivalent to
`-Dscopes=compile,runtime`system
: Equivalent to `-Dscopes=system`test
(default): Shows all dependenciesscope
parameter
which was introduced in version 1.0.0.java.lang.String
4.0.0
No
classpathScope
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.boolean
1.0.0
No
createImage
false
graphFormat=dot
: Path to a custom
style configuration in JSON format.java.lang.String
2.0.0
No
customStyleConfiguration
graphFormat=dot
and
createImage=true
: Additional arguments for the
dot
executable (besides -T
and
-o
).java.lang.String
4.0.0
No
dotArguments
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
.java.io.File
1.0.0
No
dotExecutable
boolean
3.2.0
No
excludeOptionalDependencies
false
groupId:artifactId:type:classifier
.java.util.List
1.0.0
No
excludes
java.lang.String
2.1.0
No
graphFormat
dot
graphFormat=dot
: The format for the
graph image when createImage
is set to
true
.java.lang.String
1.0.0
No
imageFormat
png
groupId:artifactId:type:classifier
.java.util.List
1.0.0
No
includes
boolean
3.0.0
No
mergeClassifiers
false
boolean
3.0.0
No
mergeTypes
false
java.io.File
2.2.0
No
outputDirectory
${project.build.directory}
graphFormat
will be added if not
specified.java.lang.String
2.2.0
No
outputFileName
dependency-graph
graphFormat=dot
: If set to
true
the effective style configuration used to create
this graph will be printed on the console.boolean
2.0.0
No
printStyleConfiguration
false
classpathScope
instead.compile
: Shows compile, provided and system
dependenciesprovided
: Shows provided dependenciesruntime
: Shows compile and runtime
dependenciessystem
: Shows system dependenciestest
(default): Shows all dependenciesjava.lang.String
1.0.0
No
scope
java.util.List
4.0.0
No
scopes
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.boolean
3.0.0
No
showAllAttributesForJson
true
true
, the created graph will show classifier
information an all artifacts.boolean
3.0.0
No
showClassifiers
false
true
, the graph will additionally contain
conflicting dependencies.showAllAttributesForJson
does not enable
this flag.boolean
1.0.0
No
showConflicts
false
true
, the graph will additionally contain
duplicate dependencies.showAllAttributesForJson
does not enable
this flag.boolean
1.0.0
No
showDuplicates
false
true
, the created graph will show the
groupId
on all artifacts.boolean
1.0.3
No
showGroupIds
false
true
, the created graph will mark optional
dependencies.boolean
3.2.0
No
showOptional
true
true
, the created graph will show type
information an all artifacts.boolean
3.0.0
No
showTypes
false
true
, the created graph will show version
information an all artifacts. Depending on the flags
showDuplicates
and showConflicts
, the
version will either be shown directly in the artifact nodes or on
the dependency edges.boolean
1.0.0
No
showVersions
false
true
.boolean
3.3.0
No
depgraph.skip
false
groupId:artifactId:type:classifier
, to restrict the
dependency graph only to artifacts that depend on them.java.util.List
1.0.4
No
targetIncludes
groupId:artifactId:type:classifier
to be excluded if
they are transitive.java.util.List
3.0.0
No
transitiveExcludes
groupId:artifactId:type:classifier
to be included if
they are transitive.java.util.List
3.0.0
No
transitiveIncludes
outputFile
parameter is used.true
, the content of the
outputFileName
parameter is ignored.boolean
2.2.0
No
useArtifactIdInFileName
false