YOO ESLint Configuration for TypeScript Projects

Contains the settings and rules used for TypeScript projects 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 TypeScript. This configuration is compatible with our coding guidelines.

This set of rules is framework agnostic. It only contains rules for pure TypeScript. This allows it to be extended for Angular or React projects. Extensions for these frameworks can be found in their respective packages:

• React
• Angular

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-base

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 yooEslintConfigBase from '@yoo-digital/eslint-config-base';

export default [
  ...yooEslintConfigBase,
  // 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 share the base ESLint configuration for TypeScript projects. It should not contain any rules that are specific to Angular or React.

Before creating a pull request or publishing changes, make sure you tested your changes. Within this mono-repository you will find an example Angular application in the examples/angular-app directory. Run npm run lint in that directory to test your changes.