From 02c9af62d64060a83f53368640f343ae2e30e38a Mon Sep 17 00:00:00 2001 From: Johan Bay Date: Fri, 10 Dec 2021 09:02:28 +0100 Subject: [PATCH] fix(types): revert "feat(typescript): allow using puppeteer without dom lib" Reverts #6998 We unfortunately have to revert this commit for two reasons: The approach for generating types.d.ts implemented in the commit invalidates triple-slash compiler directives since it prepends a declaration before the types.d.ts generated by api-extractor. In particular, the directive /// in the final types.d.ts is ignored by the typescript compiler making module resolution fail. The commit makes Puppeteer types ship without DOM types per default. This is not ideal since Puppeteer (and usage of Puppeteer) relies heavily on interacting with DOM elements. --- inject-global-type-stubs.js | 29 ----------------------------- package.json | 2 +- src/global.ts | 20 -------------------- 3 files changed, 1 insertion(+), 50 deletions(-) delete mode 100644 inject-global-type-stubs.js delete mode 100644 src/global.ts diff --git a/inject-global-type-stubs.js b/inject-global-type-stubs.js deleted file mode 100644 index adc634990321c..0000000000000 --- a/inject-global-type-stubs.js +++ /dev/null @@ -1,29 +0,0 @@ -/** - * Copyright 2021 Google Inc. All rights reserved. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -// This script is needed because of https://github.com/microsoft/rushstack/issues/1709 -const { promises: fs } = require('fs'); -const { join } = require('path'); - -async function injctGlobalTypeStubs() { - const typesPath = join(__dirname, 'lib', 'types.d.ts'); - const globalsPath = join(__dirname, 'lib', 'cjs', 'puppeteer', 'global.d.ts'); - const types = await fs.readFile(typesPath, 'utf-8'); - const globals = await fs.readFile(globalsPath, 'utf-8'); - await fs.writeFile(typesPath, `${globals}\n${types}`); -} - -injctGlobalTypeStubs(); diff --git a/package.json b/package.json index 931b149b2b6db..6913c4a4b7649 100644 --- a/package.json +++ b/package.json @@ -36,7 +36,7 @@ "apply-next-version": "node utils/apply_next_version.js", "test-install": "scripts/test-install.sh", "clean-docs": "rimraf website/docs && rimraf docs-api-json", - "generate-d-ts": "npm run clean-docs && api-extractor run --local --verbose && node inject-global-type-stubs.js", + "generate-d-ts": "npm run clean-docs && api-extractor run --local --verbose", "generate-docs": "npm run generate-d-ts && api-documenter markdown -i docs-api-json -o website/docs && node utils/remove-tag.js", "ensure-correct-devtools-protocol-revision": "ts-node -s scripts/ensure-correct-devtools-protocol-package", "ensure-pinned-deps": "ts-node -s scripts/ensure-pinned-deps", diff --git a/src/global.ts b/src/global.ts deleted file mode 100644 index 2dce058df26ee..0000000000000 --- a/src/global.ts +++ /dev/null @@ -1,20 +0,0 @@ -/** - * These global declarations exist so puppeteer can work without the need to use `"dom"` - * types. - * - * To get full type information for these interfaces, add `"types": "dom"`in your - * `tsconfig.json` file. - */ -declare global { - // eslint-disable-next-line @typescript-eslint/no-empty-interface - interface Document {} - - // eslint-disable-next-line @typescript-eslint/no-empty-interface - interface Element {} - - // eslint-disable-next-line max-len - // eslint-disable-next-line @typescript-eslint/no-empty-interface, @typescript-eslint/no-unused-vars - interface NodeListOf {} -} - -export {};