Encourage use of defined aliases in TSConfig/JSConfig through ESLint.
- Automatic imports by tsserver resolve to relative paths that can be normalized.
- It's easier to refactor by finding and replacing an absolute module path
without worrying about crafting the regex for
../
and./
- Node 14+
npm install --save-dev @limegrass/eslint-plugin-import-alias eslint
This plugin relies on an alias configuration in tsconfig.json
, jsconfig.json
,
or a config with the same schema and a path given as aliasConfigPath
in its rules
settings. See the rules documentation for more detail.
The following is the most basic configuration. Check the rules documentation for further configuration.
// .eslintrc
{
"plugins": ["@limegrass/import-alias"],
"rules": {
"@limegrass/import-alias/import-alias": "error"
}
}
This configuration is also turned on automatically if you extend eslint:recommended
.