use-webjars:unpack

Full name:

guru.nidi.maven.plugins:use-webjars-maven-plugin:0.0.2-SNAPSHOT:unpack

Description:

Unpack all webjar dependencies and strip the version. All settings from maven-dependency-plugin:unpack-dependencies are supported. Additional parameters are:

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: generate-resources.

Optional Parameters

Name Type Since Description
classifier String - Specify classifier to look for. Example: sources
User property is: classifier.
encoding String - Encoding of artifacts.
User property is: mdep.unpack.encoding.
excludeArtifactIds String - Comma separated list of Artifact names to exclude.
User property is: excludeArtifactIds.
excludeClassifiers String - Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
User property is: excludeClassifiers.
excludeGroupIds String - Comma separated list of GroupId Names to exclude.
User property is: excludeGroupIds.
excludeScope String - Scope to exclude. An Empty string indicates no scopes (default).
User property is: excludeScope.
excludeTransitive boolean - If we should exclude transitive dependencies
Default value is: false.
User property is: excludeTransitive.
excludeTypes String - Comma Separated list of Types to exclude. Empty String indicates don't exclude anything (default).
User property is: excludeTypes.
excludes String - A comma separated list of file patterns to exclude when unpacking the artifact. i.e. **\/*.xml,**\/*.properties NOTE: Excludes patterns override the includes. (component code = return isIncluded( name ) AND !isExcluded( name );)
User property is: mdep.unpack.excludes.
failOnMissingClassifierArtifact boolean - This only applies if the classifier parameter is used.
Default value is: false.
User property is: mdep.failOnMissingClassifierArtifact.
flatten boolean - If META-INF/resources/webjars should be omitted.
User property is: webjar.flatten.
ignorePermissions boolean - ignore to set file permissions when unpacking a dependency
Default value is: false.
User property is: dependency.ignorePermissions.
includeArtifactIds String - Comma separated list of Artifact names to include. Empty String indicates include everything (default).
User property is: includeArtifactIds.
includeClassifiers String - Comma Separated list of Classifiers to include. Empty String indicates include everything (default).
User property is: includeClassifiers.
includeGroupIds String - Comma separated list of GroupIds to include. Empty String indicates include everything (default).
User property is: includeGroupIds.
includeScope String - Scope to include. 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:
  • runtime scope gives runtime and compile dependencies,
  • compile scope gives compile, provided, and system dependencies,
  • test (default) scope gives all dependencies,
  • provided scope just gives provided dependencies,
  • system scope just gives system dependencies.

User property is: includeScope.
includeTypes String - Comma Separated list of Types to include. Empty String indicates include everything (default).
User property is: includeTypes.
includes String - A comma separated list of file patterns to include when unpacking the artifact. i.e. **\/*.xml,**\/*.properties NOTE: Excludes patterns override the includes. (component code = return isIncluded( name ) AND !isExcluded( name );)
User property is: mdep.unpack.includes.
markersDirectory File - Directory to store flag files
Default value is: ${project.build.directory}/dependency-maven-plugin-markers.
User property is: markersDirectory.
outputAbsoluteArtifactFilename boolean - Output absolute filename for resolved artifacts
Default value is: false.
User property is: outputAbsoluteArtifactFilename.
outputDirectory File - Output location.
Default value is: ${project.build.directory}/dependency.
User property is: outputDirectory.
overWriteIfNewer boolean - Overwrite artifacts that don't exist or are older than the source.
Default value is: true.
User property is: overWriteIfNewer.
overWriteReleases boolean - Overwrite release artifacts
Default value is: false.
User property is: overWriteReleases.
overWriteSnapshots boolean - Overwrite snapshot artifacts
Default value is: false.
User property is: overWriteSnapshots.
prependGroupId boolean - Prepend the groupId during copy.
Default value is: false.
User property is: mdep.prependGroupId.
silent boolean - If the plugin should be silent.
Default value is: false.
User property is: silent.
skip boolean - Skip plugin execution completely.
Default value is: false.
User property is: mdep.skip.
stripClassifier boolean - Strip artifact classifier during copy
Default value is: false.
User property is: mdep.stripClassifier.
stripVersion boolean - Strip artifact version during copy
Default value is: false.
User property is: mdep.stripVersion.
type String - Specify type to look for when constructing artifact based on classifier. Example: java-source,jar,war
User property is: type.
useJvmChmod boolean -

will use the jvm chmod, this is available for user and all level group level will be ignored

since 2.6 is on by default
Default value is: true.
User property is: dependency.useJvmChmod.
useRepositoryLayout boolean - Place each artifact in the same directory layout as a default repository.
example: /outputDirectory/junit/junit/3.8.1/junit-3.8.1.jar
Default value is: false.
User property is: mdep.useRepositoryLayout.
useSubDirectoryPerArtifact boolean - Place each file in a separate subdirectory. (example /outputDirectory/junit-3.8.1-jar)
Default value is: false.
User property is: mdep.useSubDirectoryPerArtifact.
useSubDirectoryPerScope boolean - Place each type of file in a separate subdirectory. (example /outputDirectory/runtime /outputDirectory/provided etc)
Default value is: false.
User property is: mdep.useSubDirectoryPerScope.
useSubDirectoryPerType boolean - Place each type of file in a separate subdirectory. (example /outputDirectory/jars /outputDirectory/wars etc)
Default value is: false.
User property is: mdep.useSubDirectoryPerType.

Parameter Details

classifier:

Specify classifier to look for. Example: sources
  • Type: java.lang.String
  • Required: No
  • User Property: classifier

encoding:

Encoding of artifacts.
  • Type: java.lang.String
  • Required: No
  • User Property: mdep.unpack.encoding

excludeArtifactIds:

Comma separated list of Artifact names to exclude.
  • Type: java.lang.String
  • Required: No
  • User Property: excludeArtifactIds

excludeClassifiers:

Comma Separated list of Classifiers to exclude. Empty String indicates don't exclude anything (default).
  • Type: java.lang.String
  • Required: No
  • User Property: excludeClassifiers

excludeGroupIds:

Comma separated list of GroupId Names to exclude.
  • Type: java.lang.String
  • Required: No
  • User Property: excludeGroupIds

excludeScope:

Scope to exclude. An Empty string indicates no scopes (default).
  • Type: java.lang.String
  • Required: No
  • User Property: excludeScope

excludeTransitive:

If we should exclude transitive dependencies
  • Type: boolean
  • Required: No
  • User Property: excludeTransitive
  • Default: false

excludeTypes:

Comma Separated list of Types to exclude. Empty String indicates don't exclude anything (default).
  • Type: java.lang.String
  • Required: No
  • User Property: excludeTypes

excludes:

A comma separated list of file patterns to exclude when unpacking the artifact. i.e. **\/*.xml,**\/*.properties NOTE: Excludes patterns override the includes. (component code = return isIncluded( name ) AND !isExcluded( name );)
  • Type: java.lang.String
  • Required: No
  • User Property: mdep.unpack.excludes

failOnMissingClassifierArtifact:

This only applies if the classifier parameter is used.
  • Type: boolean
  • Required: No
  • User Property: mdep.failOnMissingClassifierArtifact
  • Default: false

flatten:

If META-INF/resources/webjars should be omitted.
  • Type: boolean
  • Required: No
  • User Property: webjar.flatten

ignorePermissions:

ignore to set file permissions when unpacking a dependency
  • Type: boolean
  • Required: No
  • User Property: dependency.ignorePermissions
  • Default: false

includeArtifactIds:

Comma separated list of Artifact names to include. Empty String indicates include everything (default).
  • Type: java.lang.String
  • Required: No
  • User Property: includeArtifactIds

includeClassifiers:

Comma Separated list of Classifiers to include. Empty String indicates include everything (default).
  • Type: java.lang.String
  • Required: No
  • User Property: includeClassifiers

includeGroupIds:

Comma separated list of GroupIds to include. Empty String indicates include everything (default).
  • Type: java.lang.String
  • Required: No
  • User Property: includeGroupIds

includeScope:

Scope to include. 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:
  • runtime scope gives runtime and compile dependencies,
  • compile scope gives compile, provided, and system dependencies,
  • test (default) scope gives all dependencies,
  • provided scope just gives provided dependencies,
  • system scope just gives system dependencies.
  • Type: java.lang.String
  • Required: No
  • User Property: includeScope

includeTypes:

Comma Separated list of Types to include. Empty String indicates include everything (default).
  • Type: java.lang.String
  • Required: No
  • User Property: includeTypes

includes:

A comma separated list of file patterns to include when unpacking the artifact. i.e. **\/*.xml,**\/*.properties NOTE: Excludes patterns override the includes. (component code = return isIncluded( name ) AND !isExcluded( name );)
  • Type: java.lang.String
  • Required: No
  • User Property: mdep.unpack.includes

markersDirectory:

Directory to store flag files
  • Type: java.io.File
  • Required: No
  • User Property: markersDirectory
  • Default: ${project.build.directory}/dependency-maven-plugin-markers

outputAbsoluteArtifactFilename:

Output absolute filename for resolved artifacts
  • Type: boolean
  • Required: No
  • User Property: outputAbsoluteArtifactFilename
  • Default: false

outputDirectory:

Output location.
  • Type: java.io.File
  • Required: No
  • User Property: outputDirectory
  • Default: ${project.build.directory}/dependency

overWriteIfNewer:

Overwrite artifacts that don't exist or are older than the source.
  • Type: boolean
  • Required: No
  • User Property: overWriteIfNewer
  • Default: true

overWriteReleases:

Overwrite release artifacts
  • Type: boolean
  • Required: No
  • User Property: overWriteReleases
  • Default: false

overWriteSnapshots:

Overwrite snapshot artifacts
  • Type: boolean
  • Required: No
  • User Property: overWriteSnapshots
  • Default: false

prependGroupId:

Prepend the groupId during copy.
  • Type: boolean
  • Required: No
  • User Property: mdep.prependGroupId
  • Default: false

silent:

If the plugin should be silent.
  • Type: boolean
  • Required: No
  • User Property: silent
  • Default: false

skip:

Skip plugin execution completely.
  • Type: boolean
  • Required: No
  • User Property: mdep.skip
  • Default: false

stripClassifier:

Strip artifact classifier during copy
  • Type: boolean
  • Required: No
  • User Property: mdep.stripClassifier
  • Default: false

stripVersion:

Strip artifact version during copy
  • Type: boolean
  • Required: No
  • User Property: mdep.stripVersion
  • Default: false

type:

Specify type to look for when constructing artifact based on classifier. Example: java-source,jar,war
  • Type: java.lang.String
  • Required: No
  • User Property: type

useJvmChmod:

will use the jvm chmod, this is available for user and all level group level will be ignored

since 2.6 is on by default
  • Type: boolean
  • Required: No
  • User Property: dependency.useJvmChmod
  • Default: true

useRepositoryLayout:

Place each artifact in the same directory layout as a default repository.
example: /outputDirectory/junit/junit/3.8.1/junit-3.8.1.jar
  • Type: boolean
  • Required: No
  • User Property: mdep.useRepositoryLayout
  • Default: false

useSubDirectoryPerArtifact:

Place each file in a separate subdirectory. (example /outputDirectory/junit-3.8.1-jar)
  • Type: boolean
  • Required: No
  • User Property: mdep.useSubDirectoryPerArtifact
  • Default: false

useSubDirectoryPerScope:

Place each type of file in a separate subdirectory. (example /outputDirectory/runtime /outputDirectory/provided etc)
  • Type: boolean
  • Required: No
  • User Property: mdep.useSubDirectoryPerScope
  • Default: false

useSubDirectoryPerType:

Place each type of file in a separate subdirectory. (example /outputDirectory/jars /outputDirectory/wars etc)
  • Type: boolean
  • Required: No
  • User Property: mdep.useSubDirectoryPerType
  • Default: false