This plugin will help you configure eslint-plugin-import to allow customized alias and extensions.
To install this plugin, run:
npm install --dev eslint-import-resolver-custom-alias
yarn add --dev eslint-import-resolver-custom-alias
alias is a key-value pair, where
key represents the alias, and
it's actual path. Relative path is allowed for
value. When used, it's relative to project
root, where command line is running. (i.e. root path will be
extensions is an array of possible suffix. If not provided, default value will be
packages is an optional configuration. When using lerna to manage packages and use eslint at
packages lets the resolver know where each package folder exist. This way, when
resolving alias, relative path will be resolved based on current package, instead of root folder.
Consider the file as an example:
import * as utils from '@/utils';
Suppose the above file locates at
./packages/subfolder/src/components/button.jsx and command is
running at root folder (i.e.
./). If the resolver is configured the following way:
Resolver will tries to find file at
./src/utils folder. However, with
Resolver will try to find it at
./packages/subfolder/src/utils folder instead.