Skip to content

Latest commit

 

History

History
82 lines (56 loc) · 4.7 KB

README.md

File metadata and controls

82 lines (56 loc) · 4.7 KB
Raw

SublimeLinter-contrib-eslint_d

Build Status

This linter plugin for SublimeLinter provides an interface to eslint_d. It will be used with files that have the “JavaScript” syntax.

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

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

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

    npm install -g eslint_d

    Or install eslint_d locally in your project folder (you must have package.json file there): npm init -f npm install eslint_d

  3. If you are using nvm and zsh, ensure that the line to load nvm is in .zshenv and not .zshrc.

  4. If you are using zsh and oh-my-zsh, do not load the nvm plugin for oh-my-zsh.

Note: This plugin requires eslint_d 2.3.1 or later.

Linter configuration

In order for eslint_d 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 you have installed and configured eslint_d, you can proceed to install the SublimeLinter-contrib-eslint_d 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 eslint_d. Among the entries you should see SublimeLinter-contrib-eslint_d. 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 eslint options in the way you would from the command line, with .eslintrc files. For more information, see the eslint docs.

FAQ and Troubleshooting

This plugin is almost similar to SublimeLinter-contrib-eslint, so you can use its documentation, just replace eslint with eslint_d.

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 modifications 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.
  • Please use descriptive variable names, no abbreviations unless they are very well known.

Thank you for helping out!