From aa1d1536b698cf02a75c3ef3c8c0e8c9527aba50 Mon Sep 17 00:00:00 2001 From: Nikolay Vitkov <34244704+Lightning00Blade@users.noreply.github.com> Date: Mon, 30 Jan 2023 13:30:49 +0100 Subject: [PATCH] chore: Update build dependencies (#9600) --- docs/contributing.md | 18 ++++++++++++-- package-lock.json | 24 +++++++++---------- package.json | 3 ++- .../puppeteer-core/api-extractor.docs.json | 15 ++++++++++++ packages/puppeteer-core/api-extractor.json | 3 +-- packages/puppeteer-core/package.json | 11 +++++++-- packages/puppeteer/api-extractor.docs.json | 15 ++++++++++++ packages/puppeteer/api-extractor.json | 3 +-- packages/puppeteer/package.json | 9 ++++++- 9 files changed, 79 insertions(+), 22 deletions(-) create mode 100644 packages/puppeteer-core/api-extractor.docs.json create mode 100644 packages/puppeteer/api-extractor.docs.json diff --git a/docs/contributing.md b/docs/contributing.md index c6b9c4a0..a456b0da 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -27,7 +27,9 @@ again. 2. Install the dependencies ```sh - npm install # or PUPPETEER_PRODUCT=firefox npm install + npm install + # Or to download Firefox + PUPPETEER_PRODUCT=firefox npm install ``` 3. Build all packages @@ -61,7 +63,7 @@ again. ## Building a single package -To build a single package, you can run +To build a single package, you can run: ```sh npm run build --workspace # e.g. puppeteer @@ -72,6 +74,18 @@ packages is sufficient. This is all possible due to [wireit](https://github.com/google/wireit) which behaves similar to [GNU Make](https://www.gnu.org/software/make/). +### Watch mode + +To continuously build a package, you can run: + +```sh +npm run build --watch --workspace # e.g. puppeteer +``` + +You have to only specify a single package to watch else things will not work as expected +As stated above because of [wireit](https://github.com/google/wireit) when a change happens +all dependencies will be build or rebuild (if needed). + ## Removing stale artifacts It's possible some generated artifacts (such as diff --git a/package-lock.json b/package-lock.json index 1c10443e..8827b4e3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5617,9 +5617,9 @@ "dev": true }, "node_modules/json5": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.1.tgz", - "integrity": "sha512-1hqLFMSrGHRHxav9q9gNjJ5EXznIxGVO09xQRrwplcS8qs28pZ8s8hupZAmqDwZUmVZ2Qb2jnyPOWcDH8m8dlA==", + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", + "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", "dev": true, "bin": { "json5": "lib/cli.js" @@ -8040,9 +8040,9 @@ } }, "node_modules/tsconfig-paths/node_modules/json5": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz", - "integrity": "sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.2.tgz", + "integrity": "sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA==", "dev": true, "dependencies": { "minimist": "^1.2.0" @@ -13050,9 +13050,9 @@ "dev": true }, "json5": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.1.tgz", - "integrity": "sha512-1hqLFMSrGHRHxav9q9gNjJ5EXznIxGVO09xQRrwplcS8qs28pZ8s8hupZAmqDwZUmVZ2Qb2jnyPOWcDH8m8dlA==", + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", + "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", "dev": true }, "jsonc-parser": { @@ -14905,9 +14905,9 @@ }, "dependencies": { "json5": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz", - "integrity": "sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.2.tgz", + "integrity": "sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA==", "dev": true, "requires": { "minimist": "^1.2.0" diff --git a/package.json b/package.json index a559d87f..5491334e 100644 --- a/package.json +++ b/package.json @@ -8,12 +8,13 @@ "scripts": { "bisect": "tsx tools/bisect.ts", "build": "npm run build --workspaces --if-present", + "build:docs": "npm run build:docs --workspace puppeteer --if-present", "check:pinned-deps": "tsx tools/ensure-pinned-deps", "check": "npm run check --workspaces --if-present && run-p check:*", "clean": "npm run clean --workspaces --if-present && rimraf **/.wireit", "commitlint": "commitlint --from=HEAD~1", "debug": "mocha --inspect-brk", - "docs": "run-s build generate:markdown", + "docs": "run-s build:docs generate:markdown", "format:eslint": "eslint --ext js --ext ts --fix .", "format:prettier": "prettier --write .", "format": "run-s format:*", diff --git a/packages/puppeteer-core/api-extractor.docs.json b/packages/puppeteer-core/api-extractor.docs.json new file mode 100644 index 00000000..b0bcacbb --- /dev/null +++ b/packages/puppeteer-core/api-extractor.docs.json @@ -0,0 +1,15 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + "mainEntryPointFilePath": "/lib/esm/puppeteer/puppeteer-core.d.ts", + + "extends": "./api-extractor.json", + + "dtsRollup": { + "enabled": false + }, + + "docModel": { + "enabled": true, + "apiJsonFilePath": "/../../docs/.api.json" + } +} diff --git a/packages/puppeteer-core/api-extractor.json b/packages/puppeteer-core/api-extractor.json index df82b3dc..7b9032de 100644 --- a/packages/puppeteer-core/api-extractor.json +++ b/packages/puppeteer-core/api-extractor.json @@ -8,8 +8,7 @@ }, "docModel": { - "enabled": true, - "apiJsonFilePath": "/../../docs/.api.json" + "enabled": false }, "dtsRollup": { diff --git a/packages/puppeteer-core/package.json b/packages/puppeteer-core/package.json index 55c5d62a..d53e2bab 100644 --- a/packages/puppeteer-core/package.json +++ b/packages/puppeteer-core/package.json @@ -37,6 +37,7 @@ "build:third_party": "wireit", "build:tsc": "wireit", "build:types": "wireit", + "build:docs": "wireit", "build": "wireit", "check": "tsx tools/ensure-correct-devtools-protocol-package", "format:types": "wireit", @@ -58,6 +59,7 @@ }, "build": { "dependencies": [ + "build:tsc", "build:third_party", "format:types", "generate:package-json" @@ -83,8 +85,7 @@ ], "clean": false, "files": [ - "lib/esm/third_party/**", - "lib/cjs/third_party/**" + "third_party/**" ], "output": [ "lib/esm/third_party/**", @@ -115,6 +116,12 @@ "lib/types.d.ts" ] }, + "build:docs": { + "command": "api-extractor run --local --config \"./api-extractor.docs.json\"", + "dependencies": [ + "build:tsc" + ] + }, "format:types": { "command": "eslint --cache-location .eslintcache --cache --ext=ts --no-ignore --no-eslintrc -c=../../.eslintrc.types.cjs --fix lib/types.d.ts", "dependencies": [ diff --git a/packages/puppeteer/api-extractor.docs.json b/packages/puppeteer/api-extractor.docs.json new file mode 100644 index 00000000..88fcdbfd --- /dev/null +++ b/packages/puppeteer/api-extractor.docs.json @@ -0,0 +1,15 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + "mainEntryPointFilePath": "/lib/esm/puppeteer/puppeteer.d.ts", + + "extends": "./api-extractor.json", + + "dtsRollup": { + "enabled": false + }, + + "docModel": { + "enabled": true, + "apiJsonFilePath": "/../../docs/.api.json" + } +} diff --git a/packages/puppeteer/api-extractor.json b/packages/puppeteer/api-extractor.json index 2a104692..486b3929 100644 --- a/packages/puppeteer/api-extractor.json +++ b/packages/puppeteer/api-extractor.json @@ -8,8 +8,7 @@ }, "docModel": { - "enabled": true, - "apiJsonFilePath": "/../../docs/.api.json" + "enabled": false }, "dtsRollup": { diff --git a/packages/puppeteer/package.json b/packages/puppeteer/package.json index 225a848a..907ffe78 100644 --- a/packages/puppeteer/package.json +++ b/packages/puppeteer/package.json @@ -36,11 +36,11 @@ "scripts": { "build:tsc": "wireit", "build:types": "wireit", + "build:docs": "wireit", "build": "wireit", "clean": "tsc -b --clean && rimraf lib", "format:types": "wireit", "generate:package-json": "wireit", - "generate:sources": "wireit", "postinstall": "node install.js", "prepack": "wireit" }, @@ -56,6 +56,7 @@ }, "build": { "dependencies": [ + "build:tsc", "format:types", "generate:package-json" ] @@ -84,6 +85,12 @@ "lib/types.d.ts" ] }, + "build:docs": { + "command": "api-extractor run --local --config \"./api-extractor.docs.json\"", + "dependencies": [ + "build:tsc" + ] + }, "format:types": { "command": "eslint --cache-location .eslintcache --cache --ext=ts --no-ignore --no-eslintrc -c=../../.eslintrc.types.cjs --fix lib/types.d.ts", "dependencies": [