mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
1c0009d2c0
* chore(agnostic): ship CJS and ESM builds
For our work to enable Puppeteer in other environments (e.g. a browser)
we need to ship an ESM build. This commit changes our config to ship to
`lib/cjs` and `lib/esm` accordingly. The majority of our code stays the
same, with one small fix for the CJS build to ensure that we ship a
version that lets you `require('puppeteer')` rather than have to
`require('puppeteer').default`. We do this with the `cjs-entry.js` which
is what the `main` field in our `package.json` points to.
We also swap to `read-pkg-up` to find the `package.json` file. This is
because the folder structure of `lib/` does not match `src/` now we ship
to `cjs` and `esm`, so you cannot rely on exact paths. This module works
up from the file to find the nearest `package.json` so it will always
find Puppeteer's `package.json`.
Note that we *do not* point any users to the ESM build. We happen to
ship those files so people who know about them can get at them but it's
not expected (nor will we actively support) that people will rely on
them. The CommonJS build is considered our main build.
We may make breaking changes to the structure of the ESM build which we
will do without requiring new major versions. For example the ESM build
currently ships all files that the CJS build does, but given we are
working on the ESM build being able to run in the browser this may
change over time.
Long term once the Node versions catch up we can ditch CJS and ship
exclusively ESM but we are not there yet.
25 lines
792 B
Bash
Executable File
25 lines
792 B
Bash
Executable File
#!/usr/bin/env sh
|
|
set -e
|
|
|
|
# Pack the module into a tarball
|
|
npm pack
|
|
tarball="$(realpath puppeteer-*.tgz)"
|
|
TMPDIR="$(mktemp -d)"
|
|
cd $TMPDIR
|
|
# Check we can install from the tarball.
|
|
# This emulates installing from npm and ensures that:
|
|
# 1. we publish the right files in the `files` list from package.json
|
|
# 2. The install script works and correctly exits without errors
|
|
# 3. Requiring Puppeteer from Node works.
|
|
npm install --loglevel silent "${tarball}"
|
|
node --eval="require('puppeteer')"
|
|
ls $TMPDIR/node_modules/puppeteer/.local-chromium/
|
|
|
|
# Again for Firefox
|
|
TMPDIR="$(mktemp -d)"
|
|
cd $TMPDIR
|
|
PUPPETEER_PRODUCT=firefox npm install --loglevel silent "${tarball}"
|
|
node --eval="require('puppeteer')"
|
|
rm "${tarball}"
|
|
ls $TMPDIR/node_modules/puppeteer/.local-firefox/linux-79.0a1/firefox/firefox
|