eslint-plugin-almatvit-plugin/README.md

ESLint plugin for enforcing relative imports inside feature slices.

# eslint-plugin-almat-plugin

plugin for production project

## Installation

You'll first need to install [ESLint](https://eslint.org/):

```sh
npm i eslint --save-dev
```

Next, install `eslint-plugin-almat-plugin`:

```sh
npm install eslint-plugin-almat-plugin --save-dev
```

## Usage

In your [configuration file](https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file), import the plugin `eslint-plugin-almat-plugin` and add `almat-plugin` to the `plugins` key:

```js
import almat-plugin from "eslint-plugin-almat-plugin";

export default [
    {
        plugins: {
            almat-plugin
        }
    }
];
```


Then configure the rules you want to use under the `rules` key.

```js
import almat-plugin from "eslint-plugin-almat-plugin";

export default [
    {
        plugins: {
            almat-plugin
        },
        rules: {
            "almat-plugin/rule-name": "warn"
        }
    }
];
```



## Configurations

<!-- begin auto-generated configs list -->
TODO: Run eslint-doc-generator to generate the configs list (or delete this section if no configs are offered).
<!-- end auto-generated configs list -->



## Rules

<!-- begin auto-generated rules list -->
TODO: Run eslint-doc-generator to generate the rules list.
<!-- end auto-generated rules list -->