eslint-import-resolver-jest/Readme.md

🃏 Jest import resolution plugin for eslint-plugin-import

# eslint-import-resolver-jest

_"I like my `testutils` where I can see 'em"_ 🕵🏽‍♀️

<div align="center">
  <a href="https://circleci.com/gh/JoinColony/eslint-import-resolver-jest">
    <img src="https://circleci.com/gh/JoinColony/eslint-import-resolver-jest.svg?style=shield"
    title="CircleCi"/>
  </a>
  <a href="https://renovatebot.com/">
    <img src="https://img.shields.io/badge/renovate-enabled-brightgreen.svg"
    title="Renovate enabled" />
  </a>
  <a href="https://discord.gg/HDkjCqF">
    <img src="https://img.shields.io/discord/562263648173555742?logo=discord" alt="Chat on Discord">
  </a>
  <a href="https://build.colony.io/">
    <img src="https://img.shields.io/discourse/https/build.colony.io/status.svg" title="Contribute!" />
  </a>
</div>

If you're using [jest](https://facebook.github.io/jest/) and you have installed custom name mappings in your config via the `moduleNameMapper` config and you're using the wonderful [eslint-plugin-import](https://github.com/benmosher/eslint-plugin-import) you might get yelled at by eslint:

<img width="991" alt="grafik" src="https://cloud.githubusercontent.com/assets/2174084/25067977/a80c8d9e-2219-11e7-9189-4860d7f771d5.png">

(I oftentimes create an alias for the helpers I use for testing)

### Let's fix this!

```shell
yarn add eslint-import-resolver-jest -D
```

or

```shell
npm i eslint-import-resolver-jest -D
```

If you are using the [`package.json`](https://facebook.github.io/jest/docs/configuration.html) config option from jest everything should _just work_™.

If you are using a separate config file for jest using the `--config` option you have to point this plugin to it, too (in your .eslintrc):

```json
"settings": {
  "import/resolver": {
    "jest": {
      "jestConfigFile": "./jest.conf.json"
    }
  }
}
```

That's it!

If you want to ensure that this resolver only applies to your test files, you can use ESLint's `overrides` configuration option:

```json
"overrides": [
  {
    "files": ["**/__tests__/**/*.js"],
    "settings": {
      "import/resolver": {
        "jest": {
          "jestConfigFile": "./jest.conf.json"
        }
      }
    }
  }
]
```

#### Note

It will only resolve the modules in your test files that you specified via `testRegex` or `testMatch` in your jest config.

### Contributing

Create issues in this repo or get active yourself:

```shell
yarn test # npm test works, too
```

### License

MIT