https://github.com/tleunen/eslint-import-resolver-babel-module

Custom eslint resolve for babel-plugin-module-resolver
https://github.com/tleunen/eslint-import-resolver-babel-module

babel babel-plugin eslint-plugin resolver

Last synced: 2 days ago
JSON representation

Custom eslint resolve for babel-plugin-module-resolver

• Host: GitHub
• URL: https://github.com/tleunen/eslint-import-resolver-babel-module
• Owner: tleunen
• License: mit
• Archived: true
• Created: 2016-04-29T01:54:17.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-16T20:27:49.000Z (about 2 years ago)
• Last Synced: 2024-09-24T00:02:09.748Z (4 months ago)
• Topics: babel, babel-plugin, eslint-plugin, resolver
• Language: JavaScript
• Homepage: https://github.com/tleunen/babel-plugin-module-resolver
• Size: 359 KB
• Stars: 248
• Watchers: 7
• Forks: 31
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# eslint-import-resolver-babel-module

[![npm][npm-version-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Coverage Status][coverage-image]][coverage-url]

A [babel-plugin-module-resolver][babel-plugin-module-resolver] resolver for [eslint-plugin-import][eslint-plugin-import]

## Installation

```sh

npm install --save-dev eslint-plugin-import eslint-import-resolver-babel-module

```

## Usage

Inside your `.eslintrc` file, pass this resolver to `eslint-plugin-import`:

```

"settings": {

  "import/resolver": {

    "babel-module": {}

  }

}

```

And see [babel-plugin-module-resolver][babel-plugin-module-resolver] to know how to configure your aliases.

### Example

```json

{

  "extends": "airbnb",

  "rules": {

    "comma-dangle": 0

  },

  "settings": {

    "import/resolver": {

      "babel-module": {}

    }

  }

}

```

## Directory Imports

Some babel plugins like [babel-plugin-import-directory](https://github.com/Anmo/babel-plugin-import-directory) or [babel-plugin-wildcard](https://github.com/vihanb/babel-plugin-wildcard) allow to import directories (i.e. each file inside a directory) as an object. In order to support this, you can activate the `allowExistingDirectories` option as follows:

```

"settings": {

  "import/resolver": {

    "babel-module": { allowExistingDirectories: true }

  }

}

```

Now when you import a directory like this, the ESLint plugin won't complain and recognize the existing directory:

```

import * as Items from './dir';

```

## License

MIT, see [LICENSE.md](/LICENSE.md) for details.

[ci-image]: https://circleci.com/gh/tleunen/eslint-import-resolver-babel-module.svg?style=shield

[ci-url]: https://circleci.com/gh/tleunen/eslint-import-resolver-babel-module

[coverage-image]: https://codecov.io/gh/tleunen/eslint-import-resolver-babel-module/branch/master/graph/badge.svg

[coverage-url]: https://codecov.io/gh/tleunen/eslint-import-resolver-babel-module

[npm-version-image]: https://img.shields.io/npm/v/eslint-import-resolver-babel-module.svg

[npm-url]: https://www.npmjs.com/package/eslint-import-resolver-babel-module

[babel-plugin-module-resolver]: https://github.com/tleunen/babel-plugin-module-resolver

[eslint-plugin-import]: https://github.com/benmosher/eslint-plugin-import