puppeteer/tsconfig.json

{
  "compilerOptions": {
    "allowJs": true,
    "checkJs": true,
    "outDir": "./lib/cjs",
    "target": "ESNext",
    "moduleResolution": "node",
    "module": "CommonJS",
    "declaration": true,
    "declarationMap": true,
    "esModuleInterop": true,
    "resolveJsonModule": true
  },
  "include": [
    "src"
  ]
}
chore: Use Typescript to lint JSDoc annotations (#986) This patch starts using typescript to lint JSDoc annotations. Note: this uses typescript's bleeding edge. We should migrate to stable once it has all the necessary bugfixes. References #65. 2017-10-10 05:31:40 +00:00			`{`
			`"compilerOptions": {`
			`"allowJs": true,`
			`"checkJs": true,`
chore(agnostic): ship CJS and ESM builds (#6095) * 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. 2020-06-25 13:24:46 +00:00			`"outDir": "./lib/cjs",`
chore(deps): update extract-zip to version 2 (#5610) extract-zip removed support for callbacks and instead uses promises. Moreover, it has TypeScript support which allows us to remove the @types/extract-zip package. This update allows downstream users to remove their installation of mkdirp, which uses a vulnerable version of minimist. For more info, see https://github.com/maxogden/extract-zip/releases/tag/v2.0.0 Co-authored-by: Mathias Bynens <mathias@qiwi.be> 2020-04-09 19:13:25 +00:00			`"target": "ESNext",`
feat(TypeScript): move DeviceDescriptors to TS (#5595) This commit moves `src/DeviceDescriptors` to be authored in TypeScript. This file was chosen due to its simplicity so that we can focus on getting a mixed JS/TS codebase playing nicely before migrating the more complex files. The file itself was a bit odd: although the array of devices was exported via `module.exports` that was never referenced by any consumers; each device was also exported via `module.exports[name] = device` and that is how it's consumed. The Puppeteer docs suggest using it like so: ```js puppeteer.devices['iPhone 6'] ``` So instead of exporting the array and then setting a bunch of properties on that, we instead define the array and export an object of keys where each key is a device. This is a breaking change (see the footer for details). Rather than export an object I'd much rather export a Map, but that would be a larger breaking change and I'm keen to avoid those for the time being. Note that we have to use special TypeScript specific syntax for the export that enables it to work in a CommonJS codebase [1] but again I'd rather this than move to ESM at this time. TypeScript still outputs CommonJS into `lib/` as you would expect. BREAKING CHANGE: We no longer export an array of devices, so any users relying on doing: ```js puppeter.devices.forEach(...) ``` …will now see a breakage. The fix is to use `Object.{keys/entries/values}` to iterate instead. [1]: https://www.typescriptlang.org/docs/handbook/modules.html#export--and-import--require 2020-04-14 09:55:29 +00:00			`"moduleResolution": "node",`
chore: Introduce API Extractor and start generating documentation (#5967) 2020-06-04 10:47:13 +00:00			`"module": "CommonJS",`
			`"declaration": true,`
chore: migrate away from Node's EventEmitter (#5979) 2020-06-15 10:52:19 +00:00			`"declarationMap": true,`
chore: migrate tests to TypeScript (#6075) This CL migrates all the tests to TypeScript. The main benefits of this is that we start consuming our TypeScript definitions and therefore find errors in them. The act of migrating found some bugs in our definitions and now we can be sure to avoid them going forwards. You'll notice the addition of some `TODO`s in the code; I didn't want this CL to get any bigger than it already is but I intend to follow those up once this lands. It's mostly figuring out how to extend the `expect` types with our `toBeGolden` helpers and some other slight confusions with types that the tests exposed. Co-authored-by: Mathias Bynens <mathias@qiwi.be> 2020-06-23 05:18:46 +00:00			`"esModuleInterop": true,`
			`"resolveJsonModule": true`
chore: Use Typescript to lint JSDoc annotations (#986) This patch starts using typescript to lint JSDoc annotations. Note: this uses typescript's bleeding edge. We should migrate to stable once it has all the necessary bugfixes. References #65. 2017-10-10 05:31:40 +00:00			`},`
			`"include": [`
chore: move code to src/ and emit with TypeScript (#5568) This updates our `tsconfig.json` so it emits our JavaScript files as well as type checking them. We compile into `./lib` which we then ship in our npm package. The source code has moved from `./lib` into `./src`. Because the `src/` directory is exclusively JS files, this change is a no-op in terms of code functionality but is the first step towards being able to replace `src/X.js` with `src/X.ts` in a way that allows us to migrate incrementally. The `lib` directory is gitignored, and the `src` directory is npmignored. On `npm publish` we will now run `npm run tsc` in order to generate the outputted code. 2020-04-02 14:25:19 +00:00			`"src"`
chore: Use Typescript to lint JSDoc annotations (#986) This patch starts using typescript to lint JSDoc annotations. Note: this uses typescript's bleeding edge. We should migrate to stable once it has all the necessary bugfixes. References #65. 2017-10-10 05:31:40 +00:00			`]`
			`}`