diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96d528cb5214c..043bf03705c67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -119,6 +119,10 @@ The main entry point for the Node module Puppeteer is `cjs-entry.js`. This impor We also maintain `test/tsconfig.test.json`. This is **only used to compile the unit test `*.spec.ts` files**. When the tests are run, we first compile Puppeteer as normal before running the unit tests **against the compiled output**. Doing this lets the test run against the compiled code we ship to users so it gives us more confidence in our compiled output being correct. +### Root `tsconfig.json` + +The root `tsconfig.json` exists for the API Extractor; it has to find a `tsconfig.json` in the project's root directory. It is _not_ used for anything else. + ## API guidelines diff --git a/api-extractor.json b/api-extractor.json index b388a148a4906..3e7b9e66f625e 100644 --- a/api-extractor.json +++ b/api-extractor.json @@ -1,6 +1,6 @@ { "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", - "mainEntryPointFilePath": "/lib/cjs/api-docs-entry.d.ts", + "mainEntryPointFilePath": "/lib/cjs/puppeteer/api-docs-entry.d.ts", "bundledPackages": [ "devtools-protocol" ], "apiReport": { diff --git a/new-docs/puppeteer.md b/new-docs/puppeteer.md index 5e64b8e168171..ee5c2de12a696 100644 --- a/new-docs/puppeteer.md +++ b/new-docs/puppeteer.md @@ -85,7 +85,7 @@ | Namespace | Description | | --- | --- | -| [Protocol](./puppeteer.protocol.md) | \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* Auto-generated by protocol-dts-generator.ts, do not edit manually. \* \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* | +| [Protocol](./puppeteer.protocol.md) | The Chrome DevTools protocol. | ## Variables diff --git a/new-docs/puppeteer.protocol.css.cssmedia.md b/new-docs/puppeteer.protocol.css.cssmedia.md index 3c79ef5fb021d..3efb162b165dc 100644 --- a/new-docs/puppeteer.protocol.css.cssmedia.md +++ b/new-docs/puppeteer.protocol.css.cssmedia.md @@ -18,7 +18,7 @@ export interface CSSMedia | --- | --- | --- | | [mediaList](./puppeteer.protocol.css.cssmedia.medialist.md) | [MediaQuery](./puppeteer.protocol.css.mediaquery.md)\[\] | Array of media queries. | | [range](./puppeteer.protocol.css.cssmedia.range.md) | [SourceRange](./puppeteer.protocol.css.sourcerange.md) | The associated rule (@media or @import) header range in the enclosing stylesheet (if available). | -| [source](./puppeteer.protocol.css.cssmedia.source.md) | ('mediaRule' \| 'importRule' \| 'linkedSheet' \| 'inlineSheet') | Source of the media query: "mediaRule" if specified by a rule, "importRule" if specified by an rule, "linkedSheet" if specified by a "media" attribute in a linked stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline stylesheet's STYLE tag. | +| [source](./puppeteer.protocol.css.cssmedia.source.md) | ('mediaRule' \| 'importRule' \| 'linkedSheet' \| 'inlineSheet') | Source of the media query: "mediaRule" if specified by a @media rule, "importRule" if specified by an @import rule, "linkedSheet" if specified by a "media" attribute in a linked stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline stylesheet's STYLE tag. | | [sourceURL](./puppeteer.protocol.css.cssmedia.sourceurl.md) | string | URL of the document containing the media query description. | | [styleSheetId](./puppeteer.protocol.css.cssmedia.stylesheetid.md) | [StyleSheetId](./puppeteer.protocol.css.stylesheetid.md) | Identifier of the stylesheet containing this object (if exists). | | [text](./puppeteer.protocol.css.cssmedia.text.md) | string | Media query text. | diff --git a/new-docs/puppeteer.protocol.css.cssmedia.source.md b/new-docs/puppeteer.protocol.css.cssmedia.source.md index ea482440c3f65..158fff3386b16 100644 --- a/new-docs/puppeteer.protocol.css.cssmedia.source.md +++ b/new-docs/puppeteer.protocol.css.cssmedia.source.md @@ -4,7 +4,7 @@ ## Protocol.CSS.CSSMedia.source property -Source of the media query: "mediaRule" if specified by a rule, "importRule" if specified by an rule, "linkedSheet" if specified by a "media" attribute in a linked stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline stylesheet's STYLE tag. +Source of the media query: "mediaRule" if specified by a `@media` rule, "importRule" if specified by an `@import` rule, "linkedSheet" if specified by a "media" attribute in a linked stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline stylesheet's STYLE tag. Signature: diff --git a/new-docs/puppeteer.protocol.md b/new-docs/puppeteer.protocol.md index 587ee69698bd0..ed932d4facd27 100644 --- a/new-docs/puppeteer.protocol.md +++ b/new-docs/puppeteer.protocol.md @@ -4,7 +4,7 @@ ## Protocol namespace -\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* Auto-generated by protocol-dts-generator.ts, do not edit manually. \* \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* +The Chrome DevTools protocol. Signature: diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000000000..69717ed6d9b2e --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,11 @@ +/** + * This configuration only exists for the API Extractor tool. See the details in + * CONTRIBUTING.md that describes our TypeScript setup. +*/ +{ + "extends": "./tsconfig.base.json", + "compilerOptions": { + "noEmit": true + }, + "include": ["src"] +}