https://github.com/formidablelabs/node-esm-examples
Examples with Node.js runtimes and modern ESM support.
https://github.com/formidablelabs/node-esm-examples
Last synced: 6 months ago
JSON representation
Examples with Node.js runtimes and modern ESM support.
- Host: GitHub
- URL: https://github.com/formidablelabs/node-esm-examples
- Owner: FormidableLabs
- Created: 2021-09-21T23:02:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-03T23:28:31.000Z (over 3 years ago)
- Last Synced: 2025-06-07T05:35:27.275Z (10 months ago)
- Language: JavaScript
- Size: 946 KB
- Stars: 16
- Watchers: 36
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://formidable.com/open-source/)
[![Maintenance Status][maintenance-image]](#maintenance-status)
Examples with Node.js runtimes and modern ESM support.
## Installation
The examples presently only run on a Bash-like OS / environment.
Start with yarn installation:
```sh
$ yarn install
```
Next, you will need [nvm](https://github.com/nvm-sh/nvm) and the following Node.js **exact** runtimes:
```sh
$ nvm install 12.0.0
$ nvm install 14.17.6
```
We require the actual versions to speed up execution of known runtimes.
## Run the examples
To see available [scenarios](./scenarios):
```sh
$ yarn scenarios
different-root
...
```
To run one of the scenarios in various node versions (e.g., `12`, `14`) and modes (CommonJS `CJS`, `ESM`):
```sh
# Form
$ yarn scenario [NAME]
[VERSION] [MODE] [OUTPUT]
[VERSION] [MODE] [OUTPUT]
...
# Example
$ yarn scenario different-root
## different-root
The root exported file differs both by Node.js version _and_ mode.
[12.0.0] [CJS] main.js - from package.main on old Node.js
[14.17.6] [CJS] require.js - from package.exports root require match
[14.17.6] [ESM] import.mjs - from package.exports root import match
## dynamic-import
An ESM file is dynamically imported in both CommonJS and ESM code.
[12.0.0] [CJS] error - UnhandledPromiseRejectionWarning: Error: Not supported
[14.17.6] [CJS] import.mjs - ESM file
[14.17.6] [ESM] import.mjs - ESM file
## wrapper
A core CommonJS index file is imported and re-exported by an ESM index file.
[12.0.0] [CJS] index.cjs - core CJS code originally from index.cjs
[14.17.6] [CJS] index.cjs - core CJS code originally from index.cjs
[14.17.6] [ESM] wrapper.mjs - core CJS code originally from index.cjs
```
or just run `yarn scenario` to run **all** the scenarios!
## Maintenance Status
**Experimental:** This project is quite new. We're not sure what our ongoing maintenance plan for this project will be. Bug reports, feature requests and pull requests are welcome. If you like this project, let us know!
[maintenance-image]: https://img.shields.io/badge/Maintenance-experimental-blueviolet