Built by Maven

htl:validate

Full name:

org.apache.sling:htl-maven-plugin:1.0.6:validate

Description:

This goal validates Sightly scripts syntax.

Attributes:

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

Optional Parameters

Name Type Since Description
excludes String[] - List of files to exclude. Specified as fileset patterns which are relative to the input directory whose contents will be scanned (see the sourceDirectory configuration option).
failOnWarnings boolean - If set to "true" it will fail the build on compiler warnings.
Default value is: false.
User property is: failOnWarnings.
includes String[] - List of files to include. Specified as fileset patterns which are relative to the input directory whose contents will be scanned (see the sourceDirectory configuration option).
skip boolean - If set to "true" the validation will be skipped.
Default value is: false.
User property is: htl.skip.
sourceDirectory File - Defines the root folder where this Mojo expects to find Sightly scripts to validate.
Default value is: ${project.build.sourceDirectory}.
User property is: sourceDirectory.

Parameter Details

excludes:

List of files to exclude. Specified as fileset patterns which are relative to the input directory whose contents will be scanned (see the sourceDirectory configuration option).
  • Type: java.lang.String[]
  • Required: No

failOnWarnings:

If set to "true" it will fail the build on compiler warnings.
  • Type: boolean
  • Required: No
  • User Property: failOnWarnings
  • Default: false

includes:

List of files to include. Specified as fileset patterns which are relative to the input directory whose contents will be scanned (see the sourceDirectory configuration option).
  • Type: java.lang.String[]
  • Required: No

skip:

If set to "true" the validation will be skipped.
  • Type: boolean
  • Required: No
  • User Property: htl.skip
  • Default: false

sourceDirectory:

Defines the root folder where this Mojo expects to find Sightly scripts to validate.
  • Type: java.io.File
  • Required: No
  • User Property: sourceDirectory
  • Default: ${project.build.sourceDirectory}