Package Exports

eslint-plugin-react
eslint-plugin-react/lib/rules/prop-types

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eslint-plugin-react) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ESLint-plugin-React

React specific linting rules for ESLint

Installation

Install ESLint either locally or globally.

npm install eslint@es6jsx

ESLint-plugin-React requires ESLint with JSX support which is only available on the es6jsx branch for now.

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"
  ]
}

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

{
  "settings": {
    "ecmascript": 6,
    "jsx": true
  }
}

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

{
  "rules": {
    "react/no-multi-comp": 1,
    "react/prop-types": 1
  }
}

List of supported rules

no-multi-comp: Prevent multiple component definition per file
prop-types: Prevent missing propTypes in a React component definition

Not supported yet

display-name: Prevent missing displayName in a React component definition
no-deprecated: Prevent usage of deprecated methods (React 0.12 Updated API)
no-classic: Prevent usage of "classic" methods (#2700)

Any rule idea is welcome !

License

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