Function processResults

docs/tools/lighthouse-audit.mjs:248–280

* @param results from a Lighthouse run * @param minScores the minimum acceptable scores for each audit category * @param logFile optional file path to write the report to * @returns true if all of the scores were above the required min scores, false otherwise

(results, minScores, logFile)

 * @returns true if all of the scores were above the required min scores, false otherwise
 */
async function processResults(results, minScores, logFile) {
  const lhVersion = results.lhr.lighthouseVersion;
  const categories = results.lhr.categories;
  const report = results.report;

  if (logFile) {
    console.log(`\nSaving results in '${logFile}'...`);
    console.log(`  LightHouse viewer: ${VIEWER_URL}`);

    await lighthouseWrite(report, OutputMode.json, logFile);
  }

  console.log(`\nLighthouse version: ${lhVersion}`);
  console.log('\nAudit results:');

  const maxTitleLen = Math.max(...Object.values(categories).map(({title}) => title.length));
  return Object.keys(categories)
    .sort()
    .reduce((aggr, cat) => {
      const {title, score} = categories[cat];
      const paddedTitle = `${title}:`.padEnd(maxTitleLen + 1);
      const minScore = minScores[cat];
      const passed = !isNaN(score) && score >= minScore;

      console.log(
        `  - ${paddedTitle}  ${formatScore(score)}  (Required: ${formatScore(minScore)})  ${
          passed ? 'OK' : 'FAILED'
        }`,
      );

      return aggr && passed;
    }, true);
}

/**
 * Logs the audits skipped based on the contents of a constant and updates the Lighthouse