@percy/core 1.12.0 → 1.13.0

package/dist/api.js

@@ -3,112 +3,118 @@ import path from 'path';
 import { createRequire } from 'module';
 import logger from '@percy/logger';
 import { normalize } from '@percy/config/utils';
-import { getPackageJSON, Server } from './utils.js'; // need require.resolve until import.meta.resolve can be transpiled
+import { getPackageJSON, Server } from './utils.js';
 
-export const PERCY_DOM = createRequire(import.meta.url).resolve('@percy/dom'); // Returns a URL encoded string of nested query params
+// need require.resolve until import.meta.resolve can be transpiled
+export const PERCY_DOM = createRequire(import.meta.url).resolve('@percy/dom');
 
+// Returns a URL encoded string of nested query params
 function encodeURLSearchParams(subj, prefix) {
   return typeof subj === 'object' ? Object.entries(subj).map(([key, value]) => encodeURLSearchParams(value, prefix ? `${prefix}[${key}]` : key)).join('&') : `${prefix}=${encodeURIComponent(subj)}`;
-} // Create a Percy CLI API server instance
-
+}
 
+// Create a Percy CLI API server instance
 export function createPercyServer(percy, port) {
   let pkg = getPackageJSON(import.meta.url);
   let server = Server.createServer({
     port
-  }) // general middleware
+  })
+  // general middleware
   .route((req, res, next) => {
     var _percy$testing, _percy$testing4, _percy$testing4$api, _percy$testing5, _percy$testing5$api;
-
     // treat all request bodies as json
     if (req.body) try {
       req.body = JSON.parse(req.body);
-    } catch {} // add version header
+    } catch {}
 
-    res.setHeader('Access-Control-Expose-Headers', '*, X-Percy-Core-Version'); // skip or change api version header in testing mode
+    // add version header
+    res.setHeader('Access-Control-Expose-Headers', '*, X-Percy-Core-Version');
 
+    // skip or change api version header in testing mode
     if (((_percy$testing = percy.testing) === null || _percy$testing === void 0 ? void 0 : _percy$testing.version) !== false) {
       var _percy$testing2;
-
       res.setHeader('X-Percy-Core-Version', ((_percy$testing2 = percy.testing) === null || _percy$testing2 === void 0 ? void 0 : _percy$testing2.version) ?? pkg.version);
-    } // track all api reqeusts in testing mode
-
+    }
 
+    // track all api reqeusts in testing mode
     if (percy.testing && !req.url.pathname.startsWith('/test/')) {
       var _percy$testing3;
-
       ((_percy$testing3 = percy.testing).requests || (_percy$testing3.requests = [])).push({
         url: `${req.url.pathname}${req.url.search}`,
         method: req.method,
         body: req.body
       });
-    } // support sabotaging requests in testing mode
-
+    }
 
+    // support sabotaging requests in testing mode
     if (((_percy$testing4 = percy.testing) === null || _percy$testing4 === void 0 ? void 0 : (_percy$testing4$api = _percy$testing4.api) === null || _percy$testing4$api === void 0 ? void 0 : _percy$testing4$api[req.url.pathname]) === 'error') {
       next = () => {
         var _percy$testing$build;
-
         return Promise.reject(new Error(((_percy$testing$build = percy.testing.build) === null || _percy$testing$build === void 0 ? void 0 : _percy$testing$build.error) || 'testing'));
       };
     } else if (((_percy$testing5 = percy.testing) === null || _percy$testing5 === void 0 ? void 0 : (_percy$testing5$api = _percy$testing5.api) === null || _percy$testing5$api === void 0 ? void 0 : _percy$testing5$api[req.url.pathname]) === 'disconnect') {
       next = () => req.connection.destroy();
-    } // return json errors
-
+    }
 
+    // return json errors
     return next().catch(e => {
       var _percy$testing6;
-
       return res.json(e.status ?? 500, {
         build: ((_percy$testing6 = percy.testing) === null || _percy$testing6 === void 0 ? void 0 : _percy$testing6.build) || percy.build,
         error: e.message,
         success: false
       });
     });
-  }) // healthcheck returns basic information
+  })
+  // healthcheck returns basic information
   .route('get', '/percy/healthcheck', (req, res) => {
     var _percy$testing7;
-
     return res.json(200, {
       build: ((_percy$testing7 = percy.testing) === null || _percy$testing7 === void 0 ? void 0 : _percy$testing7.build) ?? percy.build,
       loglevel: percy.loglevel(),
       config: percy.config,
       success: true
     });
-  }) // get or set config options
+  })
+  // get or set config options
   .route(['get', 'post'], '/percy/config', async (req, res) => res.json(200, {
     config: req.body ? percy.set(req.body) : percy.config,
     success: true
-  })) // responds once idle (may take a long time)
+  }))
+  // responds once idle (may take a long time)
   .route('get', '/percy/idle', async (req, res) => res.json(200, {
     success: await percy.idle().then(() => true)
-  })) // convenient @percy/dom bundle
+  }))
+  // convenient @percy/dom bundle
   .route('get', '/percy/dom.js', (req, res) => {
     return res.file(200, PERCY_DOM);
-  }) // legacy agent wrapper for @percy/dom
+  })
+  // legacy agent wrapper for @percy/dom
   .route('get', '/percy-agent.js', async (req, res) => {
     logger('core:server').deprecated(['It looks like you’re using @percy/cli with an older SDK.', 'Please upgrade to the latest version to fix this warning.', 'See these docs for more info: https:docs.percy.io/docs/migrating-to-percy-cli'].join(' '));
     let content = await fs.promises.readFile(PERCY_DOM, 'utf-8');
     let wrapper = '(window.PercyAgent = class { snapshot(n, o) { return PercyDOM.serialize(o); } });';
     return res.send(200, 'applicaton/javascript', content.concat(wrapper));
-  }) // post one or more snapshots, optionally async
+  })
+  // post one or more snapshots, optionally async
   .route('post', '/percy/snapshot', async (req, res) => {
     let snapshot = percy.snapshot(req.body);
     if (!req.url.searchParams.has('async')) await snapshot;
     return res.json(200, {
       success: true
     });
-  }) // post one or more comparisons, optionally waiting
+  })
+  // post one or more comparisons, optionally waiting
   .route('post', '/percy/comparison', async (req, res) => {
     let upload = percy.upload(req.body);
-    if (req.url.searchParams.has('await')) await upload; // generate and include one or more redirect links to comparisons
+    if (req.url.searchParams.has('await')) await upload;
 
+    // generate and include one or more redirect links to comparisons
     let link = ({
       name,
       tag
     }) => {
       var _percy$build;
-
       return [percy.client.apiUrl, '/comparisons/redirect?', encodeURLSearchParams(normalize({
         buildId: (_percy$build = percy.build) === null || _percy$build === void 0 ? void 0 : _percy$build.id,
         snapshot: {
@@ -119,7 +125,6 @@ export function createPercyServer(percy, port) {
         snake: true
       }))].join('');
     };
-
     return res.json(200, Object.assign({
       success: true
     }, req.body ? Array.isArray(req.body) ? {
@@ -127,18 +132,22 @@ export function createPercyServer(percy, port) {
     } : {
       link: link(req.body)
     } : {}));
-  }) // flushes one or more snapshots from the internal queue
+  })
+  // flushes one or more snapshots from the internal queue
   .route('post', '/percy/flush', async (req, res) => res.json(200, {
     success: await percy.flush(req.body).then(() => true)
-  })) // stops percy at the end of the current event loop
+  }))
+  // stops percy at the end of the current event loop
   .route('/percy/stop', (req, res) => {
     setImmediate(() => percy.stop());
     return res.json(200, {
       success: true
     });
-  }); // add test endpoints only in testing mode
+  });
 
-  return !percy.testing ? server : server // manipulates testing mode configuration to trigger specific scenarios
+  // add test endpoints only in testing mode
+  return !percy.testing ? server : server
+  // manipulates testing mode configuration to trigger specific scenarios
   .route('/test/api/:cmd', ({
     body,
     params: {
@@ -146,7 +155,6 @@ export function createPercyServer(percy, port) {
     }
   }, res) => {
     body = Buffer.isBuffer(body) ? body.toString() : body;
-
     if (cmd === 'reset') {
       // the reset command will reset testing mode and clear any logs
       percy.testing = {};
@@ -156,7 +164,6 @@ export function createPercyServer(percy, port) {
       percy.testing.version = body;
     } else if (cmd === 'error' || cmd === 'disconnect') {
       var _percy$testing8;
-
       // the error or disconnect commands will cause specific endpoints to fail
       ((_percy$testing8 = percy.testing).api || (_percy$testing8.api = {}))[body] = cmd;
     } else if (cmd === 'build-failure') {
@@ -169,35 +176,43 @@ export function createPercyServer(percy, port) {
       // 404 for unknown commands
       return res.send(404);
     }
-
     return res.json(200, {
       success: true
     });
-  }) // returns an array of raw requests made to the api
+  })
+  // returns an array of raw requests made to the api
   .route('get', '/test/requests', (req, res) => res.json(200, {
     requests: percy.testing.requests
-  })) // returns an array of raw logs from the logger
+  }))
+  // returns an array of raw logs from the logger
   .route('get', '/test/logs', (req, res) => res.json(200, {
     logs: Array.from(logger.instance.messages)
-  })) // serves a very basic html page for testing snapshots
+  }))
+  // serves a very basic html page for testing snapshots
   .route('get', '/test/snapshot', (req, res) => {
     return res.send(200, 'text/html', '<p>Snapshot Me!</p>');
   });
-} // Create a static server instance with an automatic sitemap
+}
 
+// Create a static server instance with an automatic sitemap
 export function createStaticServer(options) {
   let {
     serve: dir,
     baseUrl = ''
   } = options;
-  let server = Server.createServer(options); // remove trailing slashes so the base snapshot name matches other snapshots
+  let server = Server.createServer(options);
 
-  baseUrl = baseUrl.replace(/\/$/, ''); // used when generating an automatic sitemap
+  // remove trailing slashes so the base snapshot name matches other snapshots
+  baseUrl = baseUrl.replace(/\/$/, '');
 
-  let toURL = Server.createRewriter( // reverse rewrites' src, dest, & order
-  Object.entries((options === null || options === void 0 ? void 0 : options.rewrites) ?? {}).reduce((acc, rw) => [rw.reverse(), ...acc], []), (filename, rewrite) => new URL(path.posix.join('/', baseUrl, // cleanUrls will trim trailing .html/index.html from paths
-  !options.cleanUrls ? rewrite(filename) : rewrite(filename).replace(/(\/index)?\.html$/, '')), server.address())); // include automatic sitemap route
+  // used when generating an automatic sitemap
+  let toURL = Server.createRewriter(
+  // reverse rewrites' src, dest, & order
+  Object.entries((options === null || options === void 0 ? void 0 : options.rewrites) ?? {}).reduce((acc, rw) => [rw.reverse(), ...acc], []), (filename, rewrite) => new URL(path.posix.join('/', baseUrl,
+  // cleanUrls will trim trailing .html/index.html from paths
+  !options.cleanUrls ? rewrite(filename) : rewrite(filename).replace(/(\/index)?\.html$/, '')), server.address()));
 
+  // include automatic sitemap route
   server.route('get', `${baseUrl}/sitemap.xml`, async (req, res) => {
     let {
       default: glob

package/dist/browser.js

@@ -16,35 +16,56 @@ export class Browser extends EventEmitter {
   closed = false;
   #callbacks = new Map();
   #lastid = 0;
-  args = [// disable the translate popup
-  '--disable-features=Translate', // disable several subsystems which run network requests in the background
-  '--disable-background-networking', // disable task throttling of timer tasks from background pages
-  '--disable-background-timer-throttling', // disable backgrounding renderer processes
-  '--disable-renderer-backgrounding', // disable backgrounding renderers for occluded windows (reduce nondeterminism)
-  '--disable-backgrounding-occluded-windows', // disable crash reporting
-  '--disable-breakpad', // disable client side phishing detection
-  '--disable-client-side-phishing-detection', // disable default component extensions with background pages for performance
-  '--disable-component-extensions-with-background-pages', // disable installation of default apps on first run
-  '--disable-default-apps', // work-around for environments where a small /dev/shm partition causes crashes
-  '--disable-dev-shm-usage', // disable extensions
-  '--disable-extensions', // disable hang monitor dialogs in renderer processes
-  '--disable-hang-monitor', // disable inter-process communication flooding protection for javascript
-  '--disable-ipc-flooding-protection', // disable web notifications and the push API
-  '--disable-notifications', // disable the prompt when a POST request causes page navigation
-  '--disable-prompt-on-repost', // disable syncing browser data with google accounts
-  '--disable-sync', // disable site-isolation to make network requests easier to intercept
-  '--disable-site-isolation-trials', // disable the first run tasks, whether or not it's actually the first run
-  '--no-first-run', // disable the sandbox for all process types that are normally sandboxed
-  '--no-sandbox', // enable indication that browser is controlled by automation
-  '--enable-automation', // specify a consistent encryption backend across platforms
-  '--password-store=basic', // use a mock keychain on Mac to prevent blocking permissions dialogs
-  '--use-mock-keychain', // enable remote debugging on the first available port
+  args = [
+  // disable the translate popup
+  '--disable-features=Translate',
+  // disable several subsystems which run network requests in the background
+  '--disable-background-networking',
+  // disable task throttling of timer tasks from background pages
+  '--disable-background-timer-throttling',
+  // disable backgrounding renderer processes
+  '--disable-renderer-backgrounding',
+  // disable backgrounding renderers for occluded windows (reduce nondeterminism)
+  '--disable-backgrounding-occluded-windows',
+  // disable crash reporting
+  '--disable-breakpad',
+  // disable client side phishing detection
+  '--disable-client-side-phishing-detection',
+  // disable default component extensions with background pages for performance
+  '--disable-component-extensions-with-background-pages',
+  // disable installation of default apps on first run
+  '--disable-default-apps',
+  // work-around for environments where a small /dev/shm partition causes crashes
+  '--disable-dev-shm-usage',
+  // disable extensions
+  '--disable-extensions',
+  // disable hang monitor dialogs in renderer processes
+  '--disable-hang-monitor',
+  // disable inter-process communication flooding protection for javascript
+  '--disable-ipc-flooding-protection',
+  // disable web notifications and the push API
+  '--disable-notifications',
+  // disable the prompt when a POST request causes page navigation
+  '--disable-prompt-on-repost',
+  // disable syncing browser data with google accounts
+  '--disable-sync',
+  // disable site-isolation to make network requests easier to intercept
+  '--disable-site-isolation-trials',
+  // disable the first run tasks, whether or not it's actually the first run
+  '--no-first-run',
+  // disable the sandbox for all process types that are normally sandboxed
+  '--no-sandbox',
+  // enable indication that browser is controlled by automation
+  '--enable-automation',
+  // specify a consistent encryption backend across platforms
+  '--password-store=basic',
+  // use a mock keychain on Mac to prevent blocking permissions dialogs
+  '--use-mock-keychain',
+  // enable remote debugging on the first available port
   '--remote-debugging-port=0'];
-
   constructor(percy) {
     super().percy = percy;
   }
-
   async launch() {
     // already launching or launched
     if (this.readyState != null) return;
@@ -59,57 +80,57 @@ export class Browser extends EventEmitter {
       args = [],
       timeout
     } = launchOptions;
-    executable ?? (executable = process.env.PERCY_BROWSER_EXECUTABLE); // transform cookies object to an array of cookie params
+    executable ?? (executable = process.env.PERCY_BROWSER_EXECUTABLE);
 
+    // transform cookies object to an array of cookie params
     this.cookies = Array.isArray(cookies) ? cookies : Object.entries(cookies).map(([name, value]) => ({
       name,
       value
-    })); // check if any provided executable exists
+    }));
 
+    // check if any provided executable exists
     if (executable && !fs.existsSync(executable)) {
       this.log.error(`Browser executable not found: ${executable}`);
       executable = null;
-    } // download and install the browser if not already present
-
+    }
 
+    // download and install the browser if not already present
     this.executable = executable || (await install.chromium());
-    this.log.debug('Launching browser'); // create a temporary profile directory and collect additional launch arguments
+    this.log.debug('Launching browser');
 
+    // create a temporary profile directory and collect additional launch arguments
     this.profile = await fs.promises.mkdtemp(path.join(os.tmpdir(), 'percy-browser-'));
     /* istanbul ignore next: only false for debugging */
-
     if (headless) this.args.push('--headless', '--hide-scrollbars', '--mute-audio');
-
     for (let a of args) if (!this.args.includes(a)) this.args.push(a);
+    this.args.push(`--user-data-dir=${this.profile}`);
 
-    this.args.push(`--user-data-dir=${this.profile}`); // spawn the browser process and connect a websocket to the devtools address
-
+    // spawn the browser process and connect a websocket to the devtools address
     this.ws = new WebSocket(await this.spawn(timeout), {
       perMessageDeflate: false
-    }); // wait until the websocket has connected
+    });
 
+    // wait until the websocket has connected
     await new Promise(resolve => this.ws.once('open', resolve));
-    this.ws.on('message', data => this._handleMessage(data)); // get version information
+    this.ws.on('message', data => this._handleMessage(data));
 
+    // get version information
     this.version = await this.send('Browser.getVersion');
     this.log.debug(`Browser connected [${this.process.pid}]: ${this.version.product}`);
     this.readyState = 1;
   }
-
   isConnected() {
     var _this$ws;
-
     return ((_this$ws = this.ws) === null || _this$ws === void 0 ? void 0 : _this$ws.readyState) === WebSocket.OPEN;
   }
-
   async close() {
     var _this$process, _this$ws2;
-
     // not running, already closed, or closing
     if (this._closed) return this._closed;
     this.readyState = 2;
-    this.log.debug('Closing browser'); // resolves when the browser has closed
+    this.log.debug('Closing browser');
 
+    // resolves when the browser has closed
     this._closed = Promise.all([new Promise(resolve => {
       /* istanbul ignore next: race condition paranoia */
       if (!this.process || this.process.exitCode) resolve();else this.process.on('exit', resolve);
@@ -131,25 +152,26 @@ export class Browser extends EventEmitter {
     }).then(() => {
       this.log.debug('Browser closed');
       this.readyState = 3;
-    }); // reject any pending callbacks
+    });
 
+    // reject any pending callbacks
     for (let callback of this.#callbacks.values()) {
       callback.reject(Object.assign(callback.error, {
         message: `Protocol error (${callback.method}): Browser closed.`
       }));
-    } // trigger rejecting pending session callbacks
-
+    }
 
+    // trigger rejecting pending session callbacks
     for (let session of this.sessions.values()) {
       session._handleClose();
-    } // clear own callbacks and sessions
-
+    }
 
+    // clear own callbacks and sessions
     this.#callbacks.clear();
     this.sessions.clear();
+
     /* istanbul ignore next:
      *   difficult to test failure here without mocking private properties */
-
     if ((_this$process = this.process) !== null && _this$process !== void 0 && _this$process.pid && !this.process.killed) {
       // always force close the browser process
       try {
@@ -157,14 +179,14 @@ export class Browser extends EventEmitter {
       } catch (error) {
         throw new Error(`Unable to close the browser: ${error.stack}`);
       }
-    } // close the socket connection
-
+    }
 
-    (_this$ws2 = this.ws) === null || _this$ws2 === void 0 ? void 0 : _this$ws2.close(); // wait for the browser to close
+    // close the socket connection
+    (_this$ws2 = this.ws) === null || _this$ws2 === void 0 ? void 0 : _this$ws2.close();
 
+    // wait for the browser to close
     return this._closed;
   }
-
   async page(options = {}) {
     let {
       targetId
@@ -181,17 +203,17 @@ export class Browser extends EventEmitter {
     await page._handleAttachedToTarget();
     return page;
   }
-
   async send(method, params) {
     /* istanbul ignore next:
      *   difficult to test failure here without mocking private properties */
-    if (!this.isConnected()) throw new Error('Browser not connected'); // every command needs a unique id
+    if (!this.isConnected()) throw new Error('Browser not connected');
 
+    // every command needs a unique id
     let id = ++this.#lastid;
-
     if (!params && typeof method === 'object') {
       // allow providing a raw message as the only argument and return the id
-      this.ws.send(JSON.stringify({ ...method,
+      this.ws.send(JSON.stringify({
+        ...method,
         id
       }));
       return id;
@@ -201,8 +223,9 @@ export class Browser extends EventEmitter {
         id,
         method,
         params
-      })); // will resolve or reject when a matching response is received
+      }));
 
+      // will resolve or reject when a matching response is received
       return new Promise((resolve, reject) => {
         this.#callbacks.set(id, {
           error: new Error(),
@@ -213,26 +236,22 @@ export class Browser extends EventEmitter {
       });
     }
   }
-
   async spawn(timeout = 30000) {
     // spawn the browser process detached in its own group and session
     this.process = spawn(this.executable, this.args, {
       detached: process.platform !== 'win32'
-    }); // watch the process stderr and resolve when it emits the devtools protocol address
+    });
 
+    // watch the process stderr and resolve when it emits the devtools protocol address
     this.address = await new Promise((resolve, reject) => {
       let stderr = '';
-
       let handleData = chunk => {
         stderr += chunk = chunk.toString();
         let match = chunk.match(/^DevTools listening on (ws:\/\/.*)$/m);
         if (match) cleanup(() => resolve(match[1]));
       };
-
       let handleExitClose = () => handleError();
-
       let handleError = error => cleanup(() => reject(new Error(`Failed to launch browser. ${(error === null || error === void 0 ? void 0 : error.message) ?? ''}\n${stderr}'\n\n`)));
-
       let cleanup = callback => {
         clearTimeout(timeoutId);
         this.process.stderr.off('data', handleData);
@@ -241,7 +260,6 @@ export class Browser extends EventEmitter {
         this.process.off('error', handleError);
         callback();
       };
-
       let timeoutId = setTimeout(() => handleError(new Error(`Timed out after ${timeout}ms`)), timeout);
       this.process.stderr.on('data', handleData);
       this.process.stderr.on('close', handleExitClose);
@@ -250,10 +268,8 @@ export class Browser extends EventEmitter {
     });
     return this.address;
   }
-
   _handleMessage(data) {
     data = JSON.parse(data);
-
     if (data.method === 'Target.attachedToTarget') {
       // create a new session reference when attached to a target
       let session = new Session(this, data);
@@ -264,7 +280,6 @@ export class Browser extends EventEmitter {
       this.sessions.delete(data.params.sessionId);
       session === null || session === void 0 ? void 0 : session._handleClose();
     }
-
     if (data.sessionId) {
       // message was for a specific session that sent it
       let session = this.sessions.get(data.sessionId);
@@ -273,8 +288,8 @@ export class Browser extends EventEmitter {
       // resolve or reject a pending promise created with #send()
       let callback = this.#callbacks.get(data.id);
       this.#callbacks.delete(data.id);
-      /* istanbul ignore next: races with page._handleMessage() */
 
+      /* istanbul ignore next: races with page._handleMessage() */
       if (data.error) {
         callback.reject(Object.assign(callback.error, {
           message: `Protocol error (${callback.method}): ${data.error.message}` + ('data' in data.error ? `: ${data.error.data}` : '')
@@ -287,6 +302,5 @@ export class Browser extends EventEmitter {
       this.emit(data.method, data.params);
     }
   }
-
 }
 export default Browser;

package/dist/config.js

@@ -165,8 +165,9 @@ export const configSchema = {
       }
     }
   }
-}; // Common per-snapshot capture options
+};
 
+// Common per-snapshot capture options
 export const snapshotSchema = {
   $id: '/snapshot',
   $ref: '#/$defs/snapshot',
@@ -482,8 +483,9 @@ export const snapshotSchema = {
       }
     }
   }
-}; // Comparison upload options
+};
 
+// Comparison upload options
 export const comparisonSchema = {
   type: 'object',
   $id: '/comparison',
@@ -560,10 +562,12 @@ export const comparisonSchema = {
       }
     }
   }
-}; // Grouped schemas for easier registration
+};
 
-export const schemas = [configSchema, snapshotSchema, comparisonSchema]; // Config migrate function
+// Grouped schemas for easier registration
+export const schemas = [configSchema, snapshotSchema, comparisonSchema];
 
+// Config migrate function
 export function configMigration(config, util) {
   /* eslint-disable curly */
   if (config.version < 2) {
@@ -581,8 +585,9 @@ export function configMigration(config, util) {
       until: '2.0.0'
     });
   }
-} // Snapshot option migrate function
+}
 
+// Snapshot option migrate function
 export function snapshotMigration(config, util, root = '') {
   // discovery options have moved
   util.deprecate(`${root}.devicePixelRatio`, {
@@ -591,8 +596,9 @@ export function snapshotMigration(config, util, root = '') {
     until: '2.0.0',
     warn: true
   });
-} // Snapshot list options migrate function
+}
 
+// Snapshot list options migrate function
 export function snapshotListMigration(config, util) {
   if (config.snapshots) {
     // migrate each snapshot options
@@ -601,9 +607,9 @@ export function snapshotListMigration(config, util) {
         snapshotMigration(config, util, `snapshots[${i}]`);
       }
     }
-  } // migrate options
-
+  }
 
+  // migrate options
   if (Array.isArray(config.options)) {
     for (let i in config.options) {
       snapshotMigration(config, util, `options[${i}]`);
@@ -611,8 +617,9 @@ export function snapshotListMigration(config, util) {
   } else {
     snapshotMigration(config, util, 'options');
   }
-} // Grouped migrations for easier registration
+}
 
+// Grouped migrations for easier registration
 export const migrations = {
   '/config': configMigration,
   '/snapshot': snapshotMigration,