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

Sublime​Linter-gjslint

by SublimeLinter ST3

SublimeLinter plugin for JavaScript, using gjslint.

Details

Installs

  • Total 18K
  • Win 8K
  • OS X 6K
  • Linux 3K
Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9 Dec 8 Dec 7 Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31
Windows 2 0 7 3 3 2 1 3 3 5 2 4 2 4 2 5 3 3 2 1 1 1 4 5 2 6 1 3 4 4 5 2 2 3 3 5 1 6 4 7 1 2 8 3 2 2
OS X 1 3 4 2 0 2 1 4 4 2 2 2 1 1 6 6 4 3 3 0 0 0 1 2 2 5 0 2 1 5 0 4 1 0 3 2 2 2 5 2 3 0 3 4 2 3
Linux 1 0 0 0 2 0 2 0 2 2 2 2 0 0 2 1 0 1 0 0 1 0 0 2 4 3 2 0 0 1 4 1 2 0 0 3 3 0 0 1 1 1 0 0 5 1

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-gjslint

Build Status

This linter plugin for SublimeLinter provides an interface to gjslint. 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 gjslint is installed on your system. To install gjslint, do the following:

  1. Install Python.

  2. Install gjslint by following the installation instructions.

Linter configuration

In order for gjslint 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 gjslint is installed and configured, you can proceed to install the SublimeLinter-gjslint 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 gjslint. Among the entries you should see SublimeLinter-gjslint. 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 gjslint options in the package settings or in a .gjslintrc file (The linter plugin will search for a config file with that name in your project path or ancestors). This is an example of a .gjslintrc file:

--exclude_directories=reports,node_modules
  --exclude_files=Gruntfile.js
  --max_line_length=120
  --disable=5,240
  --custom_jsdoc_tags=namespace,version

For Closure Linter error codes, please see the source code.

In addition to the standard SublimeLinter settings, SublimeLinter-gjslint provides its own settings. Those marked as “Inline Setting” or “Inline Override” may also be used inline.

Setting Description Inline Setting Inline Override
jslint_error A comma-separated list of specific lint errors to check
disable A comma-separated list of error codes to ignore
max_line_length The maximum allowed line length. null allows any length.

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!