eslint-config-standard-react

What is eslint-config-standard-react?

eslint-config-standard-react is an ESLint shareable config for React that extends the standard JavaScript style guide with additional rules for React. It helps enforce consistent coding styles and best practices in React projects.

What are eslint-config-standard-react's main functionalities?

React-specific linting rules

This configuration extends the standard JavaScript style guide with additional rules for React, ensuring that your React code adheres to best practices and consistent style.

{
  "extends": [
    "standard",
    "standard-react"
  ]
}

JSX syntax validation

These rules ensure that JSX syntax is correctly used and that React components and variables are properly defined and used within your code.

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

React hooks rules

These rules enforce the correct usage of React hooks, ensuring that hooks are used in accordance with the rules of hooks and that dependencies are properly specified.

{
  "rules": {
    "react-hooks/rules-of-hooks": "error",
    "react-hooks/exhaustive-deps": "warn"
  }
}

Other packages similar to eslint-config-standard-react

eslint-config-airbnb

eslint-config-airbnb is a popular ESLint configuration that extends the Airbnb JavaScript style guide, including rules for React. It is widely used and provides a comprehensive set of rules for both JavaScript and React, making it a strong alternative to eslint-config-standard-react.

eslint-config-react-app

eslint-config-react-app is the ESLint configuration used by Create React App. It includes a set of rules tailored for React applications and is designed to work seamlessly with the Create React App setup. It is a good choice for developers using Create React App who want a pre-configured ESLint setup.

eslint-plugin-react

eslint-plugin-react is an ESLint plugin that provides a set of React-specific linting rules. While it is not a shareable config like eslint-config-standard-react, it can be used to create custom ESLint configurations with React rules, offering more flexibility for developers who want to tailor their linting setup.

README

eslint-config-standard-react

An ESLint Shareable Config for React/JSX support in JavaScript Standard Style

Install

This module is for advanced users. You probably want to use standard instead :)

npm install eslint-config-standard-react

Usage

Shareable configs are designed to work with the extends feature of .eslintrc files. You can learn more about Shareable Configs on the official ESLint website.

This Shareable Config adds React and JSX to the baseline JavaScript Standard Style rules provided in eslint-config-standard.

Here's how to install everything you need:

npm install --save-dev @babel/core @babel/eslint-parser eslint-config-standard eslint-config-standard-jsx eslint-config-standard-react eslint-plugin-promise eslint-plugin-import eslint-plugin-node eslint-plugin-react

Then, add this to your .eslintrc file:

{
  "parser": "@babel/eslint-parser",
  "extends": ["standard", "standard-jsx", "standard-react"]
}

Note: We omitted the eslint-config- prefix since it is automatically assumed by ESLint.

You can override settings from the shareable config by adding them directly into your .eslintrc file.

Looking for something easier than this?

The easiest way to use JavaScript Standard Style to check your code is to use the standard package. This comes with a global Node command line program (standard) that you can run or add to your npm test script to quickly check your style.

Badge

Use this in one of your projects? Include one of these badges in your readme to let people know that your code is using the standard style.

[![js-standard-style](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/standard/standard)

Learn more

For the full listing of rules, editor plugins, FAQs, and more, visit the main JavaScript Standard Style repo.

License

MIT. Copyright (c) Feross Aboukhadijeh.