puppeteer/api-extractor.json

{
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
  "mainEntryPointFilePath": "<projectFolder>/lib/cjs/api-docs-entry.d.ts",
  "bundledPackages": [ ],

  "apiReport": {
    "enabled": false
  },

  "docModel": {
    "enabled": true
  },

  "dtsRollup": {
    "enabled": false
  },

  "tsdocMetadata": {
    "enabled": false
  },

  "messages": {
    "compilerMessageReporting": {
      "default": {
        "logLevel": "warning"
      }
    },

    "extractorMessageReporting": {
      "default": {
        "logLevel": "warning"
      }
    },

    "tsdocMessageReporting": {
      "default": {
        "logLevel": "warning"
      }
    }
  }

}
chore: Introduce API Extractor and start generating documentation (#5967) 2020-06-04 10:47:13 +00:00			`{`
			`"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",`
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			`"mainEntryPointFilePath": "<projectFolder>/lib/cjs/api-docs-entry.d.ts",`
chore: Introduce API Extractor and start generating documentation (#5967) 2020-06-04 10:47:13 +00:00			`"bundledPackages": [ ],`

			`"apiReport": {`
			`"enabled": false`
			`},`

			`"docModel": {`
			`"enabled": true`
			`},`

			`"dtsRollup": {`
			`"enabled": false`
			`},`

			`"tsdocMetadata": {`
			`"enabled": false`
			`},`

			`"messages": {`
			`"compilerMessageReporting": {`
			`"default": {`
			`"logLevel": "warning"`
			`}`
			`},`

			`"extractorMessageReporting": {`
			`"default": {`
			`"logLevel": "warning"`
			`}`
			`},`

			`"tsdocMessageReporting": {`
			`"default": {`
			`"logLevel": "warning"`
			`}`
			`}`
			`}`

			`}`