https://github.com/mmazzarolo/eslint-plugin-react-app

ESLint configuration used by Create React App
https://github.com/mmazzarolo/eslint-plugin-react-app

create-react-app eslint react react-native typescript

Last synced: about 2 hours ago
JSON representation

ESLint configuration used by Create React App

• Host: GitHub
• URL: https://github.com/mmazzarolo/eslint-plugin-react-app
• Owner: mmazzarolo
• License: mit
• Created: 2017-02-09T11:04:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-08-19T09:44:12.000Z (about 3 years ago)
• Last Synced: 2024-11-01T09:17:05.108Z (7 days ago)
• Topics: create-react-app, eslint, react, react-native, typescript
• Language: JavaScript
• Size: 119 KB
• Stars: 51
• Watchers: 3
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![npm version](https://badge.fury.io/js/eslint-plugin-react-app.svg)](https://badge.fury.io/js/eslint-plugin-react-app)

# eslint-plugin-react-app

A minimal set of easy to install ESLint rules for your project: just install a single NPM package, add it to your `.eslintrc`, and you'll be all set.  

> This plugin exposes [the ESLint configuration used by Create React App](https://github.com/facebook/create-react-app/tree/master/packages/eslint-config-react-app) without the need of declaring all its dependencies.  

Use it if you need a simple and tested ESLint configuration but you don't want to install a bunch of dependencies.  

It also works in React Native out of the box.

## Setup

1. Install it using npm: `npm install --development eslint eslint-plugin-react-app`.

2. Extend `plugin:react-app/recommended` in your `.eslintrc`.

Example `.eslintrc`:

```json

{

  "extends": ["plugin:react-app/recommended"]

}

```

3. You're done!

## Optional - Configuring the rules

If you want to change a rule of an included plugin (for example of `eslint-plugin-react`) you must prefix the rule with `react-app/` (for preventing namespace collisions).  

For example:

```json

{

  "extends": ["plugin:react-app/recommended"],

  "rules": {

    "react-app/react/react-in-jsx-scope": ["warn"]

  }

}

```

## Optional - Adding Prettier

This plugin works nicely alongside [Prettier](https://prettier.io/).  

Install it with `npm install --development prettier eslint-config-prettier eslint-plugin-prettier`.   

And setup your `.eslintrc` this way:  

```json

{

  "extends": ["react-app", "plugin:prettier/recommended"],

  "plugins": ["prettier"]

}

```

## Included plugins  

The currently included create-react-app plugins are the following:

- [eslint-plugin-import](https://github.com/benmosher/eslint-plugin-import)

- [eslint-plugin-flowtype](https://github.com/gajus/eslint-plugin-flowtype)

- [eslint-plugin-jsx-a11y](https://github.com/evcohen/eslint-plugin-jsx-a11y)

- [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react)

- [eslint-plugin-react-hooks](https://www.npmjs.com/package/eslint-plugin-react-hooks)

- [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint)

## Acknowledgements

Thanks to [fson](https://github.com/fson) and its [Create React App pull request](https://github.com/facebookincubator/create-react-app/pull/993) for the initial idea of this plugin.  

Thanks to [gaeron](https://github.com/gaearon) and everyone who contributed to Create React App.

## Disclaimer

This project is not officially maintained (nor officially "supported") by the Create React App team.