https://github.com/laysent/eslint-import-resolver-custom-alias

Plugin for eslint-plugin-import to use custom alias
https://github.com/laysent/eslint-import-resolver-custom-alias

alias-resolver eslint-import-plugin eslint-import-resolver eslint-plugin

Last synced: about 2 months ago
JSON representation

Plugin for eslint-plugin-import to use custom alias

• Host: GitHub
• URL: https://github.com/laysent/eslint-import-resolver-custom-alias
• Owner: laysent
• License: mit
• Created: 2018-01-15T09:48:48.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-12-05T07:09:33.000Z (about 1 year ago)
• Last Synced: 2024-09-19T01:26:42.557Z (3 months ago)
• Topics: alias-resolver, eslint-import-plugin, eslint-import-resolver, eslint-plugin
• Language: JavaScript
• Size: 61.5 KB
• Stars: 39
• Watchers: 2
• Forks: 4
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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';

```