de.acosix.maven.jshint

Class JSHintMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

de.acosix.maven.jshint.JSHintMojo

All Implemented Interfaces:

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

@Mojo(name="jshint",
      defaultPhase=PROCESS_SOURCES)
public class JSHintMojo
extends org.apache.maven.plugin.AbstractMojo

This Mojo provides a goal to run a JSHint validation of JavaScript sources files in the current project during the "processSources" phase.

Author:

Axel Faust, Acosix GmbH

Field Summary

Fields

Modifier and Type	Field and Description
protected File	baseDirectory The base directory of the current project
protected String	checkstyleReportFile The path / name of the checkstyle XML report file to write if any JSHint errors / warnings have been found.
protected List<String>	excludes The files to explicitly exclude from JSHint validation - this will always override includes
protected boolean	failOnError Flag to specify if JSHint errors should fail the build
protected boolean	ignoreJSHintConfigFiles Flag to specify that any .jshintrc files found in the source directory should be ignored
protected boolean	ignoreJSHintIgnoreFiles Flag to specify that any .jshintignore files found in the source directory should be ignored
protected List<String>	includes The files to explicitly include in JSHint validation - defaults to all files within the source directory if not set
protected String	jsHintDefaultConfigFile The default JSHint config file to use for running JSHint validations.
protected String	jshintScript The path to the JSHint script to use - this path is resolved against the project base directory first and then the classpath of the plugin including any configured plugin dependencies.
protected String	jshintVersion The version of the embedded JSHint script to use.
protected File	outputDirectory The build output directory of the current project
protected boolean	preferRhino Flag to specify if Rhino should always be used even if Nashorn is available
protected boolean	skip Flag to specify execution of this mojo should be skipped
protected File	sourceDirectory The source directory to process

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

ROLE

Constructor Summary

Constructors

Constructor and Description
JSHintMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
protected String	loadDefaultJSHintConfig()
protected List<String>	loadExcludesFromJSHintIgnores()
protected List<String>	lookupJavaScriptFilesToInclude()
void	setBaseDirectory(File baseDirectory)
void	setBaseDirectory(String baseDirectory)
void	setCheckstyleReportFile(String checkstyleReportFile)
void	setExcludes(List<String> excludes)
void	setFailOnError(boolean failOnError)
void	setIgnoreJSHintConfigFiles(boolean ignoreJSHintConfigFiles)
void	setIgnoreJSHintIgnoreFiles(boolean ignoreJSHintIgnoreFiles)
void	setIncludes(List<String> includes)
void	setJsHintDefaultConfigFile(String jsHintDefaultConfigFile)
void	setJshintScript(String jshintScript)
void	setJshintVersion(String jshintVersion)
void	setPreferRhino(boolean preferRhino)
void	setSkip(boolean skip)
void	setSourceDirectory(File sourceDirectory)
void	setSourceDirectory(String sourceDirectory)
protected void	writeReports(Map<String,List<Error>> errorsByFile)

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

baseDirectory

@Parameter(defaultValue="${project.basedir}",
           property="baseDirectory",
           required=true,
           readonly=true)
protected File baseDirectory

The base directory of the current project

outputDirectory

@Parameter(defaultValue="${project.build.directory}",
           property="outputDirectory",
           required=true,
           readonly=true)
protected File outputDirectory

The build output directory of the current project

sourceDirectory

@Parameter(defaultValue="${project.basedir}/src/main",
           property="sourceDirectory",
           required=true)
protected File sourceDirectory

The source directory to process

jsHintDefaultConfigFile

@Parameter(defaultValue=".jshintrc",
           property="jsHintDefaultConfigFile",
           required=true)
protected String jsHintDefaultConfigFile

The default JSHint config file to use for running JSHint validations. When ignoreJSHintConfigFiles is set to false this may be overriden by .jshintrc files found in the sourceDirectory. This can be a path that will be resolved first against the baseDirectory of the current project, falling back on classpath resolution against classpath of the plugin and its configured dependency.

includes

@Parameter(property="includes",
           required=false)
protected List<String> includes

The files to explicitly include in JSHint validation - defaults to all files within the source directory if not set

excludes

@Parameter(property="excludes",
           required=false)
protected List<String> excludes

The files to explicitly exclude from JSHint validation - this will always override includes

failOnError

@Parameter(property="failOnError",
           required=false)
protected boolean failOnError

Flag to specify if JSHint errors should fail the build

preferRhino

@Parameter(property="preferRhino",
           required=false)
protected boolean preferRhino

Flag to specify if Rhino should always be used even if Nashorn is available

ignoreJSHintIgnoreFiles

@Parameter(property="ignoreJSHintIgnoreFiles",
           required=false)
protected boolean ignoreJSHintIgnoreFiles

Flag to specify that any .jshintignore files found in the source directory should be ignored

ignoreJSHintConfigFiles

@Parameter(property="ignoreJSHintConfigFiles",
           required=false)
protected boolean ignoreJSHintConfigFiles

Flag to specify that any .jshintrc files found in the source directory should be ignored

jshintVersion

@Parameter(defaultValue="2.9.3",
           property="jshintVersion",
           required=true)
protected String jshintVersion

The version of the embedded JSHint script to use. This setting is ignored if jshintScript is set.

jshintScript

@Parameter(property="jshintScript",
           required=false)
protected String jshintScript

The path to the JSHint script to use - this path is resolved against the project base directory first and then the classpath of the plugin including any configured plugin dependencies. This overrides the jshintVersion setting.

checkstyleReportFile

@Parameter(property="checkstyleReportFile",
           required=false)
protected String checkstyleReportFile

The path / name of the checkstyle XML report file to write if any JSHint errors / warnings have been found. This path is relative to the project's build directory.

skip

@Parameter(property="skip",
           required=false)
protected boolean skip

Flag to specify execution of this mojo should be skipped

Constructor Detail

JSHintMojo

public JSHintMojo()

Method Detail

setBaseDirectory

public void setBaseDirectory(String baseDirectory)

Parameters:

baseDirectory - the baseDirectory to set

setBaseDirectory

public void setBaseDirectory(File baseDirectory)

Parameters:

baseDirectory - the baseDirectory to set

setSourceDirectory

public void setSourceDirectory(String sourceDirectory)

Parameters:

sourceDirectory - the sourceDirectory to set

setSourceDirectory

public void setSourceDirectory(File sourceDirectory)

Parameters:

sourceDirectory - the sourceDirectory to set

setJsHintDefaultConfigFile

public void setJsHintDefaultConfigFile(String jsHintDefaultConfigFile)

Parameters:

jsHintDefaultConfigFile - the jsHintDefaultConfigFile to set

setIncludes

public void setIncludes(List<String> includes)

Parameters:

includes - the includes to set

setExcludes

public void setExcludes(List<String> excludes)

Parameters:

excludes - the excludes to set

setFailOnError

public void setFailOnError(boolean failOnError)

Parameters:

failOnError - the failOnError to set

setPreferRhino

public void setPreferRhino(boolean preferRhino)

Parameters:

preferRhino - the preferRhino to set

setIgnoreJSHintIgnoreFiles

public void setIgnoreJSHintIgnoreFiles(boolean ignoreJSHintIgnoreFiles)

Parameters:

ignoreJSHintIgnoreFiles - the ignoreJSHintIgnoreFiles to set

setIgnoreJSHintConfigFiles

public void setIgnoreJSHintConfigFiles(boolean ignoreJSHintConfigFiles)

Parameters:

ignoreJSHintConfigFiles - the ignoreJSHintConfigFiles to set

setJshintVersion

public void setJshintVersion(String jshintVersion)

Parameters:

jshintVersion - the jshintVersion to set

setJshintScript

public void setJshintScript(String jshintScript)

Parameters:

jshintScript - the jshintScript to set

setCheckstyleReportFile

public void setCheckstyleReportFile(String checkstyleReportFile)

Parameters:

checkstyleReportFile - the checkstyleReportFile to set

setSkip

public void setSkip(boolean skip)

Parameters:

skip - the skip to set

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

writeReports

protected void writeReports(Map<String,List<Error>> errorsByFile)

loadDefaultJSHintConfig

protected String loadDefaultJSHintConfig()

lookupJavaScriptFilesToInclude

protected List<String> lookupJavaScriptFilesToInclude()

loadExcludesFromJSHintIgnores

protected List<String> loadExcludesFromJSHintIgnores()