metro-resolver

What is metro-resolver?

The metro-resolver npm package is a module resolution library used primarily in the Metro bundler, which is the JavaScript bundler for React Native. It helps in resolving modules by locating and identifying the correct files within a project's structure based on specific resolution rules and configurations.

What are metro-resolver's main functionalities?

Custom Resolution Strategies

Allows the implementation of custom resolution strategies for modules, enabling developers to define how modules are resolved based on the platform or other conditions.

const { resolve } = require('metro-resolver');

const context = { originModulePath: '/path/to/module.js', redirectModulePath: undefined, resolveRequest: null, platform: 'ios', moduleName: './otherModule' };
const result = resolve(context, moduleName, platform);

Platform Specific Resolutions

Supports resolving platform-specific versions of modules, such as distinguishing between iOS and Android specific code files in a React Native project.

const { resolve } = require('metro-resolver');

const context = { originModulePath: '/path/to/module.js', redirectModulePath: undefined, resolveRequest: null, platform: 'android', moduleName: './component' };
const result = resolve(context, moduleName, platform);

Other packages similar to metro-resolver

resolve

A module resolution package similar to metro-resolver but more generic and not tied to any specific framework or platform. It provides a greater level of customization and is used in various Node.js environments.

enhanced-resolve

Part of the webpack ecosystem, enhanced-resolve is used to resolve files and directories in a highly configurable manner. It offers more features and plugins compared to metro-resolver, tailored for web development environments.

README

metro-resolver

🚇 Metro resolution logic