HTL Maven Plugin – htl:validate

htl:validate

Full name:

org.apache.sling:htl-maven-plugin:2.0.4-1.4.0:validate

Description:

Validates HTL scripts and optionally transpiles them to Java classes.

Attributes:

Requires a Maven project to be executed.
Binds by default to the lifecycle phase: generate-sources.

Optional Parameters

Name	Type	Since	Description
`<allowedExpressionOptions>`	`Set`	`1.3.0`	Adds the provided options to the list of known expression options, so that the compiler doesn't log any warnings about them. User property is: `htl.allowedExpressionOptions`.
`<excludes>`	`String[]`	`1.0.0`	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).
`<failOnErrors>`	`boolean`	`2.0.0`	If set to "false" it will not fail the build on compiler errors, however the errors will still be logged. Default value is: `true`. User property is: `htl.failOnErrors`.
`<failOnWarnings>`	`boolean`	`1.0.0`	If set to "true" it will fail the build on compiler warnings. Default value is: `false`. User property is: `htl.failOnWarnings`.
`<generateJavaClasses>`	`boolean`	`1.1.0`	If set to "true" it will generate the Java classes resulted from transpiling the HTL scripts to Java. The generated classes will be stored in the folder identified by the `generatedJavaClassesDirectory` parameter. Default value is: `false`. User property is: `htl.generateJavaClasses`.
`<generatedJavaClassesDirectory>`	`File`	`1.1.0`	Defines the folder where the generated Java classes resulted from transpiling the project's HTL scripts will be stored. This folder will be added to the list of source folders for this project. Default value is: `${project.build.directory}/generated-sources/htl`. User property is: `htl.generatedJavaClassesDirectory`.
`<generatedJavaClassesPrefix>`	`String`	`1.2.0-1.4.0`	Defines the package prefix under which the HTL compilers will generate the Java classes. By default the plugin doesn't provide any prefix. User property is: `htl.generatedJavaClassesPrefix`.
`<ignoreImports>`	`Set`	`1.1.0`	Defines a list of Java packages that should be ignored when generating the import statements for the Java classes resulted from transpiling the project's HTL scripts. Subpackages of these packages will also be part automatically of the ignore list. User property is: `htl.ignoreImports`.
`<includes>`	`String[]`	`1.0.0`	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). Default value is: `*/.html`.
`<skip>`	`boolean`	`1.0.2`	If set to "true" the validation will be skipped. Default value is: `false`. User property is: `htl.skip`.
`<sourceDirectory>`	`File`	`1.0.0`	Defines the root folder where this Mojo expects to find HTL scripts to validate. The default value has been changed from `${project.build.sourceDirectory`} to `${project.build.scriptSourceDirectory`} in version 2.0.0. Default value is: `${project.build.scriptSourceDirectory}`. User property is: `htl.sourceDirectory`.

Parameter Details

<allowedExpressionOptions>

Adds the provided options to the list of known expression options, so that the compiler doesn't log any warnings about them.

Type: java.util.Set
Since: 1.3.0
Required: No
User Property: htl.allowedExpressionOptions

<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[]
Since: 1.0.0
Required: No

<failOnErrors>

If set to "false" it will not fail the build on compiler errors, however the errors will still be logged.

Type: boolean
Since: 2.0.0
Required: No
User Property: htl.failOnErrors
Default: true

<failOnWarnings>

If set to "true" it will fail the build on compiler warnings.

Type: boolean
Since: 1.0.0
Required: No
User Property: htl.failOnWarnings
Default: false

If set to "true" it will generate the Java classes resulted from transpiling the HTL scripts to Java. The generated classes will be stored in the folder identified by the generatedJavaClassesDirectory parameter.

Type: boolean
Since: 1.1.0
Required: No
User Property: htl.generateJavaClasses
Default: false

<generatedJavaClassesDirectory>

Defines the folder where the generated Java classes resulted from transpiling the project's HTL scripts will be stored. This folder will be added to the list of source folders for this project.

Type: java.io.File
Since: 1.1.0
Required: No
User Property: htl.generatedJavaClassesDirectory
Default: ${project.build.directory}/generated-sources/htl

<generatedJavaClassesPrefix>

Defines the package prefix under which the HTL compilers will generate the Java classes. By default the plugin doesn't provide any prefix.

Type: java.lang.String
Since: 1.2.0-1.4.0
Required: No
User Property: htl.generatedJavaClassesPrefix

<ignoreImports>

Defines a list of Java packages that should be ignored when generating the import statements for the Java classes resulted from transpiling the project's HTL scripts. Subpackages of these packages will also be part automatically of the ignore list.

Type: java.util.Set
Since: 1.1.0
Required: No
User Property: htl.ignoreImports

<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[]
Since: 1.0.0
Required: No
Default: **/*.html

<skip>

If set to "true" the validation will be skipped.

Type: boolean
Since: 1.0.2
Required: No
User Property: htl.skip
Default: false

<sourceDirectory>

Defines the root folder where this Mojo expects to find HTL scripts to validate. The default value has been changed from ${project.build.sourceDirectory} to ${project.build.scriptSourceDirectory} in version 2.0.0.

Type: java.io.File
Since: 1.0.0
Required: No
User Property: htl.sourceDirectory
Default: ${project.build.scriptSourceDirectory}