This linter plugin for Linter provides an interface to eslint. It will be used with files that have the "JavaScript" syntax.

apm install linter-eslint

linter-eslint will look for a version of eslint local to your project and use it if it's available. If none is found it will fall back to the version it ships with.

Lets say you depend on a specific version of eslint, maybe it has unreleased features, maybe it's just newer than what linter-eslint ships with. If your-project/node_modules/eslint exists linter-eslint will be used. This package requires an eslint of at least v1.0.0.

Note that if you do not have the linter package installed it will be installed for you. If you are using an alternative linter-* consumer feel free to disable the linter package.

You have two options:

• Install locally to your project eslint and the plugin

  • $ npm i --save-dev eslint [eslint-plugins]

• Install globaly eslint and plugins

  • $ npm i -g eslint [eslint-plugins]
  • Activate Use Global Eslint package option
  • (Optional) Set Global Node Path with $ npm config get prefix

Note that recent versions of ESLint do not use any rules by-default. This means you have to specify a configuration file for your project! To do this in a straightforward way run this:

eslint --init

Alternatively you can create the .eslintrc file by yourself. It is a good idea to have a look at the Get Started With ESLint blog post by IanVS and the ESLint documentation, including the list of rules.

If you would like to contribute enhancements or fixes, please do the following:

0. Fork the plugin repository
1. Hack on a separate topic branch created from the latest master
2. Commit and push the topic branch
3. Make a pull request
4. Welcome to the club!

Please note that modifications should follow these coding guidelines:

• Indent is 2 spaces
• Code should pass the eslint linter with the provided .eslintrc
• Vertical whitespace helps readability, don’t be afraid to use it

Thank you for helping out!