commit	984d254eba35cdb7e253a2d8047479dcfcdc1fc1	[log] [tgz]
author	Stefan Seifert <sseifert@apache.org>	Fri Sep 30 14:49:54 2016 +0000
committer	Stefan Seifert <sseifert@apache.org>	Fri Sep 30 14:49:54 2016 +0000
tree	58c00f8d94937b0df3cbafa6faac8c49417a33fa
parent	96f19c95592383563f326ae05463d8476a1b3062 [diff]

tree: 58c00f8d94937b0df3cbafa6faac8c49417a33fa

README.md

Apache Sling HTL Maven Plugin

The Apache Sling HTL Maven Plugin, M2Eclipse compatible, provides support for validating HTML Template Language scripts from projects during build time.

Goals overview

htl:validate - validate the scripts from the build directory (${project.build.sourceDirectory})

Usage

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.sling</groupId>
            <artifactId>htl-maven-plugin</artifactId>
            <version>1.0.0</version>
            <executions>
                <execution>
                    <id>validate-scripts</id>
                    <goals>
                        <goal>validate</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

`htl:validate`

Full name: org.apache.sling:htl-maven-plugin:1.0.0:validate

Description: Validates HTL scripts syntax during the build process.

Optional Parameters

Name	Type	Since	Description
`sourceDirectory`	`String`	`1.0.0`	Defines the root folder where this goal expects to find Sightly scripts to validate.
`includes`	`String[]`	`1.0.0`	List of files to include, specified as fileset patterns which are relative to `sourceDirectory`.
`excludes`	`String[]`	`1.0.0`	List of files to exclude, specified as fileset patterns which are relative to `sourceDirectory`.
`failOnWarnings`	`boolean`	`1.0.0`	If set to `true` it will fail the build on compiler warnings.

Parameter Details

sourceDirectory:

Defines the root folder where this goal expects to find Sightly scripts to validate.

Type: java.lang.String
Required: No
User Property: sourceDirectory
Default: ${project.build.sourceDirectory}

includes:

List of files to include, specified as fileset patterns which are relative to sourceDirectory.

Type: java.lang.String[]
Required: No
User Property: includes
Default: **/*.html

excludes:

List of files to exclude, specified as fileset patterns which are relative to sourceDirectory.

Type: java.lang.String[]
Required: No
User Property: excludes

failOnWarnings:

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

Type: boolean
Required: No
User Property: failOnWarnings
Default: false