/ 
JavaScript-JSLint-0.07
River stage zero No dependents
/ JavaScript::JSLint

NAME

JavaScript::JSLint - Check JavaScript code for problems

SYNOPSIS

use JavaScript::JSLint;

my @errors = jslint( $javascript, white => 1 );
foreach my $err (@errors) {
  print "$err->{reason} at line $err->{line}\n";
}

DESCRIPTION

JavaScript::JSLint is a tool for checking for common problems in JavaScript code. It's based on Douglas Crockford's jslint. Full documentation on the conditions that it detects is at http://jslint.com/lint.html.

You may be more interested in the command line interface, jslint.

EXPORT

jslint()

This takes one mandatory parameter: a string containing JavaScript code. It returns a list of errors. If there are no problems, an empty list will be returned. Each error is a hash reference containing these keys:

id

The category of error.

line

The line number of the error.

character

The character on the line where the error occurs.

reason

Descriptive text of the error.

evidence

A copy of the line of code that produced the error.

In addition to pure JavaScript, you can also pass in a piece of HTML code. This will be parsed and any JavaScript found within will be checked in the usual manner. The HTML code must be a full web page, i.e. start with <html>.

You can optionally pass in a second parameter to influence how JSLint works. The following keys are used. Most take a boolean value, which is false by default.

adsafe

true, if ADsafe rules should be enforced

bitwise

true, if bitwise operators should be allowed

browser

true, if the standard browser globals should be predefined

confusion

true, if types can be used inconsistently

continue

true, if the continuation statement should be tolerated

debug

true, if debugger statements should be allowed

devel

true, if logging should be allowed (console, alert, etc.)

eqeq

true, if == should be allowed

es5

true, if ES5 syntax should be allowed

evil

true, if eval should be allowed

forin

true, if for in statements need not filter

fragment

true, if HTML fragments should be allowed

indent

the indentation factor

maxerr

the maximum number of errors to allow

maxlen

the maximum length of a source line

newcap

true, if constructor names capitalization is ignored

node

true, if Node.js globals should be predefined

nomen

true, if names may have dangling _

on

true, if HTML event handlers should be allowed

passfail

true, if the scan should stop on first error

plusplus

true, if increment/decrement should be allowed

properties

true, if all property names must be declared with /*properties*/

predef

predefine variables as globals. A reference to either an array or a hash. If an arrayref, the elements of the array should be the names of the variables to be predefined. If a hashref, the keys are the variable names to be defined and the values indicate whether a variable is assignable (1) or not (0).

regexp

true, if . and [^...] should be allowed in regexp literals

rhino

true, if the Rhino environment globals should be predefined

undef

true, if variables can be declared out of order

unparam

true, if unused parameters should be tolerated

safe

true, if use of some browser features should be restricted

sloppy

true, if the \'use strict\'; pragma is optional

sub

true, if all forms of subscript notation are tolerated

vars

true, if multiple var statements per function should be allowed

white

true, if sloppy whitespace is tolerated

widget

true, if the Yahoo Widgets globals should be predefined

windows

true, if MS Windows-specific globals should be predefined

jslint_options ( )

Returns a hash of options and their descriptions. Each key is a valid option to pass in to jslint().

SEE ALSO

http://jslint.com/ for the original version that this is based upon.

JavaScript for more details on the Perl / JavaScript bridge.

jslint for the command line interface.

http://www.javascriptlint.com/ is an alternative implementation of a JavaScript lint tool.

AUTHOR

Dominic Mitchell, <cpan (at) happygiraffe.net>

Steve Webster, <cpan (at) statichtml.com>

COPYRIGHT AND LICENSE

Copyright (C) 2006 by Dominic Mitchell

Portions copyright (C) 2011 by Steve Webster

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

JSLint is originally Copyright (C) 2002 Douglas Crockford.