Skip to content

Commit f484f0c

Browse files
committed
chore: add readme
1 parent 536aa16 commit f484f0c

File tree

4 files changed

+477
-0
lines changed

4 files changed

+477
-0
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/node_modules
2+
*.swp

README.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# `@cjs-bundle/*`
2+
3+
This repo holds the scripts for building NPM packages as commonjs bundles.
4+
5+
As packages modernise, they are migrating to
6+
[ES modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules).
7+
In many cases, they choose to no longer offer (and therefore maintain) a common
8+
JS entrypoint.
9+
10+
In an ideal world, everyone would move to ES modules and all would be well.
11+
However, not everyone has the time or priority yet to do such a migration (and
12+
it often isn't a small job).
13+
14+
The job of this repository is to create common JS bundles of those "ESM-only"
15+
packages so you can still upgrade for whatever reason, without having to
16+
migrate yet.
17+
18+
# Usage
19+
20+
Find a supported package and install the `cjs-bundle` version like so:
21+
22+
```sh
23+
npm i -D @cjs-bundle/chai
24+
```
25+
26+
# Supported packages
27+
28+
This is a list of all packages we provide legacy common JS bundles for.
29+
30+
N/A

0 commit comments

Comments
 (0)