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 233K
  • Win 107K
  • OS X 86K
  • Linux 40K
Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11 Jan 10 Jan 9 Jan 8 Jan 7 Jan 6 Jan 5 Jan 4 Jan 3 Jan 2 Jan 1 Dec 31 Dec 30 Dec 29 Dec 28 Dec 27 Dec 26 Dec 25 Dec 24 Dec 23 Dec 22 Dec 21 Dec 20 Dec 19 Dec 18 Dec 17 Dec 16 Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9
Windows 125 97 119 166 170 197 169 169 106 95 169 163 183 169 193 106 128 167 186 178 165 114 79 73 121 145 146 144 129 87 100 131 164 178 164 156 97 115 160 150 155 184 157 127 118 162
OS X 68 81 56 77 115 104 93 108 46 59 91 100 108 101 94 71 85 87 102 103 109 62 42 50 71 81 94 86 59 45 59 71 96 92 87 87 58 50 77 92 95 99 88 40 58 106
Linux 39 27 32 46 51 45 29 39 29 25 48 50 58 31 53 30 26 36 45 46 46 34 17 21 37 46 39 41 45 21 34 46 33 36 60 52 35 31 51 42 47 59 58 31 36 58

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 and not .zshrc.

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!