eslint-plugin-fsd-imports-checker

Checking import paths according to a Feature-Sliced Design

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

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

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

Usage

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

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

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

{
    rules: {
    'fsd-imports-checker/relative-path-checker': ['error', { alias: '@' }],
    'fsd-imports-checker/imports-between-layers': [
      'error',
      {
        alias: '@',
        ignoreImportPatterns: [''], //add files
        },
      ],      
    'fsd-imports-checker/public-api-imports': [
      'error',
      {
        alias: '@', 
        testFilesPatterns: ['**/*.test.*', '**/*.stories.*', '**/StoreDecorator.tsx'],
      },
    }
}

Rules

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