pl.allegro.tdr.gruntmaven

Class BaseMavenGruntMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

pl.allegro.tdr.gruntmaven.BaseMavenGruntMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AbstractExecutableMojo, CleanResourcesMojo, CreateResourcesMojo

public abstract class BaseMavenGruntMojo
extends org.apache.maven.plugin.AbstractMojo

Common properties for all maven-grunt goals.

Author:

Adam Dubiel

Field Summary

Fields

Modifier and Type	Field and Description
protected String	gruntBuildDirectory Path to build directory (target for grunt sources), defaults to ${basedir}/target-grunt.
protected String	jsSourceDirectory Path to dir from where to copy all files that add to grunt environment - has to include package.json and Gruntfile.js, defaults to "static".
protected String	npmOfflineModulesFile Name of packed node_modules TAR file, defaults to node_modules.tar.
protected String	npmOfflineModulesFilePath Path to packed node_modules TAR file directory relative to basedir, defaults to statics directory (ex webapp/static/).
protected String	sourceDirectory Path to dir, where jsSourceDir is located, defaults to src/main/webapp.
protected String	warTargetDirectory Path to dir inside WAR to which grunt build artifacts will be copied, defaults to jsSourceDirectory value.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
BaseMavenGruntMojo()

Method Summary

Modifier and Type	Method and Description
protected String	basedir()
void	execute()
protected abstract void	executeInternal()
protected String	fullJsSourceDirectory()
protected org.twdata.maven.mojoexecutor.MojoExecutor.ExecutionEnvironment	pluginExecutionEnvironment()
protected String	relativeJsSourceDirectory()
protected String	target()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

gruntBuildDirectory

@Parameter(property="gruntBuildDirectory",
           defaultValue="${basedir}/target-grunt")
protected String gruntBuildDirectory

Path to build directory (target for grunt sources), defaults to ${basedir}/target-grunt.

sourceDirectory

@Parameter(property="sourceDirectory",
           defaultValue="src/main/webapp")
protected String sourceDirectory

Path to dir, where jsSourceDir is located, defaults to src/main/webapp.

jsSourceDirectory

@Parameter(property="jsSourceDirectory",
           defaultValue="static")
protected String jsSourceDirectory

Path to dir from where to copy all files that add to grunt environment - has to include package.json and Gruntfile.js, defaults to "static".

warTargetDirectory

@Parameter(property="warTargetDirectory")
protected String warTargetDirectory

Path to dir inside WAR to which grunt build artifacts will be copied, defaults to jsSourceDirectory value.

npmOfflineModulesFile

@Parameter(property="npmOfflineModulesFile",
           defaultValue="node_modules.tar")
protected String npmOfflineModulesFile

Name of packed node_modules TAR file, defaults to node_modules.tar.

npmOfflineModulesFilePath

@Parameter(property="npmOfflineModulesFilePath",
           defaultValue="")
protected String npmOfflineModulesFilePath

Path to packed node_modules TAR file directory relative to basedir, defaults to statics directory (ex webapp/static/).

Constructor Detail

BaseMavenGruntMojo

public BaseMavenGruntMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

executeInternal

protected abstract void executeInternal()
                                 throws org.apache.maven.plugin.MojoExecutionException,
                                        org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

basedir

protected String basedir()

target

protected String target()

fullJsSourceDirectory

protected String fullJsSourceDirectory()

relativeJsSourceDirectory

protected String relativeJsSourceDirectory()

pluginExecutionEnvironment

protected org.twdata.maven.mojoexecutor.MojoExecutor.ExecutionEnvironment pluginExecutionEnvironment()