# eslint-import-resolver-custom-alias

> Plugin for eslint-plugin-import to use custom alias.

Latest version **1.3.2** (published 2023-05-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-import-resolver-custom-alias
pnpm add eslint-import-resolver-custom-alias
yarn add eslint-import-resolver-custom-alias
bun add eslint-import-resolver-custom-alias
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.2 |
| Published | 2023-05-14 |
| First published | 2018-01-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 43 |
| Author | LaySent |
| Maintainers | laysent |
| Keywords | eslint-import-resolver, eslint-import-plugin, alias, resolver |

## Links

- npm: https://www.npmjs.com/package/eslint-import-resolver-custom-alias
- Repository: https://github.com/laysent/eslint-import-resolver-custom-alias
- Issues: https://github.com/laysent/eslint-import-resolver-custom-alias/issues
- npm.io page: https://npm.io/package/eslint-import-resolver-custom-alias

## Dependencies (2)

- [resolve](https://npm.io/package/resolve.md) ^1.22.2
- [glob-parent](https://npm.io/package/glob-parent.md) ^6.0.2

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 1.3.2 (latest) — 2023-05-14
- 1.3.1 — 2023-05-14
- 1.3.0 — 2021-10-24
- 1.2.0 — 2019-09-26
- 1.1.0 — 2019-05-31
- 1.0.0 — 2018-01-17

## README

[![Build Status](https://travis-ci.org/laysent/eslint-import-resolver-custom-alias.svg?branch=master)](https://travis-ci.org/laysent/eslint-import-resolver-custom-alias)

This plugin will help you configure [eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import)
to allow customized alias and extensions.

## Installation

To install this plugin, run:

```bash
npm install --dev eslint-import-resolver-custom-alias
```

or

```bash
yarn add --dev eslint-import-resolver-custom-alias
```

## Configuration

```json
{
  "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:

```jsx
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:

```json
{
  "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:

```json
{
  "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

```json
{
  "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`.

```jsx
import * as helper from 'utils/helper';
```

---
_Source: https://npm.io/package/eslint-import-resolver-custom-alias · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._