Skip to content

Latest commit

 

History

History
executable file
·
86 lines (64 loc) · 2.08 KB

README.md

File metadata and controls

executable file
·
86 lines (64 loc) · 2.08 KB
Raw

Twirl Maven Plugin

A Maven plugin which compiles Twirl templates into Scala source files.

Twirl lets you write type-safe, compiled templates in Scala:

// Hello.scala.html
@(name: String)
<h1>Hello, @name!</h1>

which you then render in code:

html.Hello.render("Jake")

to yield the final result:

<h1>Hello, Jake!</h1>

Usage

Add the plugin in your pom.xml:

<plugin>
  <groupId>com.jakewharton.twirl</groupId>
  <artifactId>twirl-maven-plugin</artifactId>
  <version>1.2.0</version>
  <executions>
    <execution>
      <phase>generate-sources</phase>
      <goals>
        <goal>compile</goal>
      </goals>
    </execution>
  </executions>
</plugin>

and specify a dependency on the Twirl API:

<dependency>
  <groupId>com.typesafe.play</groupId>
  <artifactId>twirl-api_2.12</artifactId>
  <version>1.4.1</version>
</dependency>

By default the plugin looks for templates in src/main/twirl/ and compiles to target/generated-sources/twirl/. The output folder is automatically added as a source root on the project.

The generated code is a Scala source file for each template which still need to be compiled using something like the scala-maven-plugin.

Snapshots of the development version are available in Sonatype's snapshots repository.

License

Copyright 2014 Jake Wharton

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.