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

NAME

JavaScript::JSLint - Check JavaScript code for problems

SYNOPSIS

use JavaScript::JSLint;

my @errors = jslint( $javascript );
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. All take a boolean value, and each one is false by default.

browser

Predefine the standard browser global variables.

cap

Allow upper case HTML.

debug

Allow debugger statements.

evil

Allow use of eval.

jscript

Allow JScript deviations.

laxLineEnd

Don't check line breaks.

passfail

Stop on the first error.

plusplus

Disallow post-increment expressions.

undef

Report on variables that are undefined when they are first used.

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>

COPYRIGHT AND LICENSE

Copyright (C) 2006 by Dominic Mitchell

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.

1 POD Error

The following errors were encountered while parsing the POD:

Around line 172:

You forgot a '=back' before '=head1'