eslint-plugin-for-fsd-path

eslint-plugin-for-fsd-path

Eslint плагин для проверки что рамках одного слайса все пути должны быть относительными

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

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

npm install eslint-plugin-for-fsd-path --save-dev

Usage

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

{
    "plugins": [
        "for-fsd-path"
    ]
}

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

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

Rules

Name	Description	Options
path-checker	Проверки что рамках одного слайса все пути должны быть относительными	alias - Необязательная опция, указывается если в проекте используется alias импортов
public-api-imports	Проверка что импорты из других слоев используются из Public Api (index.ts)	alias - Необязательная опция, указывается если в проекте используется alias импортов
layer-imports	Проверка что текущий слой может импортировать только нижележащего слоя	alias - Необязательная опция, указывается если в проекте используется alias импортов, ignoreImportsPatterns- массив путей для исключения