\n\n\n\nAn ESLint plugin that enforces the use of import aliases. Also supports autofixing.\n\n\nAliases are a great thing to make imports more readable and you do not have to change import paths that often when a file path is changed.\n\n```js\nimport foo from '../../model/sub/foo';\nimport bar from '../other/bar';\n```\n\nchanges to\n\n```js\nimport foo from '@/model/sub/foo';\nimport bar from '@/sub/other/bar';\n```\n\nNow what if you are in a bigger team or you have a lot of projects to update. Or you just want to make sure that everything is consistent. This is where a linter comes into the play. This rule allows you to detect inconsistent imports and even autofix them. This works by matching alias paths agains the imports and replacing the import paths with the first matching aliased path.\n\n\n## Install\n\n```bash\n# npm\n$ npm install @dword-design/eslint-plugin-import-alias\n\n# Yarn\n$ yarn add @dword-design/eslint-plugin-import-alias\n```\n\n\n## Usage\n\nAdd the plugin to your ESLint config:\n\n```ts\n// eslint.config.ts\n\nimport { defineConfig } from 'eslint/config';\nimport importAlias from '@dword-design/eslint-plugin-import-alias';\n\nexport default defineConfig([\n importAlias.configs.recommended,\n]);\n```\n\nOptions can be passed by setting them in the `prefer-alias` rule:\n\n```ts\n// eslint.config.ts\n\nimport { defineConfig } from 'eslint/config';\nimport importAlias from '@dword-design/eslint-plugin-import-alias';\n\nexport default defineConfig([\n importAlias.configs.recommended,\n {\n rules: {\n '@dword-design/import-alias/prefer-alias': ['error', /* options */],\n },\n },\n]);\n```\n\nNow you have multiple ways to tell the plugin about aliases.\n\n### `tsconfig.json` `paths` setting\n\nIf you are a TypeScript user and you have aliases configured in your `tsconfig.json` via the `paths` setting, they will automatically be loaded. You can disable this behavior by setting `shouldReadTsConfig` to `false` in the plugin options.\n\n### [babel-plugin-module-resolver](https://www.npmjs.com/package/babel-plugin-module-resolver)\n\nIf you are already using [babel-plugin-module-resolver](https://www.npmjs.com/package/babel-plugin-module-resolver), the plugin will load the Babel config and extract the `alias` and `resolvePath` options. You can disable this behavior by setting `shouldReadBabelConfig` to `false` in the plugin options.\n\n```json\n// .babelrc.json\n\n{\n \"plugins\": {\n [\"module-resolver\", {\n \"alias\": {\n \"@\": \".\",\n },\n }]\n }\n}\n```\n\n### Plugin `alias` option\n\nYou can also just pass the aliases to the plugin as an option.\n\n```ts\n// eslint.config.ts\n\nimport { defineConfig } from 'eslint/config';\nimport importAlias from '@dword-design/eslint-plugin-import-alias';\n\nexport default defineConfig([\n importAlias.configs.recommended,\n {\n rules: {\n '@dword-design/import-alias/prefer-alias': [\n 'error',\n {\n 'alias': {\n '@': './src',\n '@components': './src/components',\n },\n },\n ],\n },\n },\n]);\n```\n\n## Alias resolution\n\nBy default, the plugin will convert parent paths to aliases (like `../model/foo`), but will keep subpath imports relative. You can change that to also convert subpaths to aliased imports by passing the `aliasForSubpaths` option to the rule like so:\n\n```ts\nrules: {\n '@dword-design/import-alias/prefer-alias': ['error', { aliasForSubpaths: true }],\n}\n```\n\nAlso, inner alias paths are preferred to outer ones. Example:\n\n```ts\nrules: {\n '@dword-design/import-alias/prefer-alias': ['error', { alias: { '@': './app', '@@': '.' }],\n}\n```\n\nIf an import resolves to a file inside `app`, `@` will be preferred over `@@` although both aliases match. This is convenient for the use case where you have a lot of aliases for top-level folders like `components`, `utils` etc where you usually want those instead of a generic root alias. If you have other use cases, please let me know.\n\n\n## Contribute\n\nAre you missing something or want to contribute? Feel free to file an [issue](https://github.com/dword-design/eslint-plugin-import-alias/issues) or a [pull request](https://github.com/dword-design/eslint-plugin-import-alias/pulls)! ⚙️\n\n## Support\n\nHey, I am Sebastian Landwehr, a freelance web developer, and I love developing web apps and open source packages. If you want to support me so that I can keep packages up to date and build more helpful tools, you can donate here:\n\n
\n \n \n If you want to send me a one time donation. The coffee is pretty good 😊. \n \n \n Also for one time donations if you like PayPal. \n \n \n Here you can support me regularly, which is great so I can steadily work on projects.\n
![\"Linux](\"https://img.shields.io/badge/os-linux%20%7C%C2%A0macos%20%7C%C2%A0windows-blue\"){kind=icon}
\n ![\"Dependency](\"https://img.shields.io/david/dword-design/eslint-plugin-import-alias\")
\n ![\"Renovate](\"https://img.shields.io/badge/renovate-enabled-brightgreen\"){kind=icon}