eslint-plugin-path-check

Plugin to check feature sliced design paths correctness

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-fsd-paths-check:

npm install eslint-plugin-fsd-paths-check --save-dev

Usage

In your configuration file, import the plugin eslint-plugin-fsd-paths-check and add fsd-paths-check to the plugins key:

import { defineConfig } from "eslint/config";

export default defineConfig([
    {
        plugins: {
            [`fsd-paths-check`]
        }
    }
]);

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

import { defineConfig } from "eslint/config";

export default defineConfig([
    {
        plugins: {
            [`fsd-paths-check`]
        },
        rules: {
            "fsd-paths-check/rule-name": "warn"
        }
    }
]);

Configurations

TODO: Run eslint-doc-generator to generate the configs list (or delete this section if no configs are offered).

Rules

TODO: Run eslint-doc-generator to generate the rules list.