From 0ab998cee69c4231e090dce2ee954b2785228885 Mon Sep 17 00:00:00 2001 From: Daniel Garnier-Moiroux Date: Sun, 27 Sep 2020 14:17:48 +0200 Subject: [PATCH] Doc update: include "Usage with esm" - Closes #99 --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 056571e..9a39b13 100644 --- a/README.md +++ b/README.md @@ -170,6 +170,14 @@ You can use `module-alias` within another NPM package, however there are a few t Here is an [example project](https://github.com/Kehrlann/module-alias-library). +## Usage with esm + +[esm](https://www.npmjs.com/package/esm) tries to handle all imports when parsing a file, before actually loading any module. This means module-alias' `register` call will not be processed in time. To make `module-alias` work with `esm`, please consider using: + +``` +node -r module-alias/register -r esm index.js +``` + ## Known incompatibilities This module does not play well with: