插件:帮助mojo

全名

org.apache.maven.plugins:maven-plugin-plugin:3.6.4:helpmojo

说明

生成一个HelpMojo类。

属性

  • 需要执行一个 Maven 项目。
  • 需要范围内工件的依赖关系解析:compile.
  • 自版本:2.4.
  • 默认绑定到生命周期阶段generate-sources.

可选参数

姓名 类型 自从 描述
<checkExpectedProvidedScope> boolean 3.6.3 标志控制是“提供范围内的预期依赖关系”检查是否执行。默认值:true
默认值为true
用户属性是maven.plugin.checkExpectedProvidedScope
<encoding> String 2.5 源文件的文件编码。
默认值为${project.build.sourceEncoding}
用户属性是encoding
<expectedProvidedScopeExclusions> List 3.6.3 groupId:artifactId要从“预期提供范围”检查中排除的工件坐标字符串列表。默认值:["org.apache.maven:maven-archiver", "org.apache.maven:maven-jxr"]
<expectedProvidedScopeGroupIds> List 3.6.3 groupId预期在“提供”范围内的工件坐标字符串列表。默认值: ["org.apache.maven"]
<extractors> Set 2.4

要使用的 mojo 提取器的角色名称。

如果未设置,将使用所有 mojo 提取器。如果设置为空提取器名称,则不会使用 mojo 提取器。

例子:
 <!-- Use all mojo extractors -->
 <extractors/>

 <!-- Use no mojo extractors -->
 <extractors>
     <extractor/>
 </extractors>

 <!-- Use only bsh mojo extractor -->
 <extractors>
     <extractor>bsh</extractor>
 </extractors>

<goalPrefix> String 2.4 将出现在“:”之前的目标前缀。
<helpPackageName> String 2.6 生成的包的名称HelpMojo。默认情况下,将根据其他插件目标的包计算包。
<mojoDependencies> List 3.5 将依赖项指定为groupId:artifactId 包含(抽象)Mojos,以过滤在运行时扫描的依赖项,并专注于对 Mojo 分析真正有用的依赖项。默认情况下,该值为 isnull并扫描所有依赖项(与添加此参数之前一样)。如果在没有子项的配置中指定,则不扫描任何依赖项。
<outputDirectory> File 2.4 生成HelpMojo文件的存放目录。
默认值为${project.build.directory}/generated-sources/plugin
<packagingTypes> List 3.3 Maven 插件封装类型。默认为单个“maven-plugin”。
<skip> boolean 2.8 将此设置为“true”以跳过调用插件的任何目标或报告。
默认值为false
用户属性是maven.plugin.skip
<skipErrorNoDescriptorsFound> boolean 3.0 默认情况下,如果没有找到 mojo 描述符,则会抛出异常。由于 maven-plugin 在 core 中定义,描述符生成器 mojo 绑定到 generate-resources 阶段。但是对于注解,需要编译的类,所以跳过错误
默认值为: false
用户属性是maven.plugin.skipErrorNoDescriptorsFound

参数详情

<checkExpectedProvidedScope>

标志控制是“提供范围内的预期依赖关系”检查是否执行。默认值:true
  • 类型boolean
  • 3.6.3
  • 必需No
  • 用户属性maven.plugin.checkExpectedProvidedScope
  • 默认true

<编码>

源文件的文件编码。
  • 类型java.lang.String
  • 2.5
  • 必需No
  • 用户属性encoding
  • 默认${project.build.sourceEncoding}

<expectedProvidedScopeExclusions>

groupId:artifactId要从“预期提供范围”检查中排除的工件坐标字符串列表。默认值:["org.apache.maven:maven-archiver", "org.apache.maven:maven-jxr"]
  • 类型java.util.List
  • 3.6.3
  • 必需No

<expectedProvidedScopeGroupIds>

groupId预期在“提供”范围内的工件坐标字符串列表。默认值: ["org.apache.maven"]
  • 类型java.util.List
  • 3.6.3
  • 必需No

<提取器>

要使用的 mojo 提取器的角色名称。

如果未设置,将使用所有 mojo 提取器。如果设置为空提取器名称,则不会使用 mojo 提取器。

例子:
 <!-- Use all mojo extractors -->
 <extractors/>

 <!-- Use no mojo extractors -->
 <extractors>
     <extractor/>
 </extractors>

 <!-- Use only bsh mojo extractor -->
 <extractors>
     <extractor>bsh</extractor>
 </extractors>
  • 类型java.util.Set
  • 2.4
  • 必需No

<目标前缀>

将出现在“:”之前的目标前缀。
  • 类型java.lang.String
  • 2.4
  • 必需No

<帮助包名称>

生成的包的名称HelpMojo。默认情况下,将根据其他插件目标的包计算包。
  • 类型java.lang.String
  • 2.6
  • 必需No

<mojo依赖>

将依赖项指定为groupId:artifactId 包含(抽象)Mojos,以过滤在运行时扫描的依赖项,并专注于对 Mojo 分析真正有用的依赖项。默认情况下,该值为 isnull并扫描所有依赖项(与添加此参数之前一样)。如果在没有子项的配置中指定,则不扫描任何依赖项。
  • 类型java.util.List
  • 3.5
  • 必需No

<输出目录>

生成HelpMojo文件的存放目录。
  • 类型java.io.File
  • 2.4
  • 必需No
  • 默认${project.build.directory}/generated-sources/plugin

<包装类型>

Maven 插件封装类型。默认为单个“maven-plugin”。
  • 类型java.util.List
  • 3.3
  • 必需No

<跳过>

将此设置为“true”以跳过调用插件的任何目标或报告。
  • 类型boolean
  • 2.8
  • 必需No
  • 用户属性maven.plugin.skip
  • 默认false

<skipErrorNoDescriptorsFound>

默认情况下,如果没有找到 mojo 描述符,则会抛出异常。由于 maven-plugin 在 core 中定义,描述符生成器 mojo 绑定到 generate-resources 阶段。但是对于注解,需要编译的类,所以跳过错误
  • 类型boolean
  • 3.0
  • 必需No
  • 用户属性maven.plugin.skipErrorNoDescriptorsFound
  • 默认false