de.acosix.maven.jshint

Class AbstractJSHinter

java.lang.Object

de.acosix.maven.jshint.AbstractJSHinter

All Implemented Interfaces:

JSHinter

Direct Known Subclasses:

NashornJSHinter, RhinoJSHinter

public abstract class AbstractJSHinter
extends Object
implements JSHinter

Author:

Axel Faust, Acosix GmbH

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<File,String>	effectiveJSHintConfig
protected org.apache.maven.plugin.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
AbstractJSHinter(org.apache.maven.plugin.logging.Log log)

Method Summary

Modifier and Type	Method and Description
List<Error>	executeJSHint(File baseDirectory, String path, String defaultJSHintConfigContent, boolean ignoreJSConfigFileOnPaths) Executes JSHint validation on a single script file
protected abstract List<Error>	executeJSHintImpl(File baseDirectory, String path, String defaultJSHintConfigContent)
protected String	lookupCustomJSHintConfig(File baseDirectory, String path)
protected String	readSource(File contentFile)
protected List<String>	readSourceLines(File baseDirectory, String path)
protected void	reportErrors(List<Error> errors)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.maven.plugin.logging.Log log

effectiveJSHintConfig

protected Map<File,String> effectiveJSHintConfig

Constructor Detail

AbstractJSHinter

public AbstractJSHinter(org.apache.maven.plugin.logging.Log log)

Method Detail

executeJSHint

public List<Error> executeJSHint(File baseDirectory,
                                 String path,
                                 String defaultJSHintConfigContent,
                                 boolean ignoreJSConfigFileOnPaths)

Executes JSHint validation on a single script file

Specified by:

executeJSHint in interface JSHinter

Parameters:

baseDirectory - the base directory that contains the script file

path - the path relative to the base directory that denotes the script file

defaultJSHintConfigContent - the default JSHint configuration in JSON format

ignoreJSConfigFileOnPaths - true if .jshintrc files found on the path should be ignored, false otherwise

Returns:

the errors found during validation

executeJSHintImpl

protected abstract List<Error> executeJSHintImpl(File baseDirectory,
                                                 String path,
                                                 String defaultJSHintConfigContent)

readSourceLines

protected List<String> readSourceLines(File baseDirectory,
                                       String path)

lookupCustomJSHintConfig

protected String lookupCustomJSHintConfig(File baseDirectory,
                                          String path)

readSource

protected String readSource(File contentFile)

reportErrors

protected void reportErrors(List<Error> errors)