YOO ESLint Configuration for React Projects

Contains the settings and rules used for React projects based on TypeScript within YOO. It is publicly available via the npm registry.

Purpose

The exported eslint.config.mjs file contains a eslint config (flat-config) that is based on the recommended eslint rules for development with React and TypeScript. This configuration extends the YOO Base ESLint config and is aligned with our coding guidelines.

For Angular projects you can consult this package.

Usage

In order to use the ESLint configuration file in your project, you will have to install its dependencies (including peer-dependencies). The following command should work for both npm and yarn. It will detect the proper client.

npx install-peerdeps --dev @yoo-digital/eslint-config-react

Be aware: The typescript package is one of the peer-dependencies. The versions might collide in your project. Always try to use the latest versions of typescript in your project.

After installing the packages, you can create a ESLint configuration file in the root of your project and add the following lines:

import yooEslintConfigReact from '@yoo-digital/eslint-config-react';

export default [
  ...yooEslintConfigReact,
  // your own rules
];

You can apply your own set of rules on top of that, but do not turn off any of the rules, except it is an obstacle and making your life harder. Check the chapter below, for a complete set of rules that can be applied.

Development

Important: This configuration should only contain rules concerning React.js.

Before creating a pull request or publishing changes, make sure you tested your changes. Within this mono-repository you will find an example React application in the examples/react-app directory and a Next.js application in the examples/nextjs-app directory. Run npm run lint in these directories to test your changes.