eslint-plugin-dmtrs-fsd-path-checker

plugin for production project based on FSD

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

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

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

Usage

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

{
    "plugins": [
        "dmtrs-fsd-path-checker"
    ]
}

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

{
    "rules": {
        "dmtrs-fsd-path-checker/rule-name": 2
    }
}

Supported Rules

layer-imports:

Defines rules prohibiting importing modules from upper level layers or layers of the same level

{
    "rules": {
        "dmtrs-fsd-path-checker/layer-imports": 2
    }
}

Options:

• "alias" - Allows you to customize the alias you use in your project for absolute paths

{
    "rules": {
      "dmtrs-fsd-path-checker/layer-imports": [
        "error",
        {
          "alias": "@"
        }
      ]
    }
}

• "ignoreImportPatterns" - Allows you to define an array of path patterns that will be ignored by this rule

{
    "rules": {
      "dmtrs-fsd-path-checker/layer-imports": [
        "error",
        {
          "ignoreImportPatterns": ["**/StoreDecorator"]
        }
      ]
    }
}

• "allowImports" - Allows you to flexibly configure exceptions for the “from” and “to” paths. Defined by an object, where the key is the path pattern “where” we want to import, and the value is an array with the names of the layers from which we can import.

{
    "rules": {
      "dmtrs-fsd-path-checker/layer-imports": [
        "error",
        {
          "allowImports": {
            "**/widgets/layouts/**": ["widgets"]
          }
        }
      ]
    }
}

In this example, we allow any files located along the widgets/layouts path to import modules from the widget layer

path-checker:

Checks the correctness of relative imports within the same module

{
    "rules": {
        "dmtrs-fsd-path-checker/path-checker": 2
    }
}

Options:

• "alias" - Allows you to customize the alias you use in your project for absolute paths

{
    "rules": {
      "dmtrs-fsd-path-checker/path-checker": [
        "error",
        {
          "alias": "@"
        }
      ]
    }
}

• "excludeLayers" - Allows you to define an array of exceptions for layers that you want to be ignored by this rule

{
    "rules": {
      "dmtrs-fsd-path-checker/path-checker": [
        "error",
        {
          "excludeLayers": ["shared"]
        }
      ]
    }
}

public-api-imports:

Checks that module import occurs only through public api

{
    "rules": {
        "dmtrs-fsd-path-checker/public-api-imports": 2
    }
}

Options:

• "alias" - Allows you to customize the alias you use in your project for absolute paths

{
    "rules": {
      "dmtrs-fsd-path-checker/public-api-imports": [
        "error",
        {
          "alias": "@"
        }
      ]
    }
}