@o3r/eslint-plugin/README.md

The module provides in-house eslint plugins to use in your own eslint configuration.

<h1 align="center">Otter eslint plugin</h1>
<p align="center">
  <img src="https://raw.githubusercontent.com/AmadeusITGroup/otter/main/assets/logo/otter.png" alt="Super cute Otter!" width="40%"/>
</p>

This package is an [Otter Framework Module](https://github.com/AmadeusITGroup/otter/tree/main/docs/core/MODULE.md).
<br />
<br />

## Description

[![Stable Version](https://img.shields.io/npm/v/@o3r/eslint-plugin?style=for-the-badge)](https://www.npmjs.com/package/@o3r/eslint-plugin)
[![Bundle Size](https://img.shields.io/bundlephobia/min/@o3r/eslint-plugin?color=green&style=for-the-badge)](https://www.npmjs.com/package/@o3r/eslint-plugin)

The module provides in-house eslint plugins to use in your own eslint configuration.

## How to install

```shell
ng add @o3r/eslint-plugin
```

> [!WARNING]
> This module requires [@o3r/core](https://www.npmjs.com/package/@o3r/core) to be installed.

## Rules

The list of rules is available in the [documentation](https://github.com/AmadeusITGroup/otter/tree/main/docs/linter/eslint-plugin/rules).