Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
eslint-import-resolver-custom-alias
Advanced tools
Plugin for eslint-plugin-import to use custom alias.
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
or
yarn add --dev eslint-import-resolver-custom-alias
{
"settings": {
"import/resolver": {
"eslint-import-resolver-custom-alias": {
"alias": {
"src": "./src"
},
"extensions": [".js", ".jsx"],
"packages": [
"packages/*"
]
}
}
}
}
Here, alias
is a key-value pair, where key
represents the alias, and value
represents
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 process.cwd()
)
extensions
is an array of possible suffix. If not provided, default value will be [".js"]
.
packages
is an optional configuration. When using lerna to manage packages and use eslint at
root folder, 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:
{
"settings": {
"import/resolver": {
"eslint-import-resolver-custom-alias": {
"alias": {
"@": "./src"
},
"extensions": [".js", ".jsx"],
}
}
}
}
Resolver will tries to find file at ./src/utils
folder. However, with packages
configured:
{
"settings": {
"import/resolver": {
"eslint-import-resolver-custom-alias": {
"alias": {
"@": "./src"
},
"extensions": [".js", ".jsx"],
"packages": [
"packages/*"
]
}
}
}
}
Resolver will try to find it at ./packages/subfolder/src/utils
folder instead.
One special alias is empty string ""
. If configured, the resolver will try to
add prefix in front of the path before resolving. For example, with following configuration
{
"settings": {
"import/resolver": {
"eslint-import-resolver-custom-alias": {
"alias": {
"": "./src"
},
"extensions": [".js", ".jsx"],
"packages": [
"packages/*"
]
}
}
}
}
The resolver will try to find the following import at path ./packages/subfolder/src/utils/helper
.
import * as helper from 'utils/helper';
FAQs
Plugin for eslint-plugin-import to use custom alias.
We found that eslint-import-resolver-custom-alias demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.