eslint-plugin-midi-plugin-import

the plugin for fix paths of imports

page on GitHub

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-midi-plugin-import:

npm install eslint-plugin-midi-plugin-import --save-dev

Usage

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

{
    "plugins": [
        "midi-plugin-import"
    ]
}

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

This rule is necessary to check the use of relative paths inside slices in accordance with the FSD methodology. (This rule has a fixer.)

{
    "rules": {
        "midi-plugin-import/path-check": 2
    }
}

This rule is necessary to control the production of absolute imports from the public API only. (This rule has a fixer.)

{
    "rules": {
        "midi-plugin-import/public-api-imports": 2
    }
}

This rule is necessary to control the production of imports from the underlying layers. (This rule doesn't have a fixer.)

{
    "rules": {
        "midi-plugin-import/layer-imports": 2
    }
}

If you use an absolute path alias, you need to include the "aliasAbsolutePath" parameter and the alias name.

{
    "rules": {
        "midi-plugin-import/{rule-name}": [2, {"aliasAbsolutePath": "@"}]
    }
}

Rules

🔧 Automatically fixable by the --fix CLI option.

| Name               | Description | 🔧 | | :----------------------------------------------------- | :------------------------------------------------------------- | :- | | layer-imports | restriction on importing overlying layers into underlying ones | | | path-check | checking correct path for feature sliced design | 🔧 | | public-api-imports | The rule prohibits the use of components not from public API | 🔧 |