Skip to content

Create a shareable ESLint configuration package #689

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Sep 21, 2016
Prev Previous commit
Next Next commit
Add a README for eslint-config-react-app
  • Loading branch information
fson committed Sep 20, 2016
commit 8dbfe66c03f7cb54d7d77097fa633389a3bb78a5
21 changes: 21 additions & 0 deletions packages/eslint-config-react-app/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# eslint-config-react-app

This package includes the shareable ESLint configuration used by Create React App.

## Installation

*The easiest way to use this configuration is with *[Create React App](https://github.com/facebookincubator/create-react-app)*, which includes it by default – you **don't need to install it separately in Create React App projects.***

If you want to use this ESLint configuration in a project not built with Create React App, you can install it with following steps.

1. Install this package, ESLint and the necessary plugins:
```
npm install [email protected] [email protected] eslint-plugin-flowtype2.18.1 [email protected] [email protected] [email protected] --save-dev
```
2. Create a file named `.eslintrc` with following contents in the root folder of your project:
```
{
"extends": "react-app"
}
```
That's it! You can override the settings from `eslint-config-react-app` by editing the `.eslintrc` file. Learn more about [configuring ESLint](http://eslint.org/docs/user-guide/configuring) on the ESLint website.