7.29.4 ā€¢ Published 2 months ago

eslint-plugin-react v7.29.4

Weekly downloads
8,387,264
License
MIT
Repository
github
Last release
2 months ago

eslint-plugin-react

Maintenance Status NPM version Build Status Dependency Status Code Climate Tidelift

React specific linting rules for eslint

Installation

Install eslint either locally or globally. (Note that locally, per project, is strongly preferred)

$ npm install eslint@7 --save-dev

If you installed eslint globally, you have to install the React plugin globally too. Otherwise, install it locally (strongly preferred)

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

Configuration

Use our preset to get reasonable defaults:

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

If you are using the new JSX transform from React 17, extend react/jsx-runtime in your eslint config (add "plugin:react/jsx-runtime" to "extends") to disable the relevant rules.

You should also specify settings that will be shared across all the plugin rules. (More about eslint shared settings)

{
  "settings": {
    "react": {
      "createClass": "createReactClass", // Regex for Component Factory to use,
                                         // default to "createReactClass"
      "pragma": "React",  // Pragma to use, default to "React"
      "fragment": "Fragment",  // Fragment to use (may be a property of <pragma>), default to "Fragment"
      "version": "detect", // React version. "detect" automatically picks the version you have installed.
                           // You can also use `16.0`, `16.3`, etc, if you want to override the detected value.
                           // It will default to "latest" and warn if missing, and to "detect" in the future
      "flowVersion": "0.53" // Flow version
    },
    "propWrapperFunctions": [
        // The names of any function used to wrap propTypes, e.g. `forbidExtraProps`. If this isn't set, any propTypes wrapped in a function will be skipped.
        "forbidExtraProps",
        {"property": "freeze", "object": "Object"},
        {"property": "myFavoriteWrapper"},
        // for rules that check exact prop wrappers
        {"property": "forbidExtraProps", "exact": true}
    ],
    "componentWrapperFunctions": [
        // The name of any function used to wrap components, e.g. Mobx `observer` function. If this isn't set, components wrapped by these functions will be skipped.
        "observer", // `property`
        {"property": "styled"}, // `object` is optional
        {"property": "observer", "object": "Mobx"},
        {"property": "observer", "object": "<pragma>"} // sets `object` to whatever value `settings.react.pragma` is set to
    ],
    "formComponents": [
      // Components used as alternatives to <form> for forms, eg. <Form endpoint={ url } />
      "CustomForm",
      {"name": "Form", "formAttribute": "endpoint"}
    ],
    "linkComponents": [
      // Components used as alternatives to <a> for linking, eg. <Link to={ url } />
      "Hyperlink",
      {"name": "Link", "linkAttribute": "to"}
    ]
  }
}

If you do not use a preset you will need to specify individual rules and add extra configuration.

Add "react" to the plugins section.

{
  "plugins": [
    "react"
  ]
}

Enable JSX support.

With eslint 2+

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

Enable the rules that you would like to use.

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

List of supported rules

āœ”: Enabled in the recommended configuration.\ šŸ”§: Fixable with eslint --fix.

āœ”šŸ”§RuleDescription
react/boolean-prop-namingEnforces consistent naming for boolean props
react/button-has-typeForbid "button" element without an explicit "type" attribute
react/default-props-match-prop-typesEnforce all defaultProps are defined and not "required" in propTypes.
react/destructuring-assignmentEnforce consistent usage of destructuring assignment of props, state, and context
āœ”react/display-namePrevent missing displayName in a React component definition
react/forbid-component-propsForbid certain props on components
react/forbid-dom-propsForbid certain props on DOM Nodes
react/forbid-elementsForbid certain elements
react/forbid-foreign-prop-typesForbid using another component's propTypes
react/forbid-prop-typesForbid certain propTypes
šŸ”§react/function-component-definitionStandardize the way function component get defined
react/hook-use-stateEnsure symmetric naming of useState hook value and setter variables
react/iframe-missing-sandboxEnforce sandbox attribute on iframe elements
react/no-access-state-in-setstateReports when this.state is accessed within setState
react/no-adjacent-inline-elementsPrevent adjacent inline elements not separated by whitespace.
react/no-array-index-keyPrevent usage of Array index in keys
šŸ”§react/no-arrow-function-lifecycleLifecycle methods should be methods on the prototype, not class fields
āœ”react/no-children-propPrevent passing of children as props.
react/no-dangerPrevent usage of dangerous JSX props
āœ”react/no-danger-with-childrenReport when a DOM element is using both children and dangerouslySetInnerHTML
āœ”react/no-deprecatedPrevent usage of deprecated methods
react/no-did-mount-set-statePrevent usage of setState in componentDidMount
react/no-did-update-set-statePrevent usage of setState in componentDidUpdate
āœ”react/no-direct-mutation-statePrevent direct mutation of this.state
āœ”react/no-find-dom-nodePrevent usage of findDOMNode
šŸ”§react/no-invalid-html-attributeForbid attribute with an invalid values`
āœ”react/no-is-mountedPrevent usage of isMounted
react/no-multi-compPrevent multiple component definition per file
react/no-namespaceEnforce that namespaces are not used in React elements
react/no-redundant-should-component-updateFlag shouldComponentUpdate when extending PureComponent
āœ”react/no-render-return-valuePrevent usage of the return value of React.render
react/no-set-statePrevent usage of setState
āœ”react/no-string-refsPrevent string definitions for references and prevent referencing this.refs
react/no-this-in-sfcReport "this" being used in stateless components
react/no-typosPrevent common typos
āœ”react/no-unescaped-entitiesDetect unescaped HTML entities, which might represent malformed tags
āœ”šŸ”§react/no-unknown-propertyPrevent usage of unknown DOM property
react/no-unsafePrevent usage of unsafe lifecycle methods
react/no-unstable-nested-componentsPrevent creating unstable components inside components
react/no-unused-class-component-methodsPrevent declaring unused methods of component class
react/no-unused-prop-typesPrevent definitions of unused prop types
react/no-unused-statePrevent definition of unused state fields
react/no-will-update-set-statePrevent usage of setState in componentWillUpdate
react/prefer-es6-classEnforce ES5 or ES6 class for React Components
react/prefer-exact-propsPrefer exact proptype definitions
šŸ”§react/prefer-read-only-propsRequire read-only props.
react/prefer-stateless-functionEnforce stateless components to be written as a pure function
āœ”react/prop-typesPrevent missing props validation in a React component definition
āœ”react/react-in-jsx-scopePrevent missing React when using JSX
react/require-default-propsEnforce a defaultProps definition for every prop that is not a required prop.
react/require-optimizationEnforce React components to have a shouldComponentUpdate method
āœ”react/require-render-returnEnforce ES5 or ES6 class for returning value in render function
šŸ”§react/self-closing-compPrevent extra closing tags for components without children
react/sort-compEnforce component methods order
react/sort-prop-typesEnforce propTypes declarations alphabetical sorting
react/state-in-constructorState initialization in an ES6 class component should be in a constructor
react/static-property-placementDefines where React component static properties should be positioned.
react/style-prop-objectEnforce style prop value is an object
react/void-dom-elements-no-childrenPrevent passing of children to void DOM elements (e.g. <br />).

JSX-specific rules

āœ”šŸ”§RuleDescription
šŸ”§react/jsx-boolean-valueEnforce boolean attributes notation in JSX
react/jsx-child-element-spacingEnsures inline tags are not rendered without spaces between them
šŸ”§react/jsx-closing-bracket-locationValidate closing bracket location in JSX
šŸ”§react/jsx-closing-tag-locationValidate closing tag location for multiline JSX
šŸ”§react/jsx-curly-brace-presenceDisallow unnecessary JSX expressions when literals alone are sufficient or enfore JSX expressions on literals in JSX children or attributes
šŸ”§react/jsx-curly-newlineEnforce consistent line breaks inside jsx curly
šŸ”§react/jsx-curly-spacingEnforce or disallow spaces inside of curly braces in JSX attributes
šŸ”§react/jsx-equals-spacingDisallow or enforce spaces around equal signs in JSX attributes
react/jsx-filename-extensionRestrict file extensions that may contain JSX
šŸ”§react/jsx-first-prop-new-lineEnsure proper position of the first property in JSX
šŸ”§react/jsx-fragmentsEnforce shorthand or standard form for React fragments
react/jsx-handler-namesEnforce event handler naming conventions in JSX
šŸ”§react/jsx-indentValidate JSX indentation
šŸ”§react/jsx-indent-propsValidate props indentation in JSX
āœ”react/jsx-keyReport missing key props in iterators/collection literals
react/jsx-max-depthValidate JSX maximum depth
šŸ”§react/jsx-max-props-per-lineLimit maximum of props on a single line in JSX
šŸ”§react/jsx-newlineRequire or prevent a new line after jsx elements and expressions.
react/jsx-no-bindPrevents usage of Function.prototype.bind and arrow functions in React component props
āœ”react/jsx-no-comment-textnodesComments inside children section of tag should be placed inside braces
react/jsx-no-constructed-context-valuesPrevents JSX context provider values from taking values that will cause needless rerenders.
āœ”react/jsx-no-duplicate-propsEnforce no duplicate props
react/jsx-no-literalsPrevent using string literals in React component definition
react/jsx-no-script-urlForbid javascript: URLs
āœ”šŸ”§react/jsx-no-target-blankForbid target="_blank" attribute without rel="noreferrer"
āœ”react/jsx-no-undefDisallow undeclared variables in JSX
šŸ”§react/jsx-no-useless-fragmentDisallow unnecessary fragments
šŸ”§react/jsx-one-expression-per-lineLimit to one expression per line in JSX
react/jsx-pascal-caseEnforce PascalCase for user-defined JSX components
šŸ”§react/jsx-props-no-multi-spacesDisallow multiple spaces between inline JSX props
react/jsx-props-no-spreadingPrevent JSX prop spreading
react/jsx-sort-default-propsEnforce default props alphabetical sorting
šŸ”§react/jsx-sort-propsEnforce props alphabetical sorting
šŸ”§react/jsx-space-before-closingValidate spacing before closing bracket in JSX
šŸ”§react/jsx-tag-spacingValidate whitespace in and around the JSX opening and closing brackets
āœ”react/jsx-uses-reactPrevent React to be marked as unused
āœ”react/jsx-uses-varsPrevent variables used in JSX to be marked as unused
šŸ”§react/jsx-wrap-multilinesPrevent missing parentheses around multilines JSX

Other useful plugins

Shareable configurations

Recommended

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.

All

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

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

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

License

eslint-plugin-react is licensed under the MIT License.

eslint-config-react-appverdaccio-okta-auth@dailyswap/eslint-config-tea@darwinhomes/eslint-config@ainultech/eslint-config@saasxx/ext-scripts@thaicoding/eslint-configreact-wind-ui@bedrockstreaming/eslint-plugin-react@rschristian/foobareslint-config-amanhimselfeslint-config-metamosmart-input-demo@vdjurdjevic/generator-react-app@vdjurdjevic/generator-react-libeslint-config-dephionbyteplayerkstick-react-scriptsdecorators-and-sass-react-scripts@wongbejoonline/eslint-plugin-wbonora-setup@joelcox22/boilerplate@qhnu/ts-lib-template@zattoo/test@asep.setiawan/react-kitmypen@jvdx/eslint@jvdx/eslint-config-jvdx@moka-test/test-configreact-native-bluetooth2listner-resize-pagekilli8n-react-native-fast-imagepatient-browserwatsize-test-react-scriptsnoodles-normgore-eslintlookly-preset-eslint@mate-academy/eslint-config-frontend-internalzwap-qrcode-frontendglobal-martcomatch-mvp-debuggingmobilelivedesignsystemreact@darapti/darapti-react-scripts@webbranch/eslint-configswitch_mostqroda-sdkqroda-sdk-v1pipihomemetaliquid-react-scriptsrockywu-uixdf-nteslint-config-sunrun@nuuji/js.config@tomas2d/react-scriptsreact-antd-scripts-newmuil-tempjbojcic-react-scriptstext-click-scroll@wheresalice/standard-adfree@paperlesspost/react-scripts@tenjo/eslint-config@tetondev/lint-config@jvhellemondt/custom-react-scriptsreact-eiptrippkit@kolesa-group/eslint-config@st4rfox/electron-scriptssv-component-librarysv-component-library-1sv-component-library-2gatsby-starter-emulsify-drupal@thuanpq/airvert-ui@xinyifly/react-scripts@ipavinthan/react-scriptsmio-cli-service@plarin/build-configs@oka_technology/eslint-config@moxy/testandculturecode-react-scriptswebeetle-react-scriptsyadong-react@agney/react-scripts-tailwindzackmoreplay-react-scriptsgooapps-react-opsar-eslint-configsonos-radio-salithefarm-react-scripts@doordash/eslint-config-doordash@wywk/headquaters-marketing-eventconcord-ui-plugin-react-scriptssebrae-boilerplatesebrae-react-scriptslint-configs@cloudhuset/zd-app-react-scripts@analogyxbi-ui/build-configidelic-react-scriptseslint-plugin-egeeslint-config-wildcattest-app-6test-app-7
7.29.4

2 months ago

7.29.1

3 months ago

7.29.0

3 months ago

7.29.3

3 months ago

7.29.2

3 months ago

7.28.0

5 months ago

7.27.1

6 months ago

7.27.0

7 months ago

7.26.1

8 months ago

7.25.3

8 months ago

7.26.0

8 months ago

7.25.2

8 months ago

7.25.1

9 months ago

7.25.0

9 months ago

7.24.0

12 months ago

7.23.2

1 year ago

7.23.1

1 year ago

7.23.0

1 year ago

7.22.0

1 year ago

7.21.5

2 years ago

7.21.4

2 years ago

7.21.3

2 years ago

7.21.2

2 years ago

7.21.1

2 years ago

7.21.0

2 years ago

7.20.6

2 years ago

7.20.5

2 years ago

7.20.4

2 years ago

7.20.3

2 years ago

7.20.2

2 years ago

7.20.1

2 years ago

7.20.0

2 years ago

7.19.0

2 years ago

7.18.3

2 years ago

7.18.2

2 years ago

7.18.1

2 years ago

7.18.0

2 years ago

7.17.0

2 years ago

7.16.0

3 years ago

7.15.1

3 years ago

7.15.0

3 years ago

7.14.3

3 years ago

7.14.2

3 years ago

7.14.1

3 years ago

7.14.0

3 years ago

7.13.0

3 years ago

7.12.4

3 years ago

7.12.3

3 years ago

7.12.2

3 years ago

7.12.1

3 years ago

7.12.0

3 years ago

7.11.1

4 years ago

7.11.0

4 years ago

7.10.0

4 years ago

7.9.1

4 years ago

7.9.0

4 years ago

7.8.2

4 years ago

7.8.1

4 years ago

7.8.0

4 years ago

7.8.0-rc.0

4 years ago

7.7.0

4 years ago

7.6.1

4 years ago

7.6.0

4 years ago

7.5.1

5 years ago

7.5.0

5 years ago

7.4.0

5 years ago

7.4.0-rc.1

5 years ago

7.4.0-rc.0

5 years ago

7.3.0

5 years ago

7.2.1

5 years ago

7.2.0

5 years ago

7.1.0

5 years ago

7.0.1

5 years ago

7.0.0

5 years ago

7.0.0-rc.1

5 years ago

7.0.0-rc.0

5 years ago

6.10.3

5 years ago

6.10.2

5 years ago

6.10.1

5 years ago

6.10.0

5 years ago

6.9.0

5 years ago

6.8.0

5 years ago

6.7.1

6 years ago

6.7.0

6 years ago

6.6.0

6 years ago

6.5.0

6 years ago

6.4.1

6 years ago

6.4.0

6 years ago

6.3.0

6 years ago

6.2.2

6 years ago

6.2.1

6 years ago

6.2.0

6 years ago

6.1.2

6 years ago

6.1.1

6 years ago

6.1.0

6 years ago

6.0.0

6 years ago

6.0.0-rc.1

6 years ago

6.0.0-rc.0

6 years ago

6.0.0-alpha.2

6 years ago

6.0.0-alpha.1

6 years ago

5.2.2

6 years ago

5.2.1

6 years ago

5.2.0

6 years ago

5.1.1

6 years ago

5.1.0

6 years ago

5.0.1

6 years ago

5.0.0

6 years ago

4.3.0

6 years ago

4.2.3

6 years ago

4.2.2

6 years ago

4.2.1

6 years ago

4.2.0

6 years ago

4.1.0

6 years ago

4.0.0

6 years ago

4.0.0-rc.1

6 years ago

4.0.0-rc.0

6 years ago

3.16.1

6 years ago

3.16.0

6 years ago

3.15.0

6 years ago

3.14.0

6 years ago

3.13.1

6 years ago

3.13.0

6 years ago

3.12.0

6 years ago

3.11.3

6 years ago

3.11.2

6 years ago

3.11.1

6 years ago

3.11.0

6 years ago

3.10.0

7 years ago

3.9.0

7 years ago

3.8.0

7 years ago

3.7.1

7 years ago

3.7.0

7 years ago

3.6.3

7 years ago

3.6.2

7 years ago

3.6.1

7 years ago

3.6.0

7 years ago

3.5.1

7 years ago

3.5.0

7 years ago

3.4.2

7 years ago

3.4.1

7 years ago

3.4.0

7 years ago

3.3.2

7 years ago

3.3.1

7 years ago

3.3.0

7 years ago

3.2.3

7 years ago

3.2.2

7 years ago

3.2.1

7 years ago

3.2.0

7 years ago

3.1.0

7 years ago

3.0.0

7 years ago

2.7.1

7 years ago

2.7.0

7 years ago

2.6.4

7 years ago

2.6.3

7 years ago

2.6.2

7 years ago

2.6.1

7 years ago

2.6.0

7 years ago

2.5.2

7 years ago

2.5.1

7 years ago

2.5.0

7 years ago

2.4.0

7 years ago

2.3.0

7 years ago

2.2.0

7 years ago

2.1.1

7 years ago

2.1.0

7 years ago

2.0.2

7 years ago

2.0.1

7 years ago

2.0.0

7 years ago

1.6.1

7 years ago

1.6.0

7 years ago

1.5.0

7 years ago

1.4.1

7 years ago

1.4.0

7 years ago

1.3.0

7 years ago

1.2.2

7 years ago

1.2.1

7 years ago

1.2.0

7 years ago

1.1.0

7 years ago

1.0.0

7 years ago