chore: enforce consistent spacing around object curlys (#5700)

The codebase was incredibly inconsistent with the use of spacing around curly braces, e.g.: ``` // this? const a = {b: 1} // or? const a = { b: 1 } ``` This extended into import statements also. Google's styleguide is no spacing, so we're going with that.
puppeteer · Apr 21, 2020 · e3922ea · e3922ea
1 parent 3600f2f
commit e3922ea
Show file tree

Hide file tree

Showing 55 changed files with 791 additions and 789 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -33,6 +33,7 @@ module.exports = {
         }],
         "brace-style": [2, "1tbs", {"allowSingleLine": true}],
         "curly": [2, "multi-or-nest", "consistent"],
+        "object-curly-spacing": [2, "never"],
         "new-parens": 2,
         "func-call-spacing": 2,
         "arrow-parens": [2, "as-needed"],

diff --git a/install.js b/install.js
@@ -37,7 +37,7 @@ async function download() {
   const downloadHost = process.env.PUPPETEER_DOWNLOAD_HOST || process.env.npm_config_puppeteer_download_host || process.env.npm_package_config_puppeteer_download_host;
   const puppeteer = require('./index');
   const product = process.env.PUPPETEER_PRODUCT || process.env.npm_config_puppeteer_product || process.env.npm_package_config_puppeteer_product || 'chrome';
-  const browserFetcher = puppeteer.createBrowserFetcher({ product, host: downloadHost });
+  const browserFetcher = puppeteer.createBrowserFetcher({product, host: downloadHost});
   const revision = await getRevision();
   await fetchBinary(revision);
 

diff --git a/package.json b/package.json
@@ -22,7 +22,8 @@
     "prepublishOnly": "npm run tsc",
     "dev-install": "npm run tsc && node install.js",
     "install": "node install.js",
-    "lint": "([ \"$CI\" = true ] && eslint --ext js --ext ts --quiet -f codeframe . || eslint --ext js --ext ts .) && npm run tsc && npm run doc",
+    "eslint": "([ \"$CI\" = true ] && eslint --ext js --ext ts --quiet -f codeframe . || eslint --ext js --ext ts .)",
+    "lint": "npm run eslint && npm run tsc && npm run doc",
     "doc": "node utils/doclint/cli.js",
     "tsc": "tsc --version && tsc -p . && cp src/protocol.d.ts lib/ && cp src/externs.d.ts lib/",
     "apply-next-version": "node utils/apply_next_version.js",

diff --git a/src/Browser.js b/src/Browser.js
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-const { helper, assert } = require('./helper');
+const {helper, assert} = require('./helper');
 const {Target} = require('./Target');
 const EventEmitter = require('events');
 const {TaskQueue} = require('./TaskQueue');

diff --git a/src/Coverage.js b/src/Coverage.js
@@ -273,8 +273,8 @@ class CSSCoverage {
 function convertToDisjointRanges(nestedRanges) {
   const points = [];
   for (const range of nestedRanges) {
-    points.push({ offset: range.startOffset, type: 0, range });
-    points.push({ offset: range.endOffset, type: 1, range });
+    points.push({offset: range.startOffset, type: 0, range});
+    points.push({offset: range.endOffset, type: 1, range});
   }
   // Sort points to form a valid parenthesis sequence.
   points.sort((a, b) => {

diff --git a/src/EmulationManager.js b/src/EmulationManager.js
@@ -38,11 +38,11 @@ class EmulationManager {
     const height = viewport.height;
     const deviceScaleFactor = viewport.deviceScaleFactor || 1;
     /** @type {Protocol.Emulation.ScreenOrientation} */
-    const screenOrientation = viewport.isLandscape ? { angle: 90, type: 'landscapePrimary' } : { angle: 0, type: 'portraitPrimary' };
+    const screenOrientation = viewport.isLandscape ? {angle: 90, type: 'landscapePrimary'} : {angle: 0, type: 'portraitPrimary'};
     const hasTouch = viewport.hasTouch || false;
 
     await Promise.all([
-      this._client.send('Emulation.setDeviceMetricsOverride', { mobile, width, height, deviceScaleFactor, screenOrientation }),
+      this._client.send('Emulation.setDeviceMetricsOverride', {mobile, width, height, deviceScaleFactor, screenOrientation}),
       this._client.send('Emulation.setTouchEmulationEnabled', {
         enabled: hasTouch
       })

diff --git a/src/Events.js b/src/Events.js
@@ -77,4 +77,4 @@ const Events = {
   },
 };
 
-module.exports = { Events };
+module.exports = {Events};
diff --git a/src/ExecutionContext.js b/src/ExecutionContext.js
@@ -120,7 +120,7 @@ class ExecutionContext {
         err.message += ' Are you passing a nested JSHandle?';
       throw err;
     }
-    const { exceptionDetails, result: remoteObject } = await callFunctionOnPromise.catch(rewriteError);
+    const {exceptionDetails, result: remoteObject} = await callFunctionOnPromise.catch(rewriteError);
     if (exceptionDetails)
       throw new Error('Evaluation failed: ' + helper.getExceptionMessage(exceptionDetails));
     return returnByValue ? helper.valueFromRemoteObject(remoteObject) : createJSHandle(this, remoteObject);
@@ -132,28 +132,28 @@ class ExecutionContext {
      */
     function convertArgument(arg) {
       if (typeof arg === 'bigint') // eslint-disable-line valid-typeof
-        return { unserializableValue: `${arg.toString()}n` };
+        return {unserializableValue: `${arg.toString()}n`};
       if (Object.is(arg, -0))
-        return { unserializableValue: '-0' };
+        return {unserializableValue: '-0'};
       if (Object.is(arg, Infinity))
-        return { unserializableValue: 'Infinity' };
+        return {unserializableValue: 'Infinity'};
       if (Object.is(arg, -Infinity))
-        return { unserializableValue: '-Infinity' };
+        return {unserializableValue: '-Infinity'};
       if (Object.is(arg, NaN))
-        return { unserializableValue: 'NaN' };
+        return {unserializableValue: 'NaN'};
       const objectHandle = arg && (arg instanceof JSHandle) ? arg : null;
       if (objectHandle) {
         if (objectHandle._context !== this)
           throw new Error('JSHandles can be evaluated only in the context they were created!');
         if (objectHandle._disposed)
           throw new Error('JSHandle is disposed!');
         if (objectHandle._remoteObject.unserializableValue)
-          return { unserializableValue: objectHandle._remoteObject.unserializableValue };
+          return {unserializableValue: objectHandle._remoteObject.unserializableValue};
         if (!objectHandle._remoteObject.objectId)
-          return { value: objectHandle._remoteObject.value };
-        return { objectId: objectHandle._remoteObject.objectId };
+          return {value: objectHandle._remoteObject.value};
+        return {objectId: objectHandle._remoteObject.objectId};
       }
-      return { value: arg };
+      return {value: arg};
     }
 
     /**

diff --git a/src/FrameManager.js b/src/FrameManager.js
@@ -70,7 +70,7 @@ class FrameManager extends EventEmitter {
     const {frameTree} = /** @type Protocol.Page.getFrameTreeReturnValue*/ (result[1]);
     this._handleFrameTree(frameTree);
     await Promise.all([
-      this._client.send('Page.setLifecycleEventsEnabled', { enabled: true }),
+      this._client.send('Page.setLifecycleEventsEnabled', {enabled: true}),
       this._client.send('Runtime.enable', {}).then(() => this._ensureIsolatedWorld(UTILITY_WORLD_NAME)),
       this._networkManager.initialize(),
     ]);

diff --git a/src/Input.js b/src/Input.js
@@ -43,7 +43,7 @@ class Keyboard {
    * @param {string} key
    * @param {{text?: string}=} options
    */
-  async down(key, options = { text: undefined }) {
+  async down(key, options = {text: undefined}) {
     const description = this._keyDescriptionForString(key);
 
     const autoRepeat = this._pressedKeys.has(description.code);
@@ -312,4 +312,4 @@ class Touchscreen {
   }
 }
 
-module.exports = { Keyboard, Mouse, Touchscreen};
+module.exports = {Keyboard, Mouse, Touchscreen};
diff --git a/src/JSHandle.js b/src/JSHandle.js
@@ -304,8 +304,8 @@ class ElementHandle extends JSHandle {
         if (option.selected && !element.multiple)
           break;
       }
-      element.dispatchEvent(new Event('input', { bubbles: true }));
-      element.dispatchEvent(new Event('change', { bubbles: true }));
+      element.dispatchEvent(new Event('input', {bubbles: true}));
+      element.dispatchEvent(new Event('change', {bubbles: true}));
       return options.filter(option => option.selected).map(option => option.value);
     }, values);
   }
@@ -321,9 +321,9 @@ class ElementHandle extends JSHandle {
     // the cost unnecessarily.
     const path = require('path');
     const files = filePaths.map(filePath => path.resolve(filePath));
-    const { objectId } = this._remoteObject;
-    const { node } = await this._client.send('DOM.describeNode', { objectId });
-    const { backendNodeId } = node;
+    const {objectId} = this._remoteObject;
+    const {node} = await this._client.send('DOM.describeNode', {objectId});
+    const {backendNodeId} = node;
 
     // The zero-length array is a special case, it seems that DOM.setFileInputFiles does
     // not actually update the files in that case, so the solution is to eval the element
@@ -333,11 +333,11 @@ class ElementHandle extends JSHandle {
         element.files = new DataTransfer().files;
 
         // Dispatch events for this case because it should behave akin to a user action.
-        element.dispatchEvent(new Event('input', { bubbles: true }));
-        element.dispatchEvent(new Event('change', { bubbles: true }));
+        element.dispatchEvent(new Event('input', {bubbles: true}));
+        element.dispatchEvent(new Event('change', {bubbles: true}));
       });
     } else {
-      await this._client.send('DOM.setFileInputFiles', { objectId, files, backendNodeId });
+      await this._client.send('DOM.setFileInputFiles', {objectId, files, backendNodeId});
     }
   }
 
@@ -437,7 +437,7 @@ class ElementHandle extends JSHandle {
     assert(boundingBox.width !== 0, 'Node has 0 width.');
     assert(boundingBox.height !== 0, 'Node has 0 height.');
 
-    const { layoutViewport: { pageX, pageY } } = await this._client.send('Page.getLayoutMetrics');
+    const {layoutViewport: {pageX, pageY}} = await this._client.send('Page.getLayoutMetrics');
 
     const clip = Object.assign({}, boundingBox);
     clip.x += pageX;

diff --git a/src/Launcher.js b/src/Launcher.js
@@ -169,7 +169,7 @@ class BrowserRunner {
       this.connection = new Connection(browserWSEndpoint, transport, slowMo);
     } else {
       // stdio was assigned during start(), and the 'pipe' option there adds the 4th and 5th items to stdio array
-      const { 3: pipeWrite, 4: pipeRead } = /** @type {!Array<any>} */ (this.proc.stdio);
+      const {3: pipeWrite, 4: pipeRead} = /** @type {!Array<any>} */ (this.proc.stdio);
       const transport = new PipeTransport(/** @type {!NodeJS.WritableStream} */ pipeWrite, /** @type {!NodeJS.ReadableStream} */ pipeRead);
       this.connection = new Connection('', transport, slowMo);
     }
@@ -476,7 +476,7 @@ class FirefoxLauncher {
   async _updateRevision() {
     // replace 'latest' placeholder with actual downloaded revision
     if (this._preferredRevision === 'latest') {
-      const browserFetcher = new BrowserFetcher(this._projectRoot, { product: this.product });
+      const browserFetcher = new BrowserFetcher(this._projectRoot, {product: this.product});
       const localRevisions = await browserFetcher.localRevisions();
       if (localRevisions[0])
         this._preferredRevision = localRevisions[0];
@@ -743,7 +743,7 @@ class FirefoxLauncher {
  */
 function waitForWSEndpoint(browserProcess, timeout, preferredRevision) {
   return new Promise((resolve, reject) => {
-    const rl = readline.createInterface({ input: browserProcess.stderr });
+    const rl = readline.createInterface({input: browserProcess.stderr});
     let stderr = '';
     const listeners = [
       helper.addEventListener(rl, 'line', onLine),
@@ -802,7 +802,7 @@ function getWSEndpoint(browserURL) {
 
   const endpointURL = URL.resolve(browserURL, '/json/version');
   const protocol = endpointURL.startsWith('https') ? https : http;
-  const requestOptions = Object.assign(URL.parse(endpointURL), { method: 'GET' });
+  const requestOptions = Object.assign(URL.parse(endpointURL), {method: 'GET'});
   const request = protocol.request(requestOptions, res => {
     let data = '';
     if (res.statusCode !== 200) {
@@ -836,7 +836,7 @@ function resolveExecutablePath(launcher) {
     const executablePath = process.env.PUPPETEER_EXECUTABLE_PATH || process.env.npm_config_puppeteer_executable_path || process.env.npm_package_config_puppeteer_executable_path;
     if (executablePath) {
       const missingText = !fs.existsSync(executablePath) ? 'Tried to use PUPPETEER_EXECUTABLE_PATH env variable to launch browser but did not find any executable at: ' + executablePath : null;
-      return { executablePath, missingText };
+      return {executablePath, missingText};
     }
   }
   const browserFetcher = new BrowserFetcher(launcher._projectRoot, {product: launcher.product});

diff --git a/src/NetworkManager.js b/src/NetworkManager.js
@@ -82,7 +82,7 @@ class NetworkManager extends EventEmitter {
       assert(helper.isString(value), `Expected value of header "${key}" to be String, but "${typeof value}" is found.`);
       this._extraHTTPHeaders[key.toLowerCase()] = value;
     }
-    await this._client.send('Network.setExtraHTTPHeaders', { headers: this._extraHTTPHeaders });
+    await this._client.send('Network.setExtraHTTPHeaders', {headers: this._extraHTTPHeaders});
   }
 
   /**
@@ -112,7 +112,7 @@ class NetworkManager extends EventEmitter {
    * @param {string} userAgent
    */
   async setUserAgent(userAgent) {
-    await this._client.send('Network.setUserAgentOverride', { userAgent });
+    await this._client.send('Network.setUserAgentOverride', {userAgent});
   }
 
   /**
@@ -192,7 +192,7 @@ class NetworkManager extends EventEmitter {
     const {username, password} = this._credentials || {username: undefined, password: undefined};
     this._client.send('Fetch.continueWithAuth', {
       requestId: event.requestId,
-      authChallengeResponse: { response, username, password },
+      authChallengeResponse: {response, username, password},
     }).catch(debugError);
   }
 

diff --git a/src/Page.js b/src/Page.js
@@ -184,7 +184,7 @@ class Page extends EventEmitter {
    * @param {!{longitude: number, latitude: number, accuracy: (number|undefined)}} options
    */
   async setGeolocation(options) {
-    const { longitude, latitude, accuracy = 0} = options;
+    const {longitude, latitude, accuracy = 0} = options;
     if (longitude < -180 || longitude > 180)
       throw new Error(`Invalid longitude "${longitude}": precondition -180 <= LONGITUDE <= 180 failed.`);
     if (latitude < -90 || latitude > 90)
@@ -424,7 +424,7 @@ class Page extends EventEmitter {
     });
     await this.deleteCookie(...items);
     if (items.length)
-      await this._client.send('Network.setCookies', { cookies: items });
+      await this._client.send('Network.setCookies', {cookies: items});
   }
 
   /**
@@ -579,7 +579,7 @@ class Page extends EventEmitter {
       else
         expression = helper.evaluationString(deliverErrorValue, name, seq, error);
     }
-    this._client.send('Runtime.evaluate', { expression, contextId: event.executionContextId }).catch(debugError);
+    this._client.send('Runtime.evaluate', {expression, contextId: event.executionContextId}).catch(debugError);
 
     /**
      * @param {string} name
@@ -806,14 +806,14 @@ class Page extends EventEmitter {
     if (this._javascriptEnabled === enabled)
       return;
     this._javascriptEnabled = enabled;
-    await this._client.send('Emulation.setScriptExecutionDisabled', { value: !enabled });
+    await this._client.send('Emulation.setScriptExecutionDisabled', {value: !enabled});
   }
 
   /**
    * @param {boolean} enabled
    */
   async setBypassCSP(enabled) {
-    await this._client.send('Page.setBypassCSP', { enabled });
+    await this._client.send('Page.setBypassCSP', {enabled});
   }
 
   /**
@@ -885,7 +885,7 @@ class Page extends EventEmitter {
    */
   async evaluateOnNewDocument(pageFunction, ...args) {
     const source = helper.evaluationString(pageFunction, ...args);
-    await this._client.send('Page.addScriptToEvaluateOnNewDocument', { source });
+    await this._client.send('Page.addScriptToEvaluateOnNewDocument', {source});
   }
 
   /**
@@ -951,20 +951,20 @@ class Page extends EventEmitter {
       const height = Math.ceil(metrics.contentSize.height);
 
       // Overwrite clip for full page at all times.
-      clip = { x: 0, y: 0, width, height, scale: 1 };
+      clip = {x: 0, y: 0, width, height, scale: 1};
       const {
         isMobile = false,
         deviceScaleFactor = 1,
         isLandscape = false
       } = this._viewport || {};
       /** @type {!Protocol.Emulation.ScreenOrientation} */
-      const screenOrientation = isLandscape ? { angle: 90, type: 'landscapePrimary' } : { angle: 0, type: 'portraitPrimary' };
-      await this._client.send('Emulation.setDeviceMetricsOverride', { mobile: isMobile, width, height, deviceScaleFactor, screenOrientation });
+      const screenOrientation = isLandscape ? {angle: 90, type: 'landscapePrimary'} : {angle: 0, type: 'portraitPrimary'};
+      await this._client.send('Emulation.setDeviceMetricsOverride', {mobile: isMobile, width, height, deviceScaleFactor, screenOrientation});
     }
     const shouldSetDefaultBackground = options.omitBackground && format === 'png';
     if (shouldSetDefaultBackground)
-      await this._client.send('Emulation.setDefaultBackgroundColorOverride', { color: { r: 0, g: 0, b: 0, a: 0 } });
-    const result = await this._client.send('Page.captureScreenshot', { format, quality: options.quality, clip });
+      await this._client.send('Emulation.setDefaultBackgroundColorOverride', {color: {r: 0, g: 0, b: 0, a: 0}});
+    const result = await this._client.send('Page.captureScreenshot', {format, quality: options.quality, clip});
     if (shouldSetDefaultBackground)
       await this._client.send('Emulation.setDefaultBackgroundColorOverride');
 
@@ -1056,7 +1056,7 @@ class Page extends EventEmitter {
     if (runBeforeUnload) {
       await this._client.send('Page.close');
     } else {
-      await this._client._connection.send('Target.closeTarget', { targetId: this._target._targetId });
+      await this._client._connection.send('Target.closeTarget', {targetId: this._target._targetId});
       await this._target._isClosedPromise;
     }
   }
@@ -1235,13 +1235,13 @@ Page.PaperFormats = {
   legal: {width: 8.5, height: 14},
   tabloid: {width: 11, height: 17},
   ledger: {width: 17, height: 11},
-  a0: {width: 33.1, height: 46.8 },
-  a1: {width: 23.4, height: 33.1 },
-  a2: {width: 16.54, height: 23.4 },
-  a3: {width: 11.7, height: 16.54 },
-  a4: {width: 8.27, height: 11.7 },
-  a5: {width: 5.83, height: 8.27 },
-  a6: {width: 4.13, height: 5.83 },
+  a0: {width: 33.1, height: 46.8},
+  a1: {width: 23.4, height: 33.1},
+  a2: {width: 16.54, height: 23.4},
+  a3: {width: 11.7, height: 16.54},
+  a4: {width: 8.27, height: 11.7},
+  a5: {width: 5.83, height: 8.27},
+  a6: {width: 4.13, height: 5.83},
 };
 
 const unitToPixels = {

diff --git a/src/Target.js b/src/Target.js
@@ -132,7 +132,7 @@ class Target {
    * @return {?Puppeteer.Target}
    */
   opener() {
-    const { openerId } = this._targetInfo;
+    const {openerId} = this._targetInfo;
     if (!openerId)
       return null;
     return this.browser()._targets.get(openerId);

diff --git a/src/TaskQueue.ts b/src/TaskQueue.ts
@@ -33,4 +33,4 @@ class TaskQueue {
   }
 }
 
-export = { TaskQueue };
+export = {TaskQueue};
diff --git a/src/helper.ts b/src/helper.ts
@@ -112,7 +112,7 @@ export interface PuppeteerEventListener {
 
 function addEventListener(emitter: NodeJS.EventEmitter, eventName: string|symbol, handler: (...args: any[]) => void): PuppeteerEventListener {
   emitter.on(eventName, handler);
-  return { emitter, eventName, handler };
+  return {emitter, eventName, handler};
 }
 
 function removeEventListeners(listeners: Array<{emitter: NodeJS.EventEmitter; eventName: string|symbol; handler: (...args: any[]) => void}>): void {