JavaScript::JSLint - Check JavaScript code for problems
use JavaScript::JSLint; my @errors = jslint( $javascript, white => 1 ); foreach my $err (@errors) { print "$err->{reason} at line $err->{line}\n"; }
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.
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:
The category of error.
The line number of the error.
The character on the line where the error occurs.
Descriptive text of the error.
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>.
<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.
true, if ADsafe rules should be enforced
true, if bitwise operators should be allowed
true, if the standard browser globals should be predefined
true, if types can be used inconsistently
true, if the continuation statement should be tolerated
true, if debugger statements should be allowed
true, if logging should be allowed (console, alert, etc.)
true, if == should be allowed
==
true, if ES5 syntax should be allowed
true, if eval should be allowed
true, if for in statements need not filter
for in
true, if HTML fragments should be allowed
the indentation factor
the maximum number of errors to allow
the maximum length of a source line
true, if constructor names capitalization is ignored
true, if Node.js globals should be predefined
true, if names may have dangling _
_
true, if HTML event handlers should be allowed
true, if the scan should stop on first error
true, if increment/decrement should be allowed
true, if all property names must be declared with /*properties*/
/*properties*/
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).
1
0
true, if . and [^...] should be allowed in regexp literals
.
[^...]
true, if the Rhino environment globals should be predefined
true, if variables can be declared out of order
true, if unused parameters should be tolerated
true, if use of some browser features should be restricted
true, if the \'use strict\'; pragma is optional
true, if all forms of subscript notation are tolerated
true, if multiple var statements per function should be allowed
var
true, if sloppy whitespace is tolerated
true, if the Yahoo Widgets globals should be predefined
true, if MS Windows-specific globals should be predefined
Returns a hash of options and their descriptions. Each key is a valid option to pass in to jslint().
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.
Dominic Mitchell, <cpan (at) happygiraffe.net>
Steve Webster, <cpan (at) statichtml.com>
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:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
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.
To install JavaScript::JSLint, copy and paste the appropriate command in to your terminal.
cpanm
cpanm JavaScript::JSLint
CPAN shell
perl -MCPAN -e shell install JavaScript::JSLint
For more information on module installation, please visit the detailed CPAN module installation guide.