Apache Maven Dependency Plugin – dependency:analyze

dependency:analyze

Full name:

org.apache.maven.plugins:maven-dependency-plugin:3.8.0:analyze

Description:

Analyzes the dependencies of this project and determines which are: used and declared; used and undeclared; unused and declared. This goal is intended to be used standalone, thus it always executes the test-compile phase - use the dependency:analyze-only goal instead when participating in the build lifecycle.

By default, maven-dependency-analyzer is used to perform the analysis, with limitations due to the fact that it works at bytecode level, but any analyzer can be plugged in through analyzer parameter.

See also: AnalyzeOnlyMojo

Attributes:

Requires a Maven project to be executed.Requires dependency resolution of artifacts in scope: test.The goal is thread-safe and supports parallel builds.Since version: 2.0-alpha-3.Invokes the execution of the following lifecycle phase prior to executing itself: test-compile.Optional ParametersNameTypeSinceDescriptionString2.2Specify the project dependency analyzer to use (plexus component role-hint). By default, maven-dependency-analyzer is used. To use this, you must declare a dependency for this plugin that contains the code for the analyzer. The analyzer must have a declared Plexus role name, and you specify the role name here.Default: defaultUser Property: analyzerSet3.7.0List Excluded classes patterns from analyze. Java regular expression pattern is applied to full class name.User Property: mdep.analyze.excludedClassesboolean-Whether to fail the build if a dependency warning is found.Default: falseUser Property: failOnWarningboolean3.3.1-SNAPSHOTIgnore all dependencies that are used only in test but not test-scoped. Setting this flag has the same effect as adding all dependencies that have been flagged with the Non-test scoped test only dependencies found warning to the configuration.Default: falseUser Property: ignoreAllNonTestScopedboolean-Ignore Runtime/Provided/Test/System scopes for unused dependency analysis.

Non-test scoped list will be not affected.

Default: falseUser Property: ignoreNonCompileboolean3.2.0Ignore Runtime scope for unused dependency analysis.Default: falseUser Property: ignoreUnusedRuntimeString[]2.10List of dependencies that will be ignored. Any dependency on this list will be excluded from the "declared but unused", the "used but undeclared", and the "non-test scoped" list. The filter syntax is: [groupId]:[artifactId]:[type]:[version] where each pattern segment is optional and supports full and partial * wildcards. An empty pattern segment is treated as an implicit wildcard. *

For example, org.apache.* will match all artifacts whose group id starts with org.apache., and :::*-SNAPSHOT will match all snapshot artifacts.

String[]3.3.0List of dependencies that will be ignored if they are in not test scope but are only used in test classes. The filter syntax is: [groupId]:[artifactId]:[type]:[version] where each pattern segment is optional and supports full and partial * wildcards. An empty pattern segment is treated as an implicit wildcard. *

For example, org.apache.* will match all artifacts whose group id starts with org.apache., and :::*-SNAPSHOT will match all snapshot artifacts.

List3.2.1List of project packaging that will be ignored. Default value is: pom, earString[]2.10List of dependencies that will be ignored if they are declared but unused. The filter syntax is: [groupId]:[artifactId]:[type]:[version] where each pattern segment is optional and supports full and partial * wildcards. An empty pattern segment is treated as an implicit wildcard. *

For example, org.apache.* will match all artifacts whose group id starts with org.apache., and :::*-SNAPSHOT will match all snapshot artifacts.

String[]2.10List of dependencies that will be ignored if they are used but undeclared. The filter syntax is: [groupId]:[artifactId]:[type]:[version] where each pattern segment is optional and supports full and partial * wildcards. An empty pattern segment is treated as an implicit wildcard. *

For example, org.apache.* will match all artifacts whose group id starts with org.apache., and :::*-SNAPSHOT will match all snapshot artifacts.

boolean2.0-alpha-5Output the xml for the missing dependencies (used but not declared).Default: falseUser Property: outputXMLString2.0-alpha-5Flag to use for scriptable output.Default: $$$%%%User Property: scriptableFlagboolean2.0-alpha-5Output scriptable values for the missing dependencies (used but not declared).Default: falseUser Property: scriptableOutputboolean2.7Skip plugin execution completely.Default: falseUser Property: mdep.analyze.skipString[]2.6Force dependencies as used, to override incomplete result caused by bytecode-level analysis. Dependency format is groupId:artifactId.boolean-Output used dependencies.Default: falseUser Property: verboseParameter DetailsSpecify the project dependency analyzer to use (plexus component role-hint). By default, maven-dependency-analyzer is used. To use this, you must declare a dependency for this plugin that contains the code for the analyzer. The analyzer must have a declared Plexus role name, and you specify the role name here.Type: java.lang.StringSince: 2.2Required: NoUser Property: analyzerDefault: defaultList Excluded classes patterns from analyze. Java regular expression pattern is applied to full class name.Type: java.util.SetSince: 3.7.0Required: NoUser Property: mdep.analyze.excludedClassesWhether to fail the build if a dependency warning is found.Type: booleanRequired: NoUser Property: failOnWarningDefault: falseIgnore all dependencies that are used only in test but not test-scoped. Setting this flag has the same effect as adding all dependencies that have been flagged with the Non-test scoped test only dependencies found warning to the configuration.Type: booleanSince: 3.3.1-SNAPSHOTRequired: NoUser Property: ignoreAllNonTestScopedDefault: falseIgnore Runtime/Provided/Test/System scopes for unused dependency analysis.

Non-test scoped list will be not affected.

Type: booleanRequired: NoUser Property: ignoreNonCompileDefault: falseIgnore Runtime scope for unused dependency analysis.Type: booleanSince: 3.2.0Required: NoUser Property: ignoreUnusedRuntimeDefault: falseList of dependencies that will be ignored. Any dependency on this list will be excluded from the "declared but unused", the "used but undeclared", and the "non-test scoped" list. The filter syntax is: [groupId]:[artifactId]:[type]:[version] where each pattern segment is optional and supports full and partial * wildcards. An empty pattern segment is treated as an implicit wildcard. *

For example, org.apache.* will match all artifacts whose group id starts with org.apache., and :::*-SNAPSHOT will match all snapshot artifacts.

Type: java.lang.String[]Since: 2.10Required: NoList of dependencies that will be ignored if they are in not test scope but are only used in test classes. The filter syntax is: [groupId]:[artifactId]:[type]:[version] where each pattern segment is optional and supports full and partial * wildcards. An empty pattern segment is treated as an implicit wildcard. *

For example, org.apache.* will match all artifacts whose group id starts with org.apache., and :::*-SNAPSHOT will match all snapshot artifacts.

Type: java.lang.String[]Since: 3.3.0Required: NoList of project packaging that will be ignored. Default value is: pom, earType: java.util.ListSince: 3.2.1Required: NoList of dependencies that will be ignored if they are declared but unused. The filter syntax is: [groupId]:[artifactId]:[type]:[version] where each pattern segment is optional and supports full and partial * wildcards. An empty pattern segment is treated as an implicit wildcard. *

For example, org.apache.* will match all artifacts whose group id starts with org.apache., and :::*-SNAPSHOT will match all snapshot artifacts.

Type: java.lang.String[]Since: 2.10Required: NoList of dependencies that will be ignored if they are used but undeclared. The filter syntax is: [groupId]:[artifactId]:[type]:[version] where each pattern segment is optional and supports full and partial * wildcards. An empty pattern segment is treated as an implicit wildcard. *

For example, org.apache.* will match all artifacts whose group id starts with org.apache., and :::*-SNAPSHOT will match all snapshot artifacts.

Type: java.lang.String[]Since: 2.10Required: NoOutput the xml for the missing dependencies (used but not declared).Type: booleanSince: 2.0-alpha-5Required: NoUser Property: outputXMLDefault: falseFlag to use for scriptable output.Type: java.lang.StringSince: 2.0-alpha-5Required: NoUser Property: scriptableFlagDefault: $$$%%%Output scriptable values for the missing dependencies (used but not declared).Type: booleanSince: 2.0-alpha-5Required: NoUser Property: scriptableOutputDefault: falseSkip plugin execution completely.Type: booleanSince: 2.7Required: NoUser Property: mdep.analyze.skipDefault: falseForce dependencies as used, to override incomplete result caused by bytecode-level analysis. Dependency format is groupId:artifactId.Type: java.lang.String[]Since: 2.6Required: NoOutput used dependencies.Type: booleanRequired: NoUser Property: verboseDefault: false