eslint-plugin-imports-fsd

plugin for tracking imports in the application

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-imports-fsd:

npm install eslint-plugin-imports-fsd --save-dev

Usage

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

{
    "plugins": [
        "imports-fsd"
    ]
}

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

{
    "rules": {
        "imports-fsd/path-checker": ["error", { alias: "@" }],
        "imports-fsd/public-api-imports": ["error", { alias: "@" }],
        "imports-fsd/layer-imports": [
        "error",
        {
            alias: "@",
            ignoreImportPatterns: ["**/StoreProvider", "**/testing"],
        },
        ],
    }
}

Rules

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