Description

This configuration extends the @favware/eslint-config package while adding React specific rules. The React ruleset is heavily based on eslint-config-react-app, with the difference being that it's opinionated to Favware code styling.

Install

Peer Dependencies

This project has eslint related peer dependencies that can be installed with:

yarn add -D @favware/eslint-config @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-prettier eslint-plugin-react eslint-plugin-react-hooks prettier typescript

# npm install -D @favware/eslint-config @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-prettier eslint-plugin-react eslint-plugin-react-hooks prettier typescript

This package

Install with yarn or npm:

yarn add -D @favware/eslint-config-react-app

# npm install -D @favware/eslint-config-react-app

Usage

Add the ESLint config to your package.json:

{
  "name": "my-project",
  "eslintConfig": {
    "extends": "@favware/eslint-config-react-app"
  }
}

Or to eslintrc.js / .eslintrc.json:

{
  "extends": "@favware/eslint-config-react-app"
}

Create tsconfig.eslint.json next to the eslint config file, for example with content:

{
  "extends": "./tsconfig.json",
  "include": ["src", "test"]
}

API Documentation

For the full API documentation please refer to the TypeDoc generated documentation.

Buy us some doughnuts

Favware projects are and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Donate With	Address
GitHub Sponsors	Click Here
Ko-fi	Click Here
Patreon	Click Here
PayPal	Click Here

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jeroen Claassens 💻 🚇 📆 📖 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!