You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ro...@apache.org on 2017/10/18 23:30:07 UTC
[sling-htl-maven-plugin] 08/39: trivial: added README for the
htl-maven-plugin
This is an automated email from the ASF dual-hosted git repository.
rombert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-htl-maven-plugin.git
commit 8d8d2ca1989b9b0b87f33d945aca8f0c376a619e
Author: Radu Cotescu <ra...@apache.org>
AuthorDate: Tue Sep 6 10:40:23 2016 +0000
trivial: added README for the htl-maven-plugin
git-svn-id: https://svn.apache.org/repos/asf/sling/trunk@1759406 13f79535-47bb-0310-9956-ffa450edef68
---
README.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 78 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..51cbae4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,78 @@
+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`](#htlvalidate) - validate the scripts from the build directory (`${project.build.sourceDirectory}`)
+
+## Usage
+```xml
+<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>
+ <phase>compile</phase>
+ </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`](#param-sourceDirectory) | `String` | `1.0.0` | Defines the root folder where this goal expects to find Sightly scripts to validate. |
+| [`includes`](#param-includes) | `String[]` | `1.0.0` | List of files to include, specified as fileset patterns which are relative to `sourceDirectory`. |
+| [`excludes`](#param-excludes) | `String[]` | `1.0.0` | List of files to exclude, specified as fileset patterns which are relative to `sourceDirectory`. |
+| [`failOnWarnings`](#param-failOnWarnings) | `boolean` | `1.0.0` | If set to `true` it will fail the build on compiler warnings. |
+
+### Parameter Details
+
+<a name="param-sourceDirectory"><code>sourceDirectory</code></a>:
+
+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}`
+
+<a name="param-includes"><code>includes</code></a>:
+
+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`
+
+<a name="param-excludes"><code>excludes</code></a>:
+
+List of files to exclude, specified as fileset patterns which are relative to `sourceDirectory`.
+* **Type:** `java.lang.String[]`
+* **Required:** No
+* **User Property:** `excludes`
+
+<a name="param-failOnWarning"><code>failOnWarnings</code></a>:
+
+If set to `true` it will fail the build on compiler warnings.
+* **Type:** `boolean`
+* **Required:** No
+* **User Property:** `failOnWarnings`
+* **Default:** `false`
+
--
To stop receiving notification emails like this one, please contact
"commits@sling.apache.org" <co...@sling.apache.org>.