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. All take a boolean value, and each one is false by default.

bitwise: true if bitwise operators should not be allowed
browser: true if the standard browser globals should be predefined
cap: true if upper case HTML should be allowed
debug: true if debugger statements should be allowed
eqeqeq: true if === should be required
evil: true if eval should be allowed
laxbreak: true if line breaks should not be checked
nomen: true if names should be checked
passfail: true if the scan should stop on first error
plusplus: true if increment/decrement should not be allowed
rhino: true if the Rhino environment globals should be predefined
undef: true if undefined variables are errors
white: true if strict whitespace rules apply
widget: true if the Yahoo Widgets 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().

AUTHOR

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

COPYRIGHT AND LICENSE

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.