ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Sublime​Linter-jshint

by SublimeLinter ST3 Top 100

SublimeLinter plugin for JavaScript, using jshint.

Details

Installs

  • Total 246K
  • Win 114K
  • OS X 89K
  • Linux 42K
Mar 25 Mar 24 Mar 23 Mar 22 Mar 21 Mar 20 Mar 19 Mar 18 Mar 17 Mar 16 Mar 15 Mar 14 Mar 13 Mar 12 Mar 11 Mar 10 Mar 9 Mar 8 Mar 7 Mar 6 Mar 5 Mar 4 Mar 3 Mar 2 Mar 1 Feb 28 Feb 27 Feb 26 Feb 25 Feb 24 Feb 23 Feb 22 Feb 21 Feb 20 Feb 19 Feb 18 Feb 17 Feb 16 Feb 15 Feb 14 Feb 13 Feb 12 Feb 11 Feb 10 Feb 9 Feb 8
Windows 102 182 182 176 203 189 97 132 192 188 166 197 170 96 141 191 172 169 201 185 138 114 164 207 188 177 180 88 114 173 189 204 204 177 112 126 178 190 194 164 199 99 125 143 161 191
OS X 47 100 103 101 84 97 42 56 82 101 93 128 85 56 61 82 103 100 89 90 53 54 69 103 107 94 92 68 69 90 94 74 89 85 51 53 87 98 86 90 89 55 55 79 98 89
Linux 29 33 60 55 44 31 28 26 53 52 49 56 44 29 26 39 54 44 42 37 35 31 51 55 47 45 49 25 29 55 48 58 53 49 32 33 43 46 58 45 47 48 21 48 44 68

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-jshint

This linter plugin for SublimeLinter provides an interface to jshint. It will be used with files that have the “JavaScript” syntax, or within <script> tags in HTML files.

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 installing this plugin, you must ensure that jshint is installed on your system. To install jshint, do the following:

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

  2. Install jshint by typing the following in a terminal:

npm install -g jshint
  1. If you are using nvm and zsh, ensure that the line to load nvm is in .zshenv or .zprofile and not .zshrc.(reason: here and here)

Note: This plugin requires jshint 2.5.0 or later. Please note that the indent option no longer reports warnings for bad indentation. https://github.com/jshint/jshint/releases/tag/2.5.0

Linter configuration

In order for jshint 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 jshint is installed and configured, you can proceed to install the SublimeLinter-jshint 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 jshint. Among the entries you should see SublimeLinter-jshint. 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.

You can configure jshint options in the way you would from the command line, with .jshintrc files. For more information, see the jshint docs. The linter plugin does this by searching for a .jshintrc file itself, just as jshint does from the command line. You may provide a custom config file by setting the linter’s "args" setting to ["--config", "/path/to/file"]. On Windows, be sure to double the backslashes in the path, for example ["--config", "C:\\Users\\Aparajita\\jshint.conf"].

The path to the .jshintrc file is cached, meaning if you create a new .jshintrc that should have precedence over the previous one (meaning it is closer to the .js file) you need to clear the cache for the linter to use the new .jshintrc You can clear the cache by going to: Tools > SublimeLinter > Clear Caches.

Using with tabs

If you use tabs as your indentation, make sure you set the option indent: 1 in your .jshintrc file. If not the wrong sections of the code will be highlighted.

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.

Thank you for helping out!