Fork me on GitHub
Built by Maven

filevault-package:format-xml

Full name:

org.apache.jackrabbit:filevault-package-maven-plugin:1.4.0:format-xml

Description:

Either checks only the formatting of the Docview XML files to comply with the formatting rules from FileVault or also reformats those files.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: process-sources.

Required Parameters

Name Type Since Description
<jcrRootSourceDirectory> File[] - The directory that contains the jcr_root of the content. Multiple directories can be specified as a comma separated list, which will act as a search path and cause the plugin to look for the first existing directory.
Default: ${project.basedir}/jcr_root,${project.basedir}/src/main/jcr_root,${project.basedir}/src/main/content/jcr_root,${project.basedir}/src/content/jcr_root,${project.build.outputDirectory}
User Property: vault.jcrRootSourceDirectory

Optional Parameters

Name Type Since Description
<enableForIncrementalBuild> boolean - If set to true will also run on incremental builds (i.e. within Eclipse with m2e). Otherwise this goal is skipped in incremental builds and only runs on full builds.
Default: false
<excludes> Set<String> - Exclude patterns for files to exclude. If not set defaults to [].

Note: includes have precedences over excludes. Each pattern can either be an Ant-like pattern or a regular expression if it is starting with %regex[ and ending with ].

<includes> Set<String> - Include patterns for files to include. If not set defaults to [**\/*.xml].

Note: includes have precedences over excludes. Each pattern can either be an Ant-like pattern or a regular expression if it is starting with %regex[ and ending with ].

<validateOnly> boolean - If set to true then fails the build if it encounters XML files which don't follow the formatting rules for XML Docview files. If set to false will reformat all XML Docview files.
Default: false
User Property: vault.validateOnly

Parameter Details

<enableForIncrementalBuild>

If set to true will also run on incremental builds (i.e. within Eclipse with m2e). Otherwise this goal is skipped in incremental builds and only runs on full builds.
  • Type: boolean
  • Required: No
  • Default: false

<excludes>

Exclude patterns for files to exclude. If not set defaults to [].

Note: includes have precedences over excludes. Each pattern can either be an Ant-like pattern or a regular expression if it is starting with %regex[ and ending with ].

<includes>

Include patterns for files to include. If not set defaults to [**\/*.xml].

Note: includes have precedences over excludes. Each pattern can either be an Ant-like pattern or a regular expression if it is starting with %regex[ and ending with ].

<jcrRootSourceDirectory>

The directory that contains the jcr_root of the content. Multiple directories can be specified as a comma separated list, which will act as a search path and cause the plugin to look for the first existing directory.
  • Type: java.io.File[]
  • Required: Yes
  • User Property: vault.jcrRootSourceDirectory
  • Default: ${project.basedir}/jcr_root,${project.basedir}/src/main/jcr_root,${project.basedir}/src/main/content/jcr_root,${project.basedir}/src/content/jcr_root,${project.build.outputDirectory}

<validateOnly>

If set to true then fails the build if it encounters XML files which don't follow the formatting rules for XML Docview files. If set to false will reformat all XML Docview files.
  • Type: boolean
  • Required: No
  • User Property: vault.validateOnly
  • Default: false