jstools:jslint

Goal to generate JavaScript coverage reports using JSLint

Mojo Attributes :

  • Requires a Maven 2.0 project to execute.
  • Automatically executes within the lifecycle phase: post-site

Required Parameters

Name Type Description
baseDir File Maven Internal : The base directory. Default is ${basedir}
buildDir String Maven Internal : The build directory. Default is ${project.build.directory}

Optional Parameters

Name Type Description
caseSensitive boolean Whether the file selection patterns should be case sensitive. Default is true.
excludes String The excluded files pattern. Default is empty.
helper MavenProjectHelper Maven Internal : A Project Helper instance.
includes String The include pattern used to select javascript files for processing. Default is all (recursive) files with a .js extention
jsDir String The path to the JavaScript source directory (appended to ${basedir}). Default is src/main/js
jslintInitJsFilePath String A path pointing to some custom JS code to drive JSLint via Rhino. You can provide your own, or let the plugin use its own internal version.
jslintJsFilePath String A path pointing to a full version of JSLint (e.g. /home/username/stuff/fulljslint.js). If no value is provided the plugin wil use its own internal version. You can find the file at http://www.jslint.com/fulljslint.js
outputBaseDirectory String The output directory.
reportJslintErrorsOnly boolean Wether to only include errors in the report. Default is true (errors only)
siteRenderer SiteRenderer Maven Internal : The Doxia Site Renderer.

Parameter Details

baseDir

Maven Internal : The base directory. Default is ${basedir}

  • Type : java.io.File
  • Required : Yes
  • Expression : ${basedir}

buildDir

Maven Internal : The build directory. Default is ${project.build.directory}

  • Type : java.lang.String
  • Required : Yes
  • Expression : ${project.build.directory}

caseSensitive

Whether the file selection patterns should be case sensitive. Default is true.

  • Type : boolean
  • Required : No
  • Expression : true

excludes

The excluded files pattern. Default is empty.

  • Type : java.lang.String
  • Required : No

helper

Maven Internal : A Project Helper instance.

  • Type : org.apache.maven.project.MavenProjectHelper
  • Required : No

includes

The include pattern used to select javascript files for processing. Default is all (recursive) files with a .js extention

  • Type : java.lang.String
  • Required : No

jsDir

The path to the JavaScript source directory (appended to ${basedir}). Default is src/main/js

  • Type : java.lang.String
  • Required : No
  • Expression : src/main/js

jslintInitJsFilePath

A path pointing to some custom JS code to drive JSLint via Rhino. You can provide your own, or let the plugin use its own internal version.

  • Type : java.lang.String
  • Required : No
  • Expression : ${project.build.directory}/jslint/fulljslint_init.js

jslintJsFilePath

A path pointing to a full version of JSLint (e.g. /home/username/stuff/fulljslint.js). If no value is provided the plugin wil use its own internal version. You can find the file at http://www.jslint.com/fulljslint.js

  • Type : java.lang.String
  • Required : No
  • Expression : ${project.build.directory}/jslint/fulljslint.js

outputBaseDirectory

The output directory.

  • Type : java.lang.String
  • Required : No
  • Expression : ${project.build.directory}/site/

reportJslintErrorsOnly

Wether to only include errors in the report. Default is true (errors only)

  • Type : boolean
  • Required : No
  • Expression : true

siteRenderer

Maven Internal : The Doxia Site Renderer.

  • Type : org.codehaus.doxia.site.renderer.SiteRenderer
  • Required : No