SublimeLinter-eslint
This linter plugin for SublimeLinter provides an interface to ESLint. 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
is installed on your system. To install eslint
, do the following:
-
Install
eslint
globally by typing the following in a terminal:npm install -g eslint
Or install eslint
locally in your project folder (you must have package.json file there):
npm init -f npm install eslint
Reopen your project next (or restart ST) to make sure local eslint
will be used.
-
If you are using
nvm
andzsh
, ensure that the line to loadnvm
is in.zprofile
and not.zshrc
. -
If you are using
zsh
andoh-my-zsh
, do not load thenvm
plugin foroh-my-zsh
.
Once 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.
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:
-
Within Sublime Text, bring up the Command Palette and type
install
. Among the commands you should seePackage 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 seeSublimeLinter-contrib-eslint
. 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
eslint
.
I've got 'SublimeLinter: ERROR: eslint cannot locate 'eslint' in ST console when I try to use locally installed You must have package.json
file if install eslint
locally. Also, restart project or ST itself after to make sure SublimeLinter uses correct eslint
instance.
npm init -f
npm install eslint
Plugin still does not work or there are errors in ST console.
Update eslint
instance, probably you use outdated version and SublimeLinter does not check it properly sometimes.
.eslintignore
settings.
I want plugin to use my It does it now.
.eslintrc
file in project folder (for ESLint <1.0.0).
I want not to lint files if there is no Use --reset
ESLint option, add it to your SublimeLinter global settings or project .sublimelinterrc
file as below. Add --no-reset
option to project .sublimelinterrc
to overwrite it back.
{
"linters": {
"eslint": {
"args": [
"--reset"
]
}
}
}
.eslintrc
config.
I want to use global Plugin uses the same configuration hierarchy as eslint
itself, so add .eslintrc
to your home directory or ancestor directory of project.
.eslintignore
file, etc.
I want to use custom rules, global You can specify any CLI options of eslint
with args
key in SublimeLinter configs.
{
"linters": {
"eslint": {
"args": [
"--ignore-path", "~/eslint_ignore",
"--rulesdir", "~/rules"
]
}
}
}
context.getFilename()
in rule returns relative path.
It is a drawback of supporting .eslintignore
settings. Add to your SublimeLinter settings:
{
"linters": {
"eslint": {
"args": [
"--stdin-filename", "@"
]
}
}
}
SublimeLinter-contrib-eslint
package to install in Package Control packages list.
There is no Check if you already have it installed, please.
Contributing
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
master
. - 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!