React specific linting rules for ESLint
Branch: master
Clone or download
Pull request Compare This branch is 702 commits behind yannickcr:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


Maintenance Status NPM version Build Status Build Status Dependency Status Coverage Status Code Climate

React specific linting rules for ESLint


Install ESLint either locally or globally.

$ npm install eslint --save-dev

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

$ npm install eslint-plugin-react --save-dev


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

  "plugins": [

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

  "settings": {
    "react": {
      "createClass": "createReactClass", // Regex for Component Factory to use, default to "createReactClass"
      "pragma": "React",  // Pragma to use, default to "React"
      "version": "15.0", // React version, default to the latest React stable release
      "flowVersion": "0.53" // Flow version
    "propWrapperFunctions": [ "forbidExtraProps" ] // The names of any functions used to wrap the propTypes object, such as `forbidExtraProps`. If this isn't set, any propTypes wrapped in a function will be skipped.

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 or 3.x.x:

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

Finally, enable all of the rules that you would like to use. Use our preset to get reasonable defaults quickly, and/or choose your own:

  "rules": {
    "react/jsx-uses-react": "error",
    "react/jsx-uses-vars": "error",

List of supported rules

JSX-specific rules

Other useful plugins

Shareable configurations


This plugin exports a recommended configuration that enforces React good practices.

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

  "extends": ["eslint:recommended", "plugin:react/recommended"]

See ESLint documentation for more information about extending configuration files.

The rules enabled in this configuration are:


This plugin also exports an all configuration that includes every available rule. This pairs well with the eslint:all rule.

  "plugins": [
  "extends": ["eslint:all", "plugin:react/all"]

Note: These configurations will import eslint-plugin-react and enable JSX in parser options.


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