build: fix EsLint rule and add fixer (#11826)

puppeteer · Feb 5, 2024 · b2c69fe · b2c69fe
1 parent 197f005
commit b2c69fe
Show file tree

Hide file tree

Showing 38 changed files with 230 additions and 34 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -172,8 +172,6 @@ module.exports = {
         curly: ['error', 'all'],
         // Brackets keep code readable and `return` intentions clear.
         'arrow-body-style': ['error', 'always'],
-        // Error if comments do not adhere to `tsdoc`.
-        'tsdoc/syntax': 'error',
         // Keeps array types simple only when they are simple for readability.
         '@typescript-eslint/array-type': ['error', {default: 'array-simple'}],
         'no-unused-vars': 'off',
@@ -277,5 +275,14 @@ module.exports = {
         },
       ],
     },
+
+    {
+      // Applies to only published packages
+      files: ['packages/**/*.ts'],
+      rules: {
+        // Error if comments do not adhere to `tsdoc`.
+        'tsdoc/syntax': 'error',
+      },
+    },
   ],
 };
diff --git a/docker/test/smoke-test.js b/docker/test/smoke-test.js
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 const puppeteer = require('puppeteer');
 
 (async () => {

diff --git a/examples/cross-browser.js b/examples/cross-browser.js
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 const puppeteer = require('puppeteer');
 
 /**

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/browsers/test/src/mocha-utils.ts b/packages/browsers/test/src/mocha-utils.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import debug from 'debug';
 
 export const mochaHooks = {

diff --git a/packages/ng-schematics/src/builders/puppeteer/index.ts b/packages/ng-schematics/src/builders/puppeteer/index.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import {spawn} from 'child_process';
 import {normalize, join} from 'path';
 

diff --git a/packages/ng-schematics/test/src/config.test.ts b/packages/ng-schematics/test/src/config.test.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import {describe, it} from 'node:test';
 
 import expect from 'expect';

diff --git a/packages/ng-schematics/test/src/e2e.test.ts b/packages/ng-schematics/test/src/e2e.test.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import {describe, it} from 'node:test';
 
 import expect from 'expect';

diff --git a/packages/ng-schematics/test/src/ng-add.test.ts b/packages/ng-schematics/test/src/ng-add.test.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import {describe, it} from 'node:test';
 
 import expect from 'expect';

diff --git a/packages/ng-schematics/test/src/utils.ts b/packages/ng-schematics/test/src/utils.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import https from 'https';
 import {before, after} from 'node:test';
 import {join} from 'path';

diff --git a/packages/ng-schematics/test/tsdoc.json b/packages/ng-schematics/test/tsdoc.json
@@ -0,0 +1,15 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+
+  "extends": ["@microsoft/api-extractor/extends/tsdoc-base.json"],
+  "tagDefinitions": [
+    {
+      "tagName": "@license",
+      "syntaxKind": "modifier",
+      "allowMultiple": false
+    }
+  ],
+  "supportForTags": {
+    "@license": true
+  }
+}
diff --git a/packages/puppeteer-core/Herebyfile.mjs b/packages/puppeteer-core/Herebyfile.mjs
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import {mkdir, readFile, readdir, writeFile} from 'fs/promises';
 import {join} from 'path/posix';
 

diff --git a/packages/puppeteer-core/src/api/CDPSession.ts b/packages/puppeteer-core/src/api/CDPSession.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import type {ProtocolMapping} from 'devtools-protocol/types/protocol-mapping.js';
 
 import type {Connection} from '../cdp/Connection.js';

diff --git a/packages/puppeteer-core/src/bidi/BrowsingContext.ts b/packages/puppeteer-core/src/bidi/BrowsingContext.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import type * as Bidi from 'chromium-bidi/lib/cjs/protocol/protocol.js';
 import type ProtocolMapping from 'devtools-protocol/types/protocol-mapping.js';
 

diff --git a/packages/puppeteer-core/src/bidi/Realm.ts b/packages/puppeteer-core/src/bidi/Realm.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import * as Bidi from 'chromium-bidi/lib/cjs/protocol/protocol.js';
 
 import {EventEmitter, type EventType} from '../common/EventEmitter.js';

diff --git a/packages/puppeteer-core/src/cdp/Binding.ts b/packages/puppeteer-core/src/cdp/Binding.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import {JSHandle} from '../api/JSHandle.js';
 import {debugError} from '../common/util.js';
 import {DisposableStack} from '../util/disposable.js';

diff --git a/packages/puppeteer-core/src/common/ScriptInjector.ts b/packages/puppeteer-core/src/common/ScriptInjector.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import {source as injectedSource} from '../generated/injected.js';
 
 /**

diff --git a/packages/puppeteer-core/src/injected/util.ts b/packages/puppeteer-core/src/injected/util.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 const HIDDEN_VISIBILITY_VALUES = ['hidden', 'collapse'];
 
 /**

diff --git a/packages/puppeteer-core/src/util/Deferred.ts b/packages/puppeteer-core/src/util/Deferred.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import {TimeoutError} from '../common/Errors.js';
 
 /**

diff --git a/packages/puppeteer-core/src/util/Mutex.ts b/packages/puppeteer-core/src/util/Mutex.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import {Deferred} from './Deferred.js';
 import {disposeSymbol} from './disposable.js';
 

diff --git a/test-d/CommonEventEmitter.test-d.ts b/test-d/CommonEventEmitter.test-d.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 // eslint-disable-next-line no-restricted-imports
 import {EventEmitter as NodeEventEmitter} from 'node:events';
 

diff --git a/test-d/ElementHandle.test-d.ts b/test-d/ElementHandle.test-d.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import {expectNotType, expectType} from 'tsd';
 
 import type {ElementHandle} from 'puppeteer';

diff --git a/test-d/JSHandle.test-d.ts b/test-d/JSHandle.test-d.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import {expectNotAssignable, expectNotType, expectType} from 'tsd';
 
 import type {ElementHandle, JSHandle} from 'puppeteer';

diff --git a/test-d/NodeFor.test-d.ts b/test-d/NodeFor.test-d.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import {expectType, expectNotType} from 'tsd';
 
 import type {NodeFor} from 'puppeteer';

diff --git a/test-d/puppeteer.test-d.ts b/test-d/puppeteer.test-d.ts
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import {expectType} from 'tsd';
 
 import puppeteer, {

diff --git a/test/.eslintrc.js b/test/.eslintrc.js
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 module.exports = {
   rules: {
     'no-restricted-imports': [

diff --git a/test/fixtures/closeme.js b/test/fixtures/closeme.js
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 (async () => {
   const [, , puppeteerRoot, options] = process.argv;
   const browser = await require(puppeteerRoot).launch(JSON.parse(options));

diff --git a/test/fixtures/dumpio.js b/test/fixtures/dumpio.js
@@ -1,3 +1,8 @@
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 (async () => {
   const [, , puppeteerRoot, options] = process.argv;
   const browser = await require(puppeteerRoot).launch(JSON.parse(options));

diff --git a/tools/analyze_issue.mjs b/tools/analyze_issue.mjs
@@ -1,4 +1,10 @@
 #!/usr/bin/env node
+/**
+ * @license
+ * Copyright 2024 Google Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 // @ts-check
 
 'use strict';