eslint-plugin-fsd-import/README.md

Plugin for checking imports path in FSD project

# eslint-plugin-fsd-import

Plugin for checking imports path in [FSD](https://feature-sliced.design/) project.

## Installation

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

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

Next, install `eslint-plugin-fsd-import`:

```sh
npm install eslint-plugin-fsd-import --save-dev
```

## Usage

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

```json
{
    "plugins": [
        "fsd-import"
    ]
}
```


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

```json
{
    "rules": {
        "fsd-import/fsd-relative-path": "error",
        "fsd-import/public-api-imports": "error",
        "fsd-import/layer-imports": "error",
    }
}
```

## Supported Rules
Check FSD imports is correct:
* [fsd-relative-path](https://github.com/vgratsilev/eslint-plugin-fsd-import/blob/main/docs/rules/fsd-relative-path.md)
 Imports within one slice should be relative.
* [public-api-imports](https://github.com/vgratsilev/eslint-plugin-fsd-import/blob/main/docs/rules/public-api-imports.md)
Absolute imports should be only from public API.
* [layer-imports](https://github.com/vgratsilev/eslint-plugin-fsd-import/blob/main/docs/rules/layer-imports.md)
Modules on one layer can only interact with modules from the layers strictly below.