• Ville Immonen's avatar
    Create a shareable ESLint configuration package (#689) · a2d0469c
    Ville Immonen authored
    * Move ESLint configuration to a separate package
    
    * Remove the ESLint configuration, moved to eslint-config-react-app
    
    * Update ESLint instructions
    
    * Pin the package versions in eslint-config-react-app
    
    * Add a README for eslint-config-react-app
    
    * Update README.md
    
    * Update README.md
    
    * Update README.md
    
    * Update README.md
    
    * Update package.json
    
    * Update package.json
    
    * Update production eslint-loader config
    
    * Add the ESLint config to devDependencies of the repo
    a2d0469c
README.md 1.22 KiB

eslint-config-react-app

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

Usage in Create React App Projects

The easiest way to use this configuration is with Create React App, which includes it by default. You don’t need to install it separately in Create React App projects.

Usage Outside of Create React App

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

First, install this package, ESLint and the necessary plugins.

npm install --save-dev eslint-config-react-app babel-eslint@6.1.2 eslint@3.5.0 eslint-plugin-flowtype@2.18.1 eslint-plugin-import@1.12.0 eslint-plugin-jsx-a11y@2.2.2 eslint-plugin-react@5.2.2

Then 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 on the ESLint website.