soy:compile

Full name:

com.odiago.maven.plugins:soy-maven-plugin:1.0.0:compile

Description:

A maven goal for compiling soy templates (Google Closure Templates) into javascript files.

Attributes:

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

Required Parameters

Name Type Since Description
inputFiles FileSet - The soy files to be compiled into javascript files.
outputDirectory File - The target directory for generated javascript files.
Default value is: ${project.build.directory}/generated-js/soy.

Optional Parameters

Name Type Since Description
globals Map - Compile time globals to bind in the templates.
shouldGenerateJsdoc boolean - Whether to generate Jsdoc compatible for Google Closure Compiler integration.
Default value is: false.
shouldProvideRequireSoyNamespaces boolean - Whether to generate code with provide/require soy namespaces for Google Closure Compiler integration.
Default value is: false.

Parameter Details

globals:

Compile time globals to bind in the templates.
  • Type: java.util.Map
  • Required: No

inputFiles:

The soy files to be compiled into javascript files.
  • Type: org.apache.maven.shared.model.fileset.FileSet
  • Required: Yes

outputDirectory:

The target directory for generated javascript files.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${soy.output.directory}
  • Default: ${project.build.directory}/generated-js/soy

shouldGenerateJsdoc:

Whether to generate Jsdoc compatible for Google Closure Compiler integration.
  • Type: boolean
  • Required: No
  • Default: false

shouldProvideRequireSoyNamespaces:

Whether to generate code with provide/require soy namespaces for Google Closure Compiler integration.
  • Type: boolean
  • Required: No
  • Default: false