SublimeLinter-contrib-jslint

This linter plugin for SublimeLinter provides an interface to JSLint. It will be used with files that have the “JavaScript” syntax.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before using this plugin, you must ensure that the jslint npm package is installed on your system.

To install jslint, do the following:

1. Install Node.js (and npm on Linux).

2. Install the jslint npm package by typing the following in a terminal:

   npm install -g jslint
   

   You may also specify the exact version of the package to be installed like this:

   npm install -g jslint@0.3.1
   

3. If you are using nvm and zsh, ensure that the line to load nvm is in .zshenv and not .zshrc.

4. If you are using zsh and oh-my-zsh, do not load the nvm plugin for oh-my-zsh.

Linter configuration

In order for jslint to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.

Once you have installed and configured jslint, you can proceed to install the SublimeLinter-contrib-jslint plugin if it is not yet installed.

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.

To install via Package Control, do the following:

1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

2. When the plugin list appears, type jslint. Among the entries you should see SublimeLinter-contrib-jslint. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

Linter Settings can be of use when you want to control the default behaviour of jslint globally for all files. The args linter setting can be used to specify options that will be passed to jslint on every run. For example, if you want to increase the maximum number of errors jslint will process from the default 50 to 100, you can add "args": "--maxerr=100" to the jslint section in SublimeLinter User settings. To list all supported options, run jslint without options from a command prompt. You may want to refer to the readme for the jslint npm package, and to the description of JSLint options.

Please note that options can also be specified

• in a file called .jslintrc written in JSON format, specifying options as key-value pairs (refer to description of JSLint options for specifics on valid keys and values)
  • globally, by placing the file in the user's home directory
  • for directories or hierarchies of directories (please refer to SublimeLinter's documentation for the config_file attribute to understand where SublimeLinter will search for .jslintrc)
• by inline JSLint directives in the JavaScript files to be linted.

Contributing

If you would like to contribute enhancements or fixes, please do the following:

1. Fork the plugin repository.
2. Hack on a separate topic branch created from the latest master.
3. Commit and push the topic branch.
4. Make a pull request.
5. Be patient. ;-)

Please note that modications should follow these coding guidelines:

• Indent is 4 spaces.
• Code should pass flake8 and pep257 linters.
• Vertical whitespace helps readability, don’t be afraid to use it.
• Please use descriptive variable names, no abbrevations unless they are very well known.

Thank you for helping out!