eslint-plugin-fsd-path-checker

plugin for path FSD

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-fsd-path-checker:

npm install  @yury_sm/eslint-plugin-fsd-path-checker --save-dev

Usage

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

import fsdPlugin from '@yury_sm/eslint-plugin-fsd-path-checker';

export default [
    {
        plugins: {
            'fsd-path-checker': fsdPlugin
        }
    }
];

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

import fsdPlugin from '@yury_sm/eslint-plugin-fsd-path-checker';

export default [
    {
        plugins: {
            'fsd-path-checker': fsdPlugin
        },
        'fsd-path-checker/path-checker': [
            'error',
            {
                alias: '@'
            }
        ],
        'fsd-path-checker/public-api-imports': [
            'error',
            {
                alias: '@'
            }
        ],
    }
];

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.