plugin:helpmojo
Full name:
org.apache.maven.plugins:maven-plugin-plugin:3.13.1:helpmojo
Description:
Generates a HelpMojo class. Relies at runtime on one output file from DescriptorGeneratorMojo.
Attributes:
- Requires a Maven project to be executed.
- Requires dependency resolution of artifacts in scope:
compile. - The goal is thread-safe and supports parallel builds.
- Since version:
2.4. - Binds by default to the lifecycle phase:
generate-sources.
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<goalPrefix> |
String |
- |
The goal prefix that will appear before the ":". |
<helpPackageName> |
String |
2.6 |
The name of the package for the generated HelpMojo.
By default, the package name will be calculated as
|
<outputDirectory> |
File |
- |
The directory where the generated HelpMojo file will be put.Default: ${project.build.directory}/generated-sources/plugin |
<packagingTypes> |
List<String> |
3.3 |
Maven plugin packaging types. Default is single "maven-plugin". |
<skip> |
boolean |
2.8 |
Set this to "true" to skip invoking any goals or reports of the plugin. Default: falseUser Property: maven.plugin.skip |
Parameter Details
<goalPrefix>
The goal prefix that will appear before the ":".
- Type:
java.lang.String - Required:
No
<helpPackageName>
The name of the package for the generated
HelpMojo.
By default, the package name will be calculated as groupId + "." + artifactId with additional
-(dashes) will be replaced by_(underscores)_(underscore) will be added before each number or Java keyword at the beginning of name
- Type:
java.lang.String - Since:
2.6 - Required:
No
<outputDirectory>
The directory where the generated
HelpMojo file will be put.- Type:
java.io.File - Required:
No - Default:
${project.build.directory}/generated-sources/plugin
<packagingTypes>
Maven plugin packaging types. Default is single "maven-plugin".
- Type:
java.util.List<java.lang.String> - Since:
3.3 - Required:
No
<skip>
Set this to "true" to skip invoking any goals or reports of the plugin.
- Type:
boolean - Since:
2.8 - Required:
No - User Property:
maven.plugin.skip - Default:
false