chore(agnostic): ship CJS and ESM builds #6095
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@TimvdLippe PTAL also - you have more TS config experience than me so I'm open to different ways of solving this! |
jackfranklin
force-pushed
the
publish-esm-build
branch
from
230bba9
to
d7aa115
Compare
TimvdLippe
approved these changes
Jun 24, 2020
paullewis
reviewed
Jun 24, 2020
| @@ -23,6 +23,7 @@ import { ProductLauncher } from '../node/Launcher'; | |||
| import { BrowserFetcher, BrowserFetcherOptions } from '../node/BrowserFetcher'; | |||
| import { puppeteerErrors, PuppeteerErrors } from './Errors'; | |||
| import { ConnectionTransport } from './ConnectionTransport'; | |||
| import readPkgUp from 'read-pkg-up'; | |||
There was a problem hiding this comment.
Does this work in the browser as well as node?
There was a problem hiding this comment.
No. This is on my list to figure out. The old solution wouldn't have worked either.
I think it only needs to use the package.json in order to know which browser revision to download which is not needed in the browser; the work here is to try to prise that code out into a node specific function.
jackfranklin
force-pushed
the
publish-esm-build
branch
2 times, most recently
from
98f9c8a
to
b606c24
Compare
mathiasbynens
force-pushed
the
main
branch
2 times, most recently
from
57cd057
to
a4d12a2
Compare
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.
mathiasbynens
force-pushed
the
publish-esm-build
branch
from
48173f4
to
b0c895f
Compare
mathiasbynens
approved these changes
Jun 25, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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/cjsandlib/esmaccordingly. 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 yourequire('puppeteer')rather than have torequire('puppeteer').default. We do this with thecjs-entry.jswhich is what themainfield in ourpackage.jsonpoints to.We also swap to
read-pkg-upto find thepackage.jsonfile. This is because the folder structure oflib/does not matchsrc/now we ship tocjsandesm, so you cannot rely on exact paths. This module works up from the file to find the nearestpackage.jsonso it will always find Puppeteer'spackage.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.