chore: fix ESLint violation and lessen rule strictness (#6081)

.eslintrc.js

@@ -100,6 +100,11 @@ module.exports = {
                 "@typescript-eslint/semi": 2,
                 "@typescript-eslint/no-empty-function": 0,
                 "@typescript-eslint/no-use-before-define": 0,
+                // We have to use any on some types so the warning isn't valuable.
+                "@typescript-eslint/no-explicit-any": 0,
+                // We don't require explicit return types on basic functions or
+                // dummy functions in tests, for example
+                "@typescript-eslint/explicit-function-return-type": 0,
                 // We know it's bad and use it very sparingly but it's needed :(
                 "@typescript-eslint/ban-ts-ignore": 0,
                 "@typescript-eslint/array-type": [2, {

new-docs/puppeteer.browsercontext.waitfortarget.md

@@ -9,7 +9,7 @@ This searches for a target in this specific browser context.
 <b>Signature:</b>
 
 ```typescript
-waitForTarget(predicate: (x: Target) => boolean, options: {
+waitForTarget(predicate: (x: Target) => boolean, options?: {
         timeout?: number;
     }): Promise<Target>;
 ```

new-docs/puppeteer.browserfetcher.download.md

@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-download(revision: string, progressCallback: (x: number, y: number) => void): Promise<BrowserFetcherRevisionInfo>;
+download(revision: string, progressCallback?: (x: number, y: number) => void): Promise<BrowserFetcherRevisionInfo>;
 ```
 
 ## Parameters

new-docs/puppeteer.coverage.startcsscoverage.md

@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-startCSSCoverage(options: {
+startCSSCoverage(options?: {
         resetOnNavigation?: boolean;
     }): Promise<void>;
 ```

new-docs/puppeteer.coverage.startjscoverage.md

@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-startJSCoverage(options: {
+startJSCoverage(options?: {
         resetOnNavigation?: boolean;
         reportAnonymousScripts?: boolean;
     }): Promise<void>;

new-docs/puppeteer.elementhandle.click.md

@@ -9,7 +9,7 @@ This method scrolls element into view if needed, and then uses [Page.mouse](./pu
 <b>Signature:</b>
 
 ```typescript
-click(options: ClickOptions): Promise<void>;
+click(options?: ClickOptions): Promise<void>;
 ```
 
 ## Parameters

new-docs/puppeteer.frame.click.md

@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-click(selector: string, options: {
+click(selector: string, options?: {
         delay?: number;
         button?: MouseButtonInput;
         clickCount?: number;

new-docs/puppeteer.frame.waitfornavigation.md

@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-waitForNavigation(options: {
+waitForNavigation(options?: {
         timeout?: number;
         waitUntil?: PuppeteerLifeCycleEvent | PuppeteerLifeCycleEvent[];
     }): Promise<HTTPResponse | null>;

new-docs/puppeteer.frame.waitforselector.md

@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-waitForSelector(selector: string, options: WaitForSelectorOptions): Promise<ElementHandle | null>;
+waitForSelector(selector: string, options?: WaitForSelectorOptions): Promise<ElementHandle | null>;
 ```
 
 ## Parameters

new-docs/puppeteer.frame.waitforxpath.md

@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-waitForXPath(xpath: string, options: WaitForSelectorOptions): Promise<ElementHandle | null>;
+waitForXPath(xpath: string, options?: WaitForSelectorOptions): Promise<ElementHandle | null>;
 ```
 
 ## Parameters

new-docs/puppeteer.keyboard.type.md

@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-type(text: string, options: {
+type(text: string, options?: {
         delay?: number;
     }): Promise<void>;
 ```

new-docs/puppeteer.md

@@ -53,6 +53,7 @@
 |  [ClickOptions](./puppeteer.clickoptions.md) |  |
 |  [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) |  |
 |  [KeyDefinition](./puppeteer.keydefinition.md) | Copyright 2017 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. |
+|  [Metrics](./puppeteer.metrics.md) |  |
 |  [PressOptions](./puppeteer.pressoptions.md) |  |
 |  [SerializedAXNode](./puppeteer.serializedaxnode.md) | Represents a Node and the properties of it that are relevant to Accessibility. |
 |  [SnapshotOptions](./puppeteer.snapshotoptions.md) |  |

new-docs/puppeteer.metrics.documents.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Metrics](./puppeteer.metrics.md) &gt; [Documents](./puppeteer.metrics.documents.md)
+
+## Metrics.Documents property
+
+<b>Signature:</b>
+
+```typescript
+Documents?: number;
+```

new-docs/puppeteer.metrics.frames.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Metrics](./puppeteer.metrics.md) &gt; [Frames](./puppeteer.metrics.frames.md)
+
+## Metrics.Frames property
+
+<b>Signature:</b>
+
+```typescript
+Frames?: number;
+```

new-docs/puppeteer.metrics.jseventlisteners.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Metrics](./puppeteer.metrics.md) &gt; [JSEventListeners](./puppeteer.metrics.jseventlisteners.md)
+
+## Metrics.JSEventListeners property
+
+<b>Signature:</b>
+
+```typescript
+JSEventListeners?: number;
+```

new-docs/puppeteer.metrics.jsheaptotalsize.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Metrics](./puppeteer.metrics.md) &gt; [JSHeapTotalSize](./puppeteer.metrics.jsheaptotalsize.md)
+
+## Metrics.JSHeapTotalSize property
+
+<b>Signature:</b>
+
+```typescript
+JSHeapTotalSize?: number;
+```

new-docs/puppeteer.metrics.jsheapusedsize.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Metrics](./puppeteer.metrics.md) &gt; [JSHeapUsedSize](./puppeteer.metrics.jsheapusedsize.md)
+
+## Metrics.JSHeapUsedSize property
+
+<b>Signature:</b>
+
+```typescript
+JSHeapUsedSize?: number;
+```

new-docs/puppeteer.metrics.layoutcount.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Metrics](./puppeteer.metrics.md) &gt; [LayoutCount](./puppeteer.metrics.layoutcount.md)
+
+## Metrics.LayoutCount property
+
+<b>Signature:</b>
+
+```typescript
+LayoutCount?: number;
+```

new-docs/puppeteer.metrics.layoutduration.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Metrics](./puppeteer.metrics.md) &gt; [LayoutDuration](./puppeteer.metrics.layoutduration.md)
+
+## Metrics.LayoutDuration property
+
+<b>Signature:</b>
+
+```typescript
+LayoutDuration?: number;
+```

new-docs/puppeteer.metrics.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Metrics](./puppeteer.metrics.md)
+
+## Metrics interface
+
+<b>Signature:</b>
+
+```typescript
+export interface Metrics 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [Documents](./puppeteer.metrics.documents.md) | number |  |
+|  [Frames](./puppeteer.metrics.frames.md) | number |  |
+|  [JSEventListeners](./puppeteer.metrics.jseventlisteners.md) | number |  |
+|  [JSHeapTotalSize](./puppeteer.metrics.jsheaptotalsize.md) | number |  |
+|  [JSHeapUsedSize](./puppeteer.metrics.jsheapusedsize.md) | number |  |
+|  [LayoutCount](./puppeteer.metrics.layoutcount.md) | number |  |
+|  [LayoutDuration](./puppeteer.metrics.layoutduration.md) | number |  |
+|  [Nodes](./puppeteer.metrics.nodes.md) | number |  |
+|  [RecalcStyleCount](./puppeteer.metrics.recalcstylecount.md) | number |  |
+|  [RecalcStyleDuration](./puppeteer.metrics.recalcstyleduration.md) | number |  |
+|  [ScriptDuration](./puppeteer.metrics.scriptduration.md) | number |  |
+|  [TaskDuration](./puppeteer.metrics.taskduration.md) | number |  |
+|  [Timestamp](./puppeteer.metrics.timestamp.md) | number |  |
+

new-docs/puppeteer.metrics.nodes.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Metrics](./puppeteer.metrics.md) &gt; [Nodes](./puppeteer.metrics.nodes.md)
+
+## Metrics.Nodes property
+
+<b>Signature:</b>
+
+```typescript
+Nodes?: number;
+```

new-docs/puppeteer.metrics.recalcstylecount.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Metrics](./puppeteer.metrics.md) &gt; [RecalcStyleCount](./puppeteer.metrics.recalcstylecount.md)
+
+## Metrics.RecalcStyleCount property
+
+<b>Signature:</b>
+
+```typescript
+RecalcStyleCount?: number;
+```

new-docs/puppeteer.metrics.recalcstyleduration.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Metrics](./puppeteer.metrics.md) &gt; [RecalcStyleDuration](./puppeteer.metrics.recalcstyleduration.md)
+
+## Metrics.RecalcStyleDuration property
+
+<b>Signature:</b>
+
+```typescript
+RecalcStyleDuration?: number;
+```

new-docs/puppeteer.metrics.scriptduration.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Metrics](./puppeteer.metrics.md) &gt; [ScriptDuration](./puppeteer.metrics.scriptduration.md)
+
+## Metrics.ScriptDuration property
+
+<b>Signature:</b>
+
+```typescript
+ScriptDuration?: number;
+```

new-docs/puppeteer.metrics.taskduration.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Metrics](./puppeteer.metrics.md) &gt; [TaskDuration](./puppeteer.metrics.taskduration.md)
+
+## Metrics.TaskDuration property
+
+<b>Signature:</b>
+
+```typescript
+TaskDuration?: number;
+```

new-docs/puppeteer.metrics.timestamp.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Metrics](./puppeteer.metrics.md) &gt; [Timestamp](./puppeteer.metrics.timestamp.md)
+
+## Metrics.Timestamp property
+
+<b>Signature:</b>
+
+```typescript
+Timestamp?: number;
+```

new-docs/puppeteer.page.goback.md

@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-goBack(options: WaitForOptions): Promise<HTTPResponse | null>;
+goBack(options?: WaitForOptions): Promise<HTTPResponse | null>;
 ```
 
 ## Parameters

new-docs/puppeteer.page.goforward.md

@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-goForward(options: WaitForOptions): Promise<HTTPResponse | null>;
+goForward(options?: WaitForOptions): Promise<HTTPResponse | null>;
 ```
 
 ## Parameters

new-docs/puppeteer.page.metrics.md

@@ -11,5 +11,5 @@ metrics(): Promise<Metrics>;
 ```
 <b>Returns:</b>
 
-Promise&lt;Metrics&gt;
+Promise&lt;[Metrics](./puppeteer.metrics.md)<!-- -->&gt;
 

new-docs/puppeteer.page.setcontent.md

@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-setContent(html: string, options: WaitForOptions): Promise<void>;
+setContent(html: string, options?: WaitForOptions): Promise<void>;
 ```
 
 ## Parameters

new-docs/puppeteer.page.waitforfunction.md

@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-waitForFunction(pageFunction: Function, options?: {
+waitForFunction(pageFunction: Function | string, options?: {
         timeout?: number;
         polling?: string | number;
     }, ...args: unknown[]): Promise<JSHandle>;
@@ -17,7 +17,7 @@ waitForFunction(pageFunction: Function, options?: {
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  pageFunction | Function |  |
+|  pageFunction | Function \| string |  |
 |  options | { timeout?: number; polling?: string \| number; } |  |
 |  args | unknown\[\] |  |
 

new-docs/puppeteer.puppeteer.defaultargs.md

@@ -7,7 +7,7 @@
 <b>Signature:</b>
 
 ```typescript
-defaultArgs(options: ChromeArgOptions): string[];
+defaultArgs(options?: ChromeArgOptions): string[];
 ```
 
 ## Parameters

package.json

@@ -12,7 +12,7 @@
     "firefox_revision": "latest"
   },
   "scripts": {
-    "unit": "mocha --config mocha-config/puppeteer-unit-tests.js",
+    "unit": "tsc --version && mocha --config mocha-config/puppeteer-unit-tests.js",
     "unit-with-coverage": "cross-env COVERAGE=1 npm run unit",
     "assert-unit-coverage": "cross-env COVERAGE=1 mocha --config mocha-config/coverage-tests.js",
     "funit": "PUPPETEER_PRODUCT=firefox npm run unit",
@@ -91,7 +91,7 @@
     "sinon": "^9.0.2",
     "text-diff": "^1.0.1",
     "ts-node": "^8.10.2",
-    "typescript": "3.9.2"
+    "typescript": "3.9.5"
   },
   "browser": {
     "./lib/BrowserFetcher.js": false,

src/api.ts

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+// @ts-nocheck
 
 /* This file is used in two places:
  * 1) the coverage-utils use it to gain a list of all methods we check for test

test/coverage-utils.js

@@ -108,8 +108,8 @@ const trackCoverage = () => {
 
   return {
     beforeAll: () => {
-      const api = require('../lib/api');
-      const events = require('../lib/common/Events');
+      const api = require('../src/api');
+      const events = require('../src/common/Events');
       for (const [className, classType] of Object.entries(api))
         traceAPICoverage(coverageMap, events, className, classType);
     },

test/emulation.spec.ts

@@ -67,7 +67,7 @@ describe('Emulation', () => {
       function dispatchTouch() {
         let fulfill;
         const promise = new Promise((x) => (fulfill = x));
-        window.ontouchstart = function (e) {
+        window.ontouchstart = () => {
           fulfill('Received touch');
         };
         window.dispatchEvent(new Event('touchstart'));

test/navigation.spec.ts

@@ -65,14 +65,18 @@ describe('navigation', function () {
       const response = await page.goto(server.PREFIX + '/historyapi.html');
       expect(response.status()).toBe(200);
     });
-    it('should work with subframes return 204', async () => {
+    itFailsFirefox('should work with subframes return 204', async () => {
       const { page, server } = getTestState();
 
       server.setRoute('/frames/frame.html', (req, res) => {
         res.statusCode = 204;
         res.end();
       });
-      await page.goto(server.PREFIX + '/frames/one-frame.html');
+      let error = null;
+      await page
+        .goto(server.PREFIX + '/frames/one-frame.html')
+        .catch((error_) => (error = error_));
+      expect(error).toBe(null);
     });
     itFailsFirefox('should fail when server returns 204', async () => {
       const { page, server, isChrome } = getTestState();