Socket
Socket
Sign inDemoInstall

esm-resolve

Package Overview
Dependencies
0
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

esm-resolve

Resolves ESM imports in JS


Version published
Maintainers
1
Created

Readme

Source

Tests

An ESM import resolver for Node written in pure JS. This is written to be part of an ESM dev server or build process, as Node's import process is impossible to introspect. It also allows some cases which would otherwise be failures.

Usage

Install and import "esm-resolve" via your favourite package manager. Create a resolver based on the importing file.

import buildResolver from 'esm-resolve';

const r = buildResolver('./path/to/js/file.js');

r('./relative');             // './relative.js'
r('foo-test-package-name');  // './node_modules/foo-test-package-name/index.js'

Resolution logic is actually the same for any files in the same directory, so resolver objects can be reused (and they have a small bit of cache).

Notes

This implements modern Node resolution, i.e., subpath exports and conditional exports. By default, it will rewrite to the "browser", "import" or "default" keys (not "node", as it's expected that you'll use this for browser builds).

It fails gracefully in many ways, including falling back to real paths if exports aren't defined. It will also remove imports that point purely to ".d.ts" files (you don't need to create peer JS).

You can configure all these options via the resolver's second argument, e.g.:

// Resolves for Node, and allows .mjs files.
const r = buildResolver('./path/to/js/file.js', {
  constraints: 'node',
  matchNakedMjs: true,
});

// If there's a file "foo.mjs", this will now work:
r('./foo');                  // './foo.mjs'

// Or if we're importing package with a node constraint:
r('node-only');              // './node-modules/node-only/build-for-node.js'

FAQs

Package last updated on 22 May 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc