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.
109 lines
4.0 KiB
JSON
109 lines
4.0 KiB
JSON
{
|
|
"name": "puppeteer",
|
|
"version": "4.0.0-post",
|
|
"description": "A high-level API to control headless Chrome over the DevTools Protocol",
|
|
"main": "./cjs-entry.js",
|
|
"repository": "github:puppeteer/puppeteer",
|
|
"engines": {
|
|
"node": ">=10.18.1"
|
|
},
|
|
"puppeteer": {
|
|
"chromium_revision": "756035",
|
|
"firefox_revision": "latest"
|
|
},
|
|
"scripts": {
|
|
"unit": "tsc --version && mocha --config mocha-config/puppeteer-unit-tests.js",
|
|
"unit-with-coverage": "cross-env COVERAGE=1 npm run unit",
|
|
"assert-unit-coverage": "cross-env COVERAGE=1 mocha --config mocha-config/coverage-tests.js",
|
|
"funit": "PUPPETEER_PRODUCT=firefox npm run unit",
|
|
"debug-unit": "node --inspect-brk test/test.js",
|
|
"test-doclint": "mocha --config mocha-config/doclint-tests.js",
|
|
"test": "npm run tsc && npm run lint --silent && npm run unit-with-coverage && npm run test-doclint && npm run test-types",
|
|
"prepare": "node typescript-if-required.js",
|
|
"prepublishOnly": "npm run tsc",
|
|
"dev-install": "npm run tsc && node install.js",
|
|
"install": "node install.js",
|
|
"eslint": "([ \"$CI\" = true ] && eslint --ext js --ext ts --quiet -f codeframe . || eslint --ext js --ext ts .)",
|
|
"eslint-fix": "eslint --ext js --ext ts --fix .",
|
|
"lint": "npm run eslint && npm run tsc && npm run doc",
|
|
"doc": "node utils/doclint/cli.js",
|
|
"clean-lib": "rm -rf lib",
|
|
"tsc": "npm run clean-lib && tsc --version && npm run tsc-cjs && npm run tsc-esm",
|
|
"tsc-cjs": "tsc -p . && cp src/protocol.d.ts lib/cjs",
|
|
"tsc-esm": "tsc --build tsconfig-esm.json && cp src/protocol.d.ts lib/esm",
|
|
"apply-next-version": "node utils/apply_next_version.js",
|
|
"update-protocol-d-ts": "node utils/protocol-types-generator update",
|
|
"compare-protocol-d-ts": "node utils/protocol-types-generator compare",
|
|
"test-install": "scripts/test-install.sh",
|
|
"generate-docs": "npm run tsc && api-extractor run --local --verbose && api-documenter markdown -i temp -o new-docs",
|
|
"ensure-new-docs-up-to-date": "npm run generate-docs && exit `git status --porcelain | head -255 | wc -l`",
|
|
"generate-dependency-graph": "echo 'Requires graphviz installed locally!' && depcruise --exclude 'api.ts' --do-not-follow '^node_modules' --output-type dot src/index.ts | dot -T png > dependency-chart.png"
|
|
},
|
|
"files": [
|
|
"lib/",
|
|
"index.js",
|
|
"install.js",
|
|
"typescript-if-required.js",
|
|
"cjs-entry.js"
|
|
],
|
|
"author": "The Chromium Authors",
|
|
"license": "Apache-2.0",
|
|
"dependencies": {
|
|
"debug": "^4.1.0",
|
|
"extract-zip": "^2.0.0",
|
|
"https-proxy-agent": "^4.0.0",
|
|
"mime": "^2.0.3",
|
|
"mitt": "^2.0.1",
|
|
"progress": "^2.0.1",
|
|
"proxy-from-env": "^1.0.0",
|
|
"read-pkg-up": "^7.0.1",
|
|
"rimraf": "^3.0.2",
|
|
"tar-fs": "^2.0.0",
|
|
"unbzip2-stream": "^1.3.3",
|
|
"ws": "^7.2.3"
|
|
},
|
|
"devDependencies": {
|
|
"@microsoft/api-documenter": "7.8.14",
|
|
"@microsoft/api-extractor": "7.8.12",
|
|
"@types/debug": "0.0.31",
|
|
"@types/mime": "^2.0.0",
|
|
"@types/mocha": "^7.0.2",
|
|
"@types/node": "^14.0.13",
|
|
"@types/proxy-from-env": "^1.0.1",
|
|
"@types/rimraf": "^2.0.2",
|
|
"@types/tar-fs": "^1.16.2",
|
|
"@types/ws": "^7.2.4",
|
|
"@typescript-eslint/eslint-plugin": "^2.28.0",
|
|
"@typescript-eslint/parser": "^2.28.0",
|
|
"commonmark": "^0.28.1",
|
|
"cross-env": "^5.0.5",
|
|
"dependency-cruiser": "^9.7.0",
|
|
"eslint": "^6.8.0",
|
|
"eslint-config-prettier": "^6.11.0",
|
|
"eslint-plugin-mocha": "^6.3.0",
|
|
"eslint-plugin-prettier": "^3.1.3",
|
|
"eslint-plugin-unicorn": "^19.0.1",
|
|
"esprima": "^4.0.0",
|
|
"expect": "^25.2.7",
|
|
"jpeg-js": "^0.3.7",
|
|
"minimist": "^1.2.0",
|
|
"mocha": "^8.0.1",
|
|
"ncp": "^2.0.0",
|
|
"pixelmatch": "^4.0.2",
|
|
"pngjs": "^5.0.0",
|
|
"prettier": "^2.0.5",
|
|
"sinon": "^9.0.2",
|
|
"text-diff": "^1.0.1",
|
|
"ts-node": "^8.10.2",
|
|
"typescript": "3.9.5"
|
|
},
|
|
"browser": {
|
|
"./lib/BrowserFetcher.js": false,
|
|
"ws": "./utils/browser/WebSocket",
|
|
"fs": false,
|
|
"child_process": false,
|
|
"rimraf": false,
|
|
"readline": false
|
|
}
|
|
}
|