@rnx-kit/metro-resolver-symlinks
v0.2.1
Published
Metro resolver with support for symlinks
Downloads
117,446
Keywords
Readme
@rnx-kit/metro-resolver-symlinks
@rnx-kit/metro-resolver-symlinks
is a Metro resolver with proper support for
symlinks. This is especially useful in monorepos, or repos using package
managers that make heavy use of symlinks (such as pnpm).
Installation
yarn add @rnx-kit/metro-resolver-symlinks --dev
or if you're using npm
npm add --save-dev @rnx-kit/metro-resolver-symlinks
Usage
Import and assign the resolver to resolver.resolveRequest
in your
metro.config.js
:
const { makeMetroConfig } = require("@rnx-kit/metro-config");
+const MetroSymlinksResolver = require("@rnx-kit/metro-resolver-symlinks");
module.exports = makeMetroConfig({
resolver: {
+ resolveRequest: MetroSymlinksResolver(),
},
});
Options
| Option | Type | Description |
| :------------------------------------ | :----------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| remapModule
| (moduleId: string) => string
| A custom function for remapping additional modules. |
| experimental_retryResolvingFromDisk
| boolean | [Experimental] Whether to retry module resolution on disk if not found in Haste map. This option is useful for scenarios where you want to reduce the number of watched files (and thus the initial time spent on crawling). Note that enabling this will likely be slower than having a warm cache. |
remapModule
remapModule
allows additional remapping of modules. For instance, there is a
remapImportPath
utility that remaps requests of lib/**/*.js
to
src/**/*.ts
. This is useful for packages that don't correctly export
everything in their main JS file.
const { makeMetroConfig } = require("@rnx-kit/metro-config");
const MetroSymlinksResolver = require("@rnx-kit/metro-resolver-symlinks");
module.exports = makeMetroConfig({
projectRoot: __dirname,
resolver: {
resolveRequest: MetroSymlinksResolver({
+ remapModule: MetroSymlinksResolver.remapImportPath({
+ test: (moduleId) => moduleId.startsWith("@rnx-kit/"),
+ extensions: [".ts", ".tsx"], // optional
+ mainFields: ["module", "main"], // optional
+ }),
}),
},
});
[!TIP]
When Metro releases a version with the ability to set a custom resolver for Haste requests, this way of remapping modules is preferable over
@rnx-kit/babel-plugin-import-path-remapper
. The Babel plugin mutates the AST and requires a second pass.