puppeteer/tsconfig.json

{
  "compilerOptions": {
    "allowJs": true,
    "checkJs": true,
    "outDir": "./lib",
    "target": "ESNext",
    "moduleResolution": "node",
    "module": "CommonJS"
  },
  "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: 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			`"outDir": "./lib",`
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",`
			`"module": "CommonJS"`
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			`]`
			`}`