Fork me on GitHub

filevault-package:format-xml

Full name:

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

Description:

Maven goal which 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.
  • Binds by default to the lifecycle phase: process-sources.

Required Parameters

Name Type Since Description
<jcrRootSourceDirectory> File[] - (no description)
Default value is: ${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 is: vault.jcrRootSourceDirectory.

Optional Parameters

Name Type Since Description
<excludes> Set - 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 - 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 value is: false.

Parameter Details

<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 ].

  • Type: java.util.Set
  • Required: No

<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 ].

  • Type: java.util.Set
  • Required: No

<jcrRootSourceDirectory>

(no description)
  • 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
  • Default: false