SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.
Before using this plugin, you must ensure that
eslint is installed on your system. To install
eslint, do the following:
eslintglobally by typing the following in a terminal:
npm install -g eslint
eslintlocally in your project folder:
npm install eslint
If you are using
zsh, ensure that the line to load
If you are using
oh-my-zsh, do not load the
eslint is installed, you must ensure it is in your system PATH so that SublimeLinter can find it. This may not be as straightforward as you think, so please read about how linter executables are located in the documentation.
Once you have installed
eslint you can proceed to install the SublimeLinter-eslint plugin if it is not yet installed.
Note: This plugin requires
eslint 0.20.0 or later.
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:
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.
When the plugin list appears, type
eslint. Among the entries you should see
SublimeLinter-contrib-eslint. If that entry is not highlighted, use the keyboard or mouse to select it.
You can configure
eslint options in the way you would from the command line, with
.eslintrc files. For more information, see the eslint docs.
If you would like to contribute enhancements or fixes, please do the following:
- Fork the plugin repository.
- Hack on a separate topic branch created from the latest
- Commit and push the topic branch.
- Make a pull request.
- 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.
- Please use descriptive variable names, no abbrevations unless they are very well known.
Thank you for helping out!