/eslint-plugin

ESLint plugin for intellij

Primary LanguageJavaMIT LicenseMIT

ESLint Plugin

ESLint is The pluggable linting utility for JavaScript. see more here.
ESLint plugin for WebStorm, PHPStorm and other Idea family IDE with Javascript plugin, provides integration with ESLint and shows errors and warnings inside the editor.

  • Support displaying eslint warnings as intellij inspections
  • Quick fixes for several rules
  • Support for custom eslint rules

Bundled plugin

As of Intellij 14, a plugin based on this one was bundled into the IDE release by Jetbrains. What's the diffrence? This plugin supports Intellij 13 and other versions, --fix option, quick fixes and other minor diffrances. Please make sure you are refferring to this one before opening an issue.

Getting started

Prerequisites

  • NodeJS
  • IntelliJ 13.1.4 / Webstorm 8.0.4, or above.

Install eslint npm package eslint npm:

$ cd <project path>
$ npm install eslint

Or, install eslint globally:

$ npm install -g eslint

Settings

To get started, you need to set the ESLint plugin settings:

  • Go to preferences, ESLint plugin page and check the Enable plugin.
  • Set the path to the nodejs interpreter bin file.
  • Select whether to let eslint search for .eslintrc file
  • Set the path to the eslint bin file. should point to <project path>node_modules/eslint/bin/eslint.js if you installed locally or /usr/local/bin/eslint if you installed globally.
    • For Windows: install eslint globally and point to the eslint cmd file like, e.g. C:\Users\<username>\AppData\Roaming\npm\eslint.cmd
  • Set the .eslintrc file, or eslint will use the default settings.
  • You can also set a path to a custom rules directory.
  • By default, eslint plugin annotate the editor with warning or error based on the eslint configuration, you can check the 'Treat all eslint issues as warnings' checkbox to display all issues from eslint as warnings.

Configuration:
ESLint config

Inspection:
ESLint inline

Analyze Code:
ESLint inline

A Note to contributors

ESLint plugin uses the code from here as a module, to run the project you need to clone that project as well.