Shulou(Shulou.com)06/03 Report--

This article mainly introduces the wed front-end development how to use maven-help-plugin to view plug-ins, has a certain reference value, interested friends can refer to, I hope you can learn a lot after reading this article, the following let Xiaobian take you to understand.

In addition to visiting the online documentation to learn the details of a plug-in, you can also use the maven-help-plugin plug-in to get the details of the plug-in. For example, run the following command from the CMD command line window.

Mvn help:describe-Dplugin=org.apache.maven.plugins:maven-site-plugin:3.4-Ddetail

You can see the details of version 3.4 of the maven-site-plugin plug-in, with a lot of content, and the following is a list of the first few basic information.

Name: Apache Maven Site Plugin

Description: The Maven Site Plugin is a plugin that generates a site for the

Current project.

Group Id: org.apache.maven.plugins

Artifact Id: maven-site-plugin

Version: 3.4

Goal Prefix: site

This plugin has 9 goals:

Site:attach-descriptor

Description: Adds the site descriptor (site.xml) to the list of files to be

Installed/deployed.

For Maven-2.x this is enabled by default only when the project has pom

Packaging since it will be used by modules inheriting, but this can be

Enabled for other projects packaging if needed.

This default execution has been removed from the built-in lifecycle of

Maven 3.x for pom-projects. Users that actually use those projects to

Provide a common site descriptor for sub modules will need to explicitly

Define this goal execution to restore the intended behavior.

Implementation: org.apache.maven.plugins.site.SiteDescriptorAttachMojo

Language: java

Bound to phase: package

Name: Apache Maven Site Plugin

Description: The Maven Site Plugin is a plugin that generates a site for the

Current project.

Group Id: org.apache.maven.plugins

Artifact Id: maven-site-plugin

Version: 3.4

Goal Prefix: site

This plugin has 9 goals:

Site:attach-descriptor

Description: Adds the site descriptor (site.xml) to the list of files to be

Installed/deployed.

For Maven-2.x this is enabled by default only when the project has pom

Packaging since it will be used by modules inheriting, but this can be

Enabled for other projects packaging if needed.

This default execution has been removed from the built-in lifecycle of

Maven 3.x for pom-projects. Users that actually use those projects to

Provide a common site descriptor for sub modules will need to explicitly

Define this goal execution to restore the intended behavior.

Implementation: org.apache.maven.plugins.site.SiteDescriptorAttachMojo

Language: java

Bound to phase: package

Of course, if you don't want to see too much, but just want to know a specific target of the plug-in, you can view the information of the specified target in the way of-Dgoal= target, such as running the following command to view the site target information of the site plug-in.

Mvn help:describe-Dplugin=site-Dgoal=site-Ddetail

Output information:

[INFO] Mojo: 'site:site'

Site:site

Description: Generates the site for a single project.

Note that links between module sites in a multi module build will not work

Since local build directory structure doesn't match deployed site.

Implementation: org.apache.maven.plugins.site.render.SiteMojo

Language: java

Available parameters:

Attributes

Additional template properties for rendering the site. See Doxia Site

Renderer.

GeneratedSiteDirectory (Default: ${project.build.directory} / generated-site)

Directory containing generated documentation. This is used to pick up

Other source docs that might have been generated at build time.

GenerateProjectInfo (Default: true)

User property: generateProjectInfo

Whether to generate the summary page for project reports:

Project-info.html.

GenerateReports (Default: true)

User property: generateReports

Convenience parameter that allows you to disable report generation.

GenerateSitemap (Default: false)

User property: generateSitemap

Generate a sitemap. The result will be a 'sitemap.html' file at the site

Root.

InputEncoding (Default: ${project.build.sourceEncoding})

User property: encoding

Specifies the input encoding.

Locales (Default: en)

User property: locales

A comma separated list of locales to render. The first valid token will

Be the default Locale for this site.

ModuleExcludes

Module type exclusion mappings ex: fml-> * * / *-m1.fml (excludes fml files

Ending in'- m1.fml' recursively)

The configuration looks like this:

Filename1.ext,**/*sample.ext

Changes.xml,navigation.xml

OutputDirectory (Default: ${project.reporting.outputDirectory})

User property: siteOutputDirectory

Directory where the project sites and report distributions will be

Generated.

OutputEncoding (Default: ${project.reporting.outputEncoding})

User property: outputEncoding

Specifies the output encoding.

RelativizeDecorationLinks (Default: true)

User property: relativizeDecorationLinks

Make links in the site descriptor relative to the project URL. By

Default, any absolute links that appear in the site descriptor, e.g.

Banner hrefs, breadcrumbs, menu links, etc., will be made relative to

Project.url.

Links will not be changed if this is set to false, or if the project has

No URL defined.

SaveProcessedContent

Whether to save Velocity processed Doxia content (*.. VM) to

${generatedSiteDirectory} / processed.

SiteDirectory (Default: ${basedir} / src/site)

Directory containing the site.xml file and the source for hand written

Docs (one directory per Doxia-source-supported markup types): see Doxia

Markup Languages References).

Skip (Default: false)

User property: maven.site.skip

Set this to 'true' to skip site generation and staging.

TemplateFile

User property: templateFile

The location of a Velocity template file to use. When used, skins and the

Default templates, CSS and images are disabled. It is highly recommended

That you package this as a skin instead.

Validate (Default: false)

User property: validate

Whether to validate xml input documents. If set to true, all input

Documents in xml format (in particular xdoc and fml) will be validated

And any error will lead to a build failure.

XdocDirectory (Default: ${basedir} / xdocs)

Alternative directory for xdoc source, useful for m1 to m2 migration

Deprecated. Use the standard m2 directory layout

The-Dplugin=site in the command specifies the name of the plug-in to view by the prefix of the plug-in, which means the same as writing-Dplugin=org.apache.maven.plugins:maven-site-plugin:3.6.

-Dgoal=site, specify the target to view, and the name is site.

-Ddetail, indicating that you want to view details.

Thank you for reading this article carefully. I hope the article "how to use maven-help-plugin to view plug-ins in wed front-end development" shared by the editor will be helpful to everyone. At the same time, I also hope that you will support and pay attention to the industry information channel. More related knowledge is waiting for you to learn!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.