# @bitassembly/eslint-plugin-import-alias

> Rewrite imports to TSConfig aliases

Latest version **1.0.1** (published 2022-04-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @bitassembly/eslint-plugin-import-alias
pnpm add @bitassembly/eslint-plugin-import-alias
yarn add @bitassembly/eslint-plugin-import-alias
bun add @bitassembly/eslint-plugin-import-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.0.1 |
| Published | 2022-04-22 |
| First published | 2022-04-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 13.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Limegrass |
| Maintainers | jamsuu |

## Links

- npm: https://www.npmjs.com/package/@bitassembly/eslint-plugin-import-alias
- Repository: https://github.com/jamsuu/eslint-plugin-import-alias
- npm.io page: https://npm.io/package/@bitassembly/eslint-plugin-import-alias

## Dependencies (5)

- [slash](https://npm.io/package/slash.md) ^3.0.0
- [find-up](https://npm.io/package/find-up.md) ^5.0.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.1
- [micromatch](https://npm.io/package/micromatch.md) ^4.0.0
- [tsconfig-paths](https://npm.io/package/tsconfig-paths.md) ^3.11.0

## Recent versions

- 1.0.1 (latest) — 2022-04-22

## README

# @limegrass/eslint-plugin-import-alias

Encourage use of defined aliases in TSConfig/JSConfig through ESLint.

## Why

-   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 `./`

## Requirements

-   Node 14+

## Install

```shell
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][docs-import-alias] for more detail.

## Configuration

The following is the most basic configuration.
Check the [rules documentation][docs-import-alias] for further configuration.

```jsonc
// .eslintrc
{
    "plugins": ["@limegrass/import-alias"],
    "rules": {
        "@limegrass/import-alias/import-alias": "error"
    }
}
```

This configuration is also turned on automatically if you extend `eslint:recommended`.

[docs-import-alias]: docs/rules/import-alias.md

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