@remix-run/eslint-config

@remix-run/eslint-config

This package includes a shareable ESLint config for Remix projects.

This package is new, but eventually we will include it as a dependency in projects bootstrapped with create-remix so that no configuration in necessary for those apps.

Installation

First, install this package along with ESLint in your project. This package requires at least version 8.1 of ESLint

npm install -D eslint @remix-run/eslint-config

Then create a file named .eslintrc in the root of your project:

{
  "extends": "@remix-run/eslint-config"
}

Jest + Testing Library

This packages also ships with optional configuration options for projects that use Jest with Testing Library. To enable these rules, add the following to your .eslintrc:

{
  "extends": [
    "@remix-run/eslint-config",
    "@remix-run/eslint-config/jest-testing-library"
  ]
}

Please note that because this ruleset is optional, we do not include the core libraries as peer dependencies for this package. If you use these rules, be sure that you have the following dependencies installed in your project:

{
  "@testing-library/jest-dom": ">=5.16.0",
  "@testing-library/react": ">=12.0.0",
  "jest": ">=26.0.0"
}