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

可选参数

名称 类型 版本要求 说明
artifactId string 2.0 Maven 插件的 artifactId,在使用此参数时必须使用groupId参数对插件进行约束
cmd string 2.1 一个Maven命令中的目标,或阶段。
detail boolean 2.1 指明是否输出详细信息,默认为false
goal string 2.1 指定“目标”,如果给了这个参数,则输出的是给定目标的帮助信息,而不是整个插件的帮助信息。
groupId string 2.0 Maven插件的groupId,在使用此参数时必须使用artifactId参数对插件进行约束
medium boolean 2.0.2 指明输出中等详细的信息,默认为true
minimal boolean 2.0.2 指明输出简短的帮助信息,默认为false
output file 2.0 可选参数,用于把此帮助的输出写入到给定文件中。支持相对路径。
plugin string 2.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"。
version string 2.0 Maven插件的版本,在使用此参数时需要配合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

可选参数

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

evaluate

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

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

可选参数

名称 类型 版本要求 说明
artifactId string 2.1 用于计算maven表达式的artifact,格式为groupId:artifactId[:version][:classifier],如果省略,则默认为计算当前项目的maven表达式
expression string 2.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

可选参数

名称 类型 版本要求 说明
detail boolean - 指明是否输出详细信息,默认为false
goal string - 指定“目标”,如果给了这个参数,则输出的是给定目标的帮助信息,而不是整个插件的帮助信息。
identSize int - 每个缩进的空格数,默认为:2
lineLength int - 每行最多显示的字符数,超过则换行,默认为:80
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,922评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,591评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,546评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,467评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,553评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,580评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,588评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,334评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,780评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,092评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,270评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,925评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,573评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,194评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,437评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,154评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,127评论 2 352

推荐阅读更多精彩内容