eslint-config-magic-component

eslint-config-magic-component

This package includes the shareable ESLint configuration used by Create Magic Component.
Please refer to its documentation:

• Getting Started – How to create a new component.
• User Guide – How to develop components bootstrapped with Create Magic Component.

Usage in Create Magic Component Projects

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

Usage Outside of Create Magic Component

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

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

npm install --save-dev eslint-config-magic-component babel-eslint@7.0.0 eslint@3.8.1 eslint-plugin-flowtype@2.21.0 eslint-plugin-import@2.0.1 eslint-plugin-jsx-a11y@2.2.3 eslint-plugin-react@6.4.1

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-magic-component by editing the .eslintrc file. Learn more about configuring ESLint on the ESLint website.