ESLint-plugin-React

React specific linting rules for ESLint

Installation

Install ESLint either locally or globally.

$ npm install eslint

If you installed ESLint globally, you have to install React plugin globally too. Otherwise, install it locally.

$ npm install eslint-plugin-react

Add plugins section and specify ESLint-plugin-React as a plugin.

{
  "plugins": [
    "react"
  ]
}

You can also specify some settings that will be shared across all the plugin rules.

{
  "settings": {
    "react": {
      "pragma": "React" // Pragma to use, default to "React"
    }
  }
}

If it is not already the case you must also configure ESLint to support JSX.

With ESLint 1.x.x:

{
  "ecmaFeatures": {
    "jsx": true
  }
}

With ESLint 2.x.x:

{
  "parserOptions": {
    "ecmaFeatures": {
      "jsx": true
    }
  }
}

Finally, enable all of the rules that you would like to use.

jsx-boolean-value: Enforce boolean attributes notation in JSX (fixable)
jsx-closing-bracket-location: Validate closing bracket location in JSX
jsx-curly-spacing: Enforce or disallow spaces inside of curly braces in JSX attributes (fixable)
jsx-equals-spacing: Enforce or disallow spaces around equal signs in JSX attributes
jsx-handler-names: Enforce event handler naming conventions in JSX
jsx-indent-props: Validate props indentation in JSX
jsx-indent: Validate JSX indentation
jsx-key: Validate JSX has key prop when in array or iterator
jsx-max-props-per-line: Limit maximum of props on a single line in JSX
jsx-no-bind: Prevent usage of .bind() and arrow functions in JSX props
jsx-no-duplicate-props: Prevent duplicate props in JSX
jsx-no-literals: Prevent usage of unwrapped JSX strings
jsx-no-undef: Disallow undeclared variables in JSX
jsx-pascal-case: Enforce PascalCase for user-defined JSX components
jsx-sort-props: Enforce props alphabetical sorting
jsx-space-before-closing: Validate spacing before closing bracket in JSX (fixable)
jsx-uses-react: Prevent React to be incorrectly marked as unused
jsx-uses-vars: Prevent variables used in JSX to be incorrectly marked as unused

If you're searching for React Native specific linting rules, check out eslint-plugin-react-native.

This plugin export a recommended configuration that enforce React good practices.

To enable this configuration use the extends property in your .eslintrc config file:

{
  "plugins": [
    "react"
  ],
  "extends": "plugin:react/recommended"
}

See ESLint documentation for more information about extending configuration files.

The rules enabled in this configuration are:

Note: This configuration will also enable JSX in parser options.

ESLint-plugin-React is licensed under the MIT License.