deps: update yargs to latest

lighthouse-cli/bin.js

@@ -102,21 +102,6 @@ async function begin() {
         ' Please use "--emulated-form-factor=none" instead.');
   }
 
-  if (typeof cliFlags.extraHeaders === 'string') {
-    // TODO: LH.Flags.extraHeaders is sometimes actually a string at this point, but needs to be
-    // copied over to LH.Settings.extraHeaders, which is LH.Crdp.Network.Headers. Force
-    // the conversion here, but long term either the CLI flag or the setting should have
-    // a different name.
-    /** @type {string} */
-    let extraHeadersStr = cliFlags.extraHeaders;
-    // If not a JSON object, assume it's a path to a JSON file.
-    if (extraHeadersStr.substr(0, 1) !== '{') {
-      extraHeadersStr = fs.readFileSync(extraHeadersStr, 'utf-8');
-    }
-
-    cliFlags.extraHeaders = JSON.parse(extraHeadersStr);
-  }
-
   if (cliFlags.precomputedLanternDataPath) {
     const lanternDataStr = fs.readFileSync(cliFlags.precomputedLanternDataPath, 'utf8');
     /** @type {LH.PrecomputedLanternData} */

lighthouse-cli/test/cli/bin-test.js

@@ -145,25 +145,6 @@ describe('CLI bin', function() {
     });
   });
 
-  describe('extraHeaders', () => {
-    it('should convert extra headers to object', async () => {
-      // @ts-expect-error - see TODO: in bin.js
-      cliFlags = {...cliFlags, extraHeaders: '{"foo": "bar"}'};
-      await bin.begin();
-
-      expect(getRunLighthouseArgs()[1]).toHaveProperty('extraHeaders', {foo: 'bar'});
-    });
-
-    it('should read extra headers from file', async () => {
-      const headersFile = require.resolve('../fixtures/extra-headers/valid.json');
-      // @ts-expect-error - see TODO: in bin.js
-      cliFlags = {...cliFlags, extraHeaders: headersFile};
-      await bin.begin();
-
-      expect(getRunLighthouseArgs()[1]).toHaveProperty('extraHeaders', require(headersFile));
-    });
-  });
-
   describe('precomputedLanternData', () => {
     it('should read lantern data from file', async () => {
       const lanternDataFile = require.resolve('../fixtures/lantern-data.json');

lighthouse-cli/test/cli/cli-flags-test.js

@@ -73,4 +73,25 @@ describe('CLI bin', function() {
     ]);
     expect(flags.blockedUrlPatterns).toEqual(['.*x,y\\.png']);
   });
+
+  describe('extraHeaders', () => {
+    it('should convert extra headers to object', async () => {
+      const flags = getFlags([
+        'http://www.example.com',
+        '--extra-headers="{"foo": "bar"}"',
+      ].join(' '));
+
+      expect(flags).toHaveProperty('extraHeaders', {foo: 'bar'});
+    });
+
+    it('should read extra headers from file', async () => {
+      const headersFile = require.resolve('../fixtures/extra-headers/valid.json');
+      const flags = getFlags([
+        'http://www.example.com',
+        `--extra-headers=${headersFile}`,
+      ].join(' '));
+
+      expect(flags).toHaveProperty('extraHeaders', require(headersFile));
+    });
+  });
 });

lighthouse-cli/test/smokehouse/frontends/smokehouse-bin.js

@@ -69,31 +69,54 @@ function getDefinitionsToRun(allTestDefns, requestedIds, {invertMatch}) {
  * CLI entry point.
  */
 async function begin() {
-  const argv = yargs
+  const rawArgv = yargs
     .help('help')
     .usage('node $0 [<options>] <test-ids>')
     .example('node $0 -j=1 pwa seo', 'run pwa and seo tests serially')
     .example('node $0 --invert-match byte', 'run all smoke tests but `byte`')
-    .describe({
-      'debug': 'Save test artifacts and output verbose logs',
-      'jobs': 'Manually set the number of jobs to run at once. `1` runs all tests serially',
-      'retries': 'The number of times to retry failing tests before accepting. Defaults to 0',
-      'runner': 'The method of running Lighthouse',
-      'tests-path': 'The path to a set of test definitions to run. Defaults to core smoke tests.',
-      'invert-match': 'Run all available tests except the ones provided',
+    .option('_', {
+      array: true,
+      type: 'string',
     })
-    .boolean(['debug', 'invert-match'])
-    .alias({
-      'jobs': 'j',
+    .options({
+      'debug': {
+        type: 'boolean',
+        default: false,
+        describe: 'Save test artifacts and output verbose logs',
+      },
+      'jobs': {
+        type: 'number',
+        alias: 'j',
+        describe: 'Manually set the number of jobs to run at once. `1` runs all tests serially',
+      },
+      'retries': {
+        type: 'number',
+        describe: 'The number of times to retry failing tests before accepting. Defaults to 0',
+      },
+      'runner': {
+        default: 'cli',
+        choices: ['cli', 'bundle'],
+        describe: 'The method of running Lighthouse',
+      },
+      'tests-path': {
+        type: 'string',
+        describe: 'The path to a set of test definitions to run. Defaults to core smoke tests.',
+      },
+      'invert-match': {
+        type: 'boolean',
+        default: false,
+        describe: 'Run all available tests except the ones provided',
+      },
     })
-    .choices('runner', ['cli', 'bundle'])
-    .default('runner', 'cli')
     .wrap(yargs.terminalWidth())
     .argv;
 
-  // TODO: use .number() when yargs is updated
-  const jobs = argv.jobs !== undefined ? Number(argv.jobs) : undefined;
-  const retries = argv.retries !== undefined ? Number(argv.retries) : undefined;
+  // Augmenting yargs type with auto-camelCasing breaks in [email protected] and @types/[email protected],
+  // so for now cast to add yarg's camelCase properties to type.
+  const argv = /** @type {typeof rawArgv & CamelCasify<typeof rawArgv>} */ (rawArgv);
+
+  const jobs = Number.isFinite(argv.jobs) ? argv.jobs : undefined;
+  const retries = Number.isFinite(argv.retries) ? argv.retries : undefined;
 
   const runnerPath = runnerPaths[/** @type {keyof typeof runnerPaths} */ (argv.runner)];
   if (argv.runner === 'bundle') {

lighthouse-core/scripts/compare-runs.js

@@ -27,7 +27,7 @@ const {ProgressLogger} = require('./lantern/collect/common.js');
 const LH_ROOT = `${__dirname}/../..`;
 const ROOT_OUTPUT_DIR = `${LH_ROOT}/timings-data`;
 
-const argv = yargs
+const rawArgv = yargs
   .help('help')
   .describe({
     // common flags
@@ -51,12 +51,14 @@ const argv = yargs
     'delta-property-sort': 'Property to sort by its delta',
     'desc': 'Set to override default ascending sort',
   })
+  .option('n', {type: 'number', default: 1})
   .string('filter')
+  .string('url-filter')
   .alias({'gather': 'G', 'audit': 'A'})
   .default('report-exclude', 'key|min|max|stdev|^n$')
   .default('delta-property-sort', 'mean')
   .default('output', 'table')
-  .array('urls')
+  .option('urls', {array: true, type: 'string'})
   .string('lh-flags')
   .default('desc', false)
   .default('sort-by-absolute-value', false)
@@ -65,6 +67,10 @@ const argv = yargs
   .wrap(yargs.terminalWidth())
   .argv;
 
+// Augmenting yargs type with auto-camelCasing breaks in [email protected] and @types/[email protected],
+// so for now cast to add yarg's camelCase properties to type.
+const argv = /** @type {typeof rawArgv & CamelCasify<typeof rawArgv>} */ (rawArgv);
+
 const reportExcludeRegex =
   argv.reportExclude !== 'none' ? new RegExp(argv.reportExclude, 'i') : null;
 
@@ -120,12 +126,15 @@ function round(value) {
  * @param {number} total
  * @return {string}
  */
-function getProgressBar(i, total = argv.n * argv.urls.length) {
+function getProgressBar(i, total = argv.n * (argv.urls || []).length) {
   const bars = new Array(Math.round(i * 40 / total)).fill('▄').join('').padEnd(40);
   return `${i + 1} / ${total} [${bars}]`;
 }
 
 async function gather() {
+  if (typeof argv.name !== 'string') {
+    throw new Error('expected entry for name option');
+  }
   const outputDir = dir(argv.name);
   if (fs.existsSync(outputDir)) {
     console.log('Collection already started - resuming.');
@@ -136,7 +145,7 @@ async function gather() {
   progress.log('Gathering…');
 
   let progressCount = 0;
-  for (const url of argv.urls) {
+  for (const url of argv.urls || []) {
     const urlFolder = `${outputDir}/${urlToFolder(url)}`;
     await mkdir(urlFolder, {recursive: true});
 
@@ -161,12 +170,15 @@ async function gather() {
 }
 
 async function audit() {
+  if (typeof argv.name !== 'string') {
+    throw new Error('expected entry for name option');
+  }
   const outputDir = dir(argv.name);
   const progress = new ProgressLogger();
   progress.log('Auditing…');
 
   let progressCount = 0;
-  for (const url of argv.urls) {
+  for (const url of argv.urls || []) {
     const urlDir = `${outputDir}/${urlToFolder(url)}`;
     for (let i = 0; i < argv.n; i++) {
       const gatherDir = `${urlDir}/${i}`;
@@ -309,6 +321,9 @@ function isNumber(value) {
 }
 
 function summarize() {
+  if (typeof argv.name !== 'string') {
+    throw new Error('expected entry for name option');
+  }
   const results = aggregateResults(argv.name);
   print(filter(results));
 }

package.json

@@ -114,7 +114,7 @@
     "@types/semver": "^5.5.0",
     "@types/update-notifier": "^4.1.0",
     "@types/ws": "^4.0.1",
-    "@types/yargs": "^8.0.2",
+    "@types/yargs": "^15.0.11",
     "@types/yargs-parser": "^15.0.0",
     "@typescript-eslint/parser": "^4.7.0",
     "@wardpeet/brfs": "2.1.0",
@@ -188,8 +188,8 @@
     "third-party-web": "^0.12.2",
     "update-notifier": "^4.1.0",
     "ws": "3.3.2",
-    "yargs": "3.32.0",
-    "yargs-parser": "^18.1.3"
+    "yargs": "^16.1.1",
+    "yargs-parser": "^20.2.4"
   },
   "repository": "GoogleChrome/lighthouse",
   "keywords": [