npm install esm
90.6
Supply Chain Risk
88.7
Quality
75.9
Maintenance
100
Vulnerability
5,266 Stars
6,378 Commits
146 Forks
56 Watching
1 Branches
29 Contributors
Updated on 03 Sept 2024
Minified
Minified + Gzipped
JavaScript (99.87%)
WebAssembly (0.08%)
TypeScript (0.05%)
Cumulative downloads
Total Downloads
Last day
-8.1%
119,533
Compared to previous day
Last week
-1.6%
2,539,253
Compared to previous week
Last month
-8.3%
10,250,761
Compared to previous month
Last year
9.2%
127,893,313
Compared to previous year
The brilliantly simple, babel-less, bundle-less ECMAScript module loader.
esm
is the world’s most advanced ECMAScript module loader. This fast, production ready, zero dependency loader is all you need to support ECMAScript modules in Node 6+. See the release post and video for details!
New projects
Run npm init esm
or yarn create esm
.
:bulb: Use the -y
flag to answer “yes” to all prompts.
Existing projects
Run npm i esm
or yarn add esm
.
There are two ways to enable esm
.
Enable esm
for packages:
Use esm
to load the main ES module and export it as CommonJS.
index.js
// Set options as a parameter, environment variable, or rc file. require = require("esm")(module/*, options*/) module.exports = require("./main.js")
main.js
// ESM syntax is supported. export {}
:bulb: These files are automagically created with npm init esm
or yarn create esm
.
Enable esm
for local runs:
node -r esm main.js
:bulb: Omit the filename to enable esm
in the REPL.
:clap: By default, :100: percent CJS interoperability is enabled so you can get stuff done.
:lock: .mjs
files are limited to basic functionality without support for esm
options.
Out of the box esm
just works, no configuration necessary, and supports:
import
/export
import.meta
import
stdin
, --eval
, --print
flags--check
flag (Node 10+)Specify options with one of the following:
"esm"
field in package.json
.esmrc.js
, .esmrc.cjs
, or .esmrc.mjs
file.esmrc
or .esmrc.json
fileESM_OPTIONS
environment variableESM_DISABLE_CACHE
environment variable{ | |||||||||||||||||||||||
"cjs":true |
A boolean or object for toggling CJS features in ESM. Features
| ||||||||||||||||||||||
"mainFields":["main"] |
An array of fields checked when importing a package. | ||||||||||||||||||||||
"mode":"auto" |
A string mode:
| ||||||||||||||||||||||
"await":false |
A boolean for top-level | ||||||||||||||||||||||
"force":false |
A boolean to apply these options to all module loads. | ||||||||||||||||||||||
"wasm":false |
A boolean for WebAssembly module support. (Node 8+) | ||||||||||||||||||||||
} |
{ | |
"cache":true |
A boolean for toggling cache creation or a cache directory path. |
"sourceMap":false |
A boolean for including inline source maps. |
} |
For bundlers like browserify
+esmify
,
parcel-bundler
, and webpack
add a "module"
field to package.json
pointing to the main ES module.
"main": "index.js", "module": "main.js"
:bulb: This is automagically done with npm init esm
or yarn create esm
.
esm
for wallaby.js
following their
integration example.Load esm
before loaders/monitors like
@babel/register
,
newrelic
,
sqreen
, and
ts-node
.
Load esm
for jasmine
using the
"helpers"
field in jasmine.json
:
"helpers": [ "node_modules/esm" ]
Load esm
with “node-args" options of:
pm2
: --node-args="-r esm"
Load esm
with “require” options of
ava
,
mocha
,
nodemon
,
nyc
,
qunit
,
tape
, and
webpack
.
:bulb: Builtin require
cannot sideload .mjs
files. However, .js
files
can be sideloaded or .mjs
files may be loaded with dynamic import
.
Reason
license file detected
Details
Reason
binaries present in source code
Details
Reason
Found 4/30 approved changesets -- score normalized to 1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Reason
project is not fuzzed
Details
Reason
91 existing vulnerabilities detected
Details
Score
Last Scanned on 2024-09-02
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More