Skip to content

Latest commit

 

History

History
128 lines (92 loc) · 5.82 KB

README.md

File metadata and controls

128 lines (92 loc) · 5.82 KB
Raw

JSHint Gutter for Sublime Text 2 and 3 via node.js

Sublime Text 3

JSHint

Node.js download

About

This is a Sublime Text 2 and 3 plugin allowing you to check your JavaScript code for nasty errors, coding conventions and other goodies. It relies on JSHint, a fork of JSLint (developed by Douglas Crockford). The linter is itself written in JavaScript, so you'll need something (node.js) to interpret JavaScript code outside the browser.

Screenshot

Installation

First of all, be sure you have node.js installed in order to run JSHint (a derivative work of JSLint, used to detect errors and potential problems in JS). Each OS has a different Packages folder required by Sublime Text. Open it via Preferences -> Browse Packages, and copy this repository contents to a new Sublime-JSHint folder there.

The shorter way of doing this is:

Through Sublime Package Manager

  • Ctrl+Shift+P or Cmd+Shift+P in Linux/Windows/OS X
  • type install, select Package Control: Install Package
  • type js gutter, select JSHint Gutter

Manually

Make sure you use the right Sublime Text folder. For example, on OS X, packages for version 2 are in ~/Library/Application\ Support/Sublime\ Text\ 2, while version 3 is labeled ~/Library/Application\ Support/Sublime\ Text\ 3.

These are for Sublime Text 3:

Mac

git clone https://github.com/victorporof/Sublime-JSHint.git ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/Sublime-JSHint

Linux

git clone https://github.com/victorporof/Sublime-JSHint.git ~/.config/sublime-text-3/Packages/Sublime-JSHint

Windows

git clone https://github.com/victorporof/Sublime-JSHint.git %APPDATA%/Sublime\ Text\ 3/Packages/Sublime-JSHint

Usage

Tools -> Command Palette (Ctrl+Shift+P or Cmd+Shift+P) and type jshint.

-- or --

Ctrl+Shift+J (or Cmd+Shift+J if you're on a Mac).

-- or --

Right click in the current buffer and select JSHint -> Lint Code.

-- or --

Open a JavaScript file, pop out the console in Sublime Text from View -> Show Console, and type view.run_command("jshint").

Writing commands in the console is ugly. Set up your own key combo for this, by going to Preferences -> Key Bindings - User, and adding a command in that array: { "keys": ["super+shift+j"], "command": "jshint" }. You can use any other command you want, thought most of them are already taken.

Oh noez, command not found!

If you get an error sh: node: command not found or similar, you don't have node in the right path. Try setting the absolute path to node in JSHint.sublime-settings.

  • Ctrl+Shift+P or Cmd+Shift+P in Linux/Windows/OS X
  • type jshint, select Set node Path

This means from: "node_path": "/usr/local/bin/node" change to "node_path": "/your/absolute/path/to/node"

Simply using node without specifying a path sometimes doesn't work :(

For example, on Linux the path could be in /home/<user>/.nvm/<node version>/bin/node.

On Windows, the absolute path to node.exe must use forward slashes.

Be very careful on Linux!

Depending on your distribution and default package sources, apt-get install node (for example) will not install node.js, contrary to all human common sense and popular belief. You want nodejs instead. Best thing is to make it yourself from http://nodejs.org/#download.

Automatically linting on edit or save

This plugin can be set to automatically lint when a file is saved or the current buffer is modified.

  • Ctrl+Shift+P or Cmd+Shift+P in Linux/Windows/OS X
  • type jshint, select Set Plugin Options

Note that live linting while editing is only available in Sublime Text 3.

Using your own .jshintrc options

The plugin looks for a .jshintrc file in the same directory as the source file you're linting and, or one located recursively up one directory, all the way until the filesystem root. As well, it uses those options along the default ones. Here's an example of how it can look like.

These are the default options used by this plugin:

{
  // Details: https://github.com/victorporof/Sublime-JSHint#using-your-own-jshintrc-options
  // Example: https://github.com/jshint/jshint/blob/master/examples/.jshintrc
  // Documentation: http://www.jshint.com/docs/
  "browser": true,
  "esnext": true,
  "globals": {},
  "globalstrict": true,
  "quotmark": true,
  "smarttabs": true,
  "trailing": true,
  "undef": true,
  "unused": true
}

And here's how a .jshintrc file in your home folder could look like:

{
  "esnext": false,
  "moz": true,
  "boss": true,
  "node": true,
  "validthis": true,
  "globals": {
    "EventEmitter": true,
    "Promise": true
  }
}

See the documentation at jshint.com and a few examples here.

Alternative for NPM packages

Alternatively for an NPM package, you can omit the .jshintrc file and instead place your jshint options in your package.json file as the property jshintConfig1. Check an example here.

A few persistent options are always applied from a .jshintrc file located in the same directory as the plugin, if not overwritten by your own .jshintrc file. Those are defined here. You can safely add stuff to that json file if you want:

  • Ctrl+Shift+P or Cmd+Shift+P in Linux/Windows/OS X
  • type jshint, select Set Linting Preferences

Thank you!