jslint.vim

Vim plugin and command line tool for running JSLint.

JSLint is a handy tool that spots errors and common mistakes in JavaScript code.

The source code for jslint.vim is hosted at http://github.com/hallettj/jslint.vim.

This is alpha software and is under heavy development.

Installation

Make sure you have a JavaScript interpreter installed. In Ubuntu you can install the Spidermonkey shell with this command:
```
  $ sudo apt-get install spidermonkey-bin
```
Latest Ubuntu versions don't have spidermonkey in the default repositories. You can use rhino instead:
```
  $ sudo apt-get install rhino
```
On Windows you can use cscript.exe - which is probably already installed.

On MacOS X you don't need to install any JavaScript interpreter cause it automatically uses it's JavaScriptCore engine.
If you have rake installed, run:
```
  $ rake install
```
Otherwise copy the directory ftplugin/ into your Vim ftplugin directory. Usually this is ~/.vim/ftplugin/. On Windows it is ~/vimfiles/ftplugin/.

Usage

This plugin automatically checks the JavaScript source and highlights the lines with errors.

It also will display more information about the error in the commandline if the curser is in the same line.
You also can call it manually via ':JSLintUpdate'
(optional) Add any valid JSLint options to ~/.jslintrc file, they will be used as global options for all JavaScript file. For example:
```
  /*jslint browser: true, regexp: true */
  /*global jQuery, $ */

  /* vim: set ft=javascript: */
```

To get a detailed report of any issues in your JavaScript file outside of Vim, run the bin/jslint executable in a terminal. For example:

$ bin/jslint ftplugin/jslint/fulljslint.js

You can copy bin/jslint into for PATH for easier access. The executable requires that the Vim plugin is installed and also requires Ruby.

To disable error highlighting altogether add this line to your ~/.vimrc file:

let g:JSLintHighlightErrorLine = 0

Alternative Plugins

There are other plugins for Vim that integrate JavaScript Lint. JavaScript Lint is another JavaScript checker that is similar to JSLint.

jsl.vim uses Vim's compiler infrastructure making its use consistent with syntax checkers for other languages.

javaScriptLint.vim runs the contents of a JavaScript file through JavaScript Lint after the file's buffer is saved and places any warnings in the quickfix error window.

Credits

Jesse Hallett -- original author
Nathan Smith -- Windows compatibility, quickfix integration, better OS X compatibility, and many other improvements
Travis Jeffery -- Easy plugin installation with rake
Sam Goldstein -- Display of problem report for the current line and bug fixes
Bryan Chow -- Fixes for formatting issues and typos
Jeff Buttars -- Options to remove and to disable error highlighting
Rainux Luo -- Support for reading JSLint options from a ~/.jslintrc file
Pascal Hartig -- Support for running jslint with rhino
Martin Schürrer -- Fixing path issues and error handling
Nik Graf -- Documentation updates

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The Software shall be used for Good, not Evil.