Maven help 插件

Maven Help Plugin用于获取有关项目或系统的帮助信息。也可以用于获取特定插件的帮助信息,如插件的参数和使用要求。

goals

Help 插件有8个goals,分别如下:

  1. active-profiles
  2. all-profiles
  3. describe
  4. effective-pom
  5. effective-settings
  6. evaluate
  7. expressions
  8. system

另外还有一个goals是用于显示自身帮助信息的:help。

active-profiles

列出当前正在构建的配置文件列表。

全名为:org.apache.maven.plugins:maven-help-plugin:2.2:active-profiles
缩略名为:help:active-profiles

可选参数:output

用于把此帮助的输出写入到给定文件中。支持相对路径。

all-profiles

列出当前项目下的可用配置文件

全名为:org.apache.maven.plugins:maven-help-plugin:2.2:all-profiles
缩略名为:help;all-profiles

可选参数:output

用于把此帮助的输出写入到给定文件中。支持相对路径。

describe

描述插件和/或Mojo(Maven普通旧Java对象)的属性。其实就是输出他们的帮助信息。

全名为:org.apache.maven.plugins:maven-help-plugin:2.2:describe
缩略名为:help:describe

可选参数

名称类型版本要求说明
artifactIdstring2.0Maven 插件的 artifactId,在使用此参数时必须使用groupId参数对插件进行约束
cmdstring2.1一个Maven命令中的目标,或阶段。
detailboolean2.1指明是否输出详细信息,默认为false
goalstring2.1指定“目标”,如果给了这个参数,则输出的是给定目标的帮助信息,而不是整个插件的帮助信息。
groupIdstring2.0Maven插件的groupId,在使用此参数时必须使用artifactId参数对插件进行约束
mediumboolean2.0.2指明输出中等详细的信息,默认为true
minimalboolean2.0.2指明输出简短的帮助信息,默认为false
outputfile2.0可选参数,用于把此帮助的输出写入到给定文件中。支持相对路径。
pluginstring2.0用于指定Maven插件,可以使用以下三种形式之一:
plugin-prefix 如“help”,
groupId:artifactId 如”org.apache.maven.plugins:maven-help-plugin”,
groupId:artifactId:version 如”org.apache.maven.plugins:maven-help-plugin:2.0″。
versionstring2.0Maven插件的版本,在使用此参数时需要配合groupId和artifactId参数一起完成对插件的约束

effective-pom

将当前项目正在构建的pom中的有效内容打印出来。请注意,这并不是要打印出你当前项目中所写的pom的内容,而是会把所有对当前项目生效的pom内容合并成一个xml格式的文档,然后输出。这可能包括在Maven安装目录中conf子目录下名为setting.xml中的内容,~/.m2目录下名为setting.xml文件中的内容,其他引入或继承的pom文件的内容。

全名为:org.apache.maven.plugins:maven-help-plugin:2.2:effective-pom
缩略名为:help:effective-pom

可选参数:output

用于把此帮助的输出写入到给定文件中。支持相对路径。

effective-settings

将用户文件与全局文件中的settings信息合并后以xml格式显示出来。合并过程中以用户文件内容优先。其实就是maven实际用于构建的设置信息。

全名为:org.apache.maven.plugins:maven-help-plugin:2.2:effective-settings
缩略名为:help:effective-settings

可选参数

名称类型版本要求说明
outputfile2.0可选参数,用于把此帮助的输出写入到给定文件中。支持相对路径。
showpasswordsboolean2.1出于安全的原因,所以密码默认为不显示,当此参数为true时,所有密码都会显示出来。

evaluate

计算用户在交互模式下给出的maven表达式。

全名为:org.apache.maven.plugins:maven-help-plugin:2.2:evaluate
缩略名为:help:evaluate

可选参数

名称类型版本要求说明
artifactIdstring2.1用于计算maven表达式的artifact,格式为groupId:artifactId[:version][:classifier],如果省略,则默认为计算当前项目的maven表达式
expressionstring2.1用于计算的maven表达式,注意:当有这个参数时将不会进入交互模式,而是直接输出expression所指定表达式的值然后退出,这时expression表达式外层不能包括${…}。

expressions

列出maven支持的表达式。

全名为:org.apache.maven.plugins:maven-help-plugin:2.2:expressions
缩略名为:help:expressions

可选参数:output

用于把此帮助的输出写入到给定文件中。支持相对路径。

system

列出当前所在平台的系统属性和环境变量。

全名为:org.apache.maven.plugins:maven-help-plugin:2.2:system
缩略名为:help:system

可选参数:output

用于把此帮助的输出写入到给定文件中。支持相对路径。

help

显示maven-help-plugin插件的帮助信息。

全名为:org.apache.maven.plugins:maven-help-plugin:2.2:help
缩略名为:help:help

可选参数

名称类型版本要求说明
detailboolean指明是否输出详细信息,默认为false
goalstring指定“目标”,如果给了这个参数,则输出的是给定目标的帮助信息,而不是整个插件的帮助信息。
identSizeint每个缩进的空格数,默认为:2
lineLengthint每行最多显示的字符数,超过则换行,默认为:80
    原文作者:JSON_NULL
    原文地址: https://www.jianshu.com/p/b2cb560c3a3d
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞