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 268K
  • Win 126K
  • OS X 96K
  • Linux 46K
Jul 23 Jul 22 Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6 Jul 5 Jul 4 Jul 3 Jul 2 Jul 1 Jun 30 Jun 29 Jun 28 Jun 27 Jun 26 Jun 25 Jun 24 Jun 23 Jun 22 Jun 21 Jun 20 Jun 19 Jun 18 Jun 17 Jun 16 Jun 15 Jun 14 Jun 13 Jun 12 Jun 11 Jun 10 Jun 9 Jun 8
Windows 83 89 129 129 152 147 145 83 84 123 142 154 161 124 92 83 123 173 151 130 136 86 87 125 144 131 139 144 72 84 127 138 162 143 113 78 82 125 148 154 153 144 77 90 132 152
OS X 46 38 63 82 72 53 65 36 46 70 66 65 91 66 46 58 80 67 83 87 70 56 39 64 82 78 96 82 35 32 78 66 76 91 83 31 49 70 84 92 92 70 40 36 64 74
Linux 14 24 27 34 38 46 30 25 25 34 44 25 41 35 23 24 42 33 36 43 38 19 36 27 45 38 36 33 30 20 29 39 40 57 25 18 23 40 43 23 45 34 39 29 39 55

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-jshint

Build Status

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!