Skip to content

Iteam1337/eslint-config-react

Repository files navigation

Iteam ESLint config for React

Contains our preferred eslint defaults for JS and TS React development

This library only contains eslint code quality rules and is unopinionated regarding the consumer projects formatting preferences.

Althought it shouldn't happend, this means that any prettier configs you decide to use locally will override any potential conflicts it would raise with this eslint config.

Installation

Add the peer dependencies of @iteam/eslint-config-react to your dev dependencies:

npx install-peerdeps --dev @iteam/eslint-config-react

Then add @iteam/eslint-config-react

npm install --save-dev @iteam/eslint-config-react

Then add the @iteam/eslint-config-react in your .eslintrc

{
  "extends": ["@iteam/eslint-config-react"]
}

or if you're using TS:

{
  "extends": ["@iteam/eslint-config-react/typescript"]
}

If you bootstrapped with create-react-app, edit package.json:

"eslintConfig": {
    "extends": [
      "@iteam/eslint-config-react"
    ]
  },

or if you're using TS:

"eslintConfig": {
    "extends": [
      "@iteam/eslint-config-react/typescript"
    ]
  },

Plugins

  • ESLint recommended
  • React recommended
  • React Hooks recommended
  • Imports recommended
  • JSX a11y recommended