eslint-plugin-fsd-arch-validator/README.md

Validate whether module imports within your project meet the requirements of FSD architecture

# eslint-plugin-fsd-arch-validator

Validate whether module imports within your project meet the requirements of FSD architecture

## Installation

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

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

Next, install `eslint-plugin-fsd-arch-validator`:

```sh
npm install eslint-plugin-fsd-arch-validator --save-dev
```

## Usage

Add `fsd-arch-validator` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json
{
    "plugins": [
        "fsd-arch-validator"
    ]
}
```


Then configure the rules you want to use under the rules section.

```json
{
    "rules": {
        "fsd-arch-validator/rule-name": 2
    }
}
```

## Rules

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