com.github.ug_dbg

Class NpmMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.ug_dbg.AbstractMojo

com.github.ug_dbg.NpmMojo

All Implemented Interfaces:

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

@Mojo(name="exec",
      threadSafe=true,
      defaultPhase=COMPILE)
public class NpmMojo
extends AbstractMojo

Goal which executes npm.

Field Summary

Fields

Modifier and Type	Field and Description
private String[]	args The arguments to pass to npm command.
private String	command The npm command to execute, such as 'install', 'test', etc.
private File	npmHome The directory that contains npm executable.
private File	workingDir The working directory.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
NpmMojo()

Method Summary

Modifier and Type	Method and Description
private org.apache.commons.exec.CommandLine	addArguments(org.apache.commons.exec.CommandLine cmdLine)
private org.apache.commons.exec.CommandLine	addCommand(org.apache.commons.exec.CommandLine cmdLine)
void	execute()
private void	execute(org.apache.commons.exec.CommandLine cmdLine)
protected static void	execute(org.apache.commons.exec.CommandLine cmdLine, File workingDir, boolean useLogHandler, org.apache.maven.plugin.logging.Log log, Level level)
private org.apache.commons.exec.CommandLine	getNpmCommand()

Methods inherited from class com.github.ug_dbg.AbstractMojo

getCommand, isWindows, logLevel, parseArgument, useLogHandler

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

command

@Parameter(property="npm.command")
private String command

The npm command to execute, such as 'install', 'test', etc. Required.

args

@Parameter(property="npm.args")
private String[] args

The arguments to pass to npm command. Optional.

workingDir

@Parameter(property="npm.workingDir",
           defaultValue="${basedir}")
private File workingDir

The working directory. Optional. If not specified, basedir will be used.

npmHome

@Parameter(property="npm.home")
private File npmHome

The directory that contains npm executable. Optional. If not specified, we will assume that npm is in the system path.

Constructor Detail

NpmMojo

public NpmMojo()

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

execute

private void execute(org.apache.commons.exec.CommandLine cmdLine)
              throws org.apache.maven.plugin.MojoFailureException,
                     org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

execute

protected static void execute(org.apache.commons.exec.CommandLine cmdLine,
                              File workingDir,
                              boolean useLogHandler,
                              org.apache.maven.plugin.logging.Log log,
                              Level level)
                       throws org.apache.maven.plugin.MojoFailureException,
                              org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

addCommand

private org.apache.commons.exec.CommandLine addCommand(org.apache.commons.exec.CommandLine cmdLine)

addArguments

private org.apache.commons.exec.CommandLine addArguments(org.apache.commons.exec.CommandLine cmdLine)

getNpmCommand

private org.apache.commons.exec.CommandLine getNpmCommand()