babel-plugin-module-resolver weekly downloads statistics

babel-plugin-module-resolver

[![Maintenance Status][status-image]][status-url] [![NPM version][npm-image]][npm-url] [![Build Status Linux][circleci-image]][circleci-url] [![Build Status Windows][appveyor-image]][appveyor-url] [![Coverage Status][coverage-image]][coverage-url]

A Babel plugin to add a new resolver for your modules when compiling your code using Babel. This plugin allows you to add new "root" directories that contain your modules. It also allows you to setup a custom alias for directories, specific files, or even other npm modules.

Description

This plugin can simplify the require/import paths in your project. For example, instead of using complex relative paths like ../../../../utils/my-utils, you can write utils/my-utils. It will allow you to work faster since you won't need to calculate how many levels of directory you have to go up before accessing the file.

Getting started

Install the plugin

or

Specify the plugin in your .babelrc with the custom root or alias. Here's an example:

.babelrc.js version Specify the plugin in your .babelrc.js file with the custom root or alias. Here's an example:

Good example: // https://gist.github.com/nodkz/41e189ff22325a27fe6a5ca81df2cb91

Documentation

babel-plugin-module-resolver can be configured and controlled easily, check the documentation for more details

Are you a plugin author (e.g. IDE integration)? We have documented the exposed functions for use in your plugins!

ESLint plugin

If you're using ESLint, you should use [eslint-plugin-import][eslint-plugin-import], and [eslint-import-resolver-babel-module][eslint-import-resolver-babel-module] to remove falsy unresolved modules. If you want to have warnings when aliased modules are being imported by their relative paths, you can use eslint-plugin-module-resolver.

Editors autocompletion

• Atom: Uses [atom-autocomplete-modules][atom-autocomplete-modules] and enable the babel-plugin-module-resolver option. • VS Code: Configure the path mapping in jsconfig.json (tsconfig.json for TypeScript), e.g.: • IntelliJ/WebStorm: You can mark your module directories as "resources root" e.g if you have ../../../utils/MyUtilFn you can mark ../../../utils as "resources root". This has the problem that your alias also has to be named utils. The second option is to add a webpack.config.js to your project and use it under File->Settings->Languages&Frameworks->JavaScript->Webpack. This will trick webstorm into resolving the paths and you can use any alias you want e.g.:

License

MIT, see LICENSE.md for details.

Who is using babel-plugin-module-resolver ?

• Algolia: InstantSearch.js • Airbnb: Lottie React Native • AppDirect • Callstack: React Native Paper • Codility • Eleme: Element • Expo: Expo SDK • FormidableLabs: Victory Native • OpenCollective: OpenCollective • React Community: React Native Maps • Uber: Seer, react-vis • Quasar Framework: Quasar • Vuetify.js Vuetify • Zeit: Next.js • Zenika: Immutadot

Are you also using it? Send a PR!

Description from the npm listing.