README.md

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

Configuration

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.

List of supported rules

• display-name: Prevent missing displayName in a React component definition
• forbid-prop-types: Forbid certain propTypes
• no-danger: Prevent usage of dangerous JSX properties
• no-deprecated: Prevent usage of deprecated methods
• no-did-mount-set-state: Prevent usage of setState in componentDidMount
• no-did-update-set-state: Prevent usage of setState in componentDidUpdate
• no-direct-mutation-state: Prevent direct mutation of this.state
• no-is-mounted: Prevent usage of isMounted
• no-multi-comp: Prevent multiple component definition per file
• no-set-state: Prevent usage of setState
• no-string-refs: Prevent using string references in ref attribute.
• no-unknown-property: Prevent usage of unknown DOM property (fixable)
• prefer-es6-class: Enforce ES5 or ES6 class for React Components
• prop-types: Prevent missing props validation in a React component definition
• react-in-jsx-scope: Prevent missing React when using JSX
• require-extension: Restrict file extensions that may be required
• self-closing-comp: Prevent extra closing tags for components without children
• sort-comp: Enforce component methods order
• wrap-multilines: Prevent missing parentheses around multilines JSX (fixable)

JSX-specific rules

• 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-prop-types: Enforce propTypes declarations alphabetical sorting
• 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

React Native rules

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

Recommended configuration

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:

• display-name
• jsx-no-duplicate-props
• jsx-no-undef
• jsx-uses-react
• jsx-uses-vars
• no-danger
• no-deprecated
• no-did-mount-set-state with allow-in-func option
• no-did-update-set-state with allow-in-func option
• no-direct-mutation-state
• no-is-mounted
• no-unknown-property
• prop-types
• react-in-jsx-scope

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

License

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