Print stats and display category name only if violations exist

Author: kuychaco

index.js

@@ -6,7 +6,16 @@ const queue = require('async/queue')
 const fs = require('fs')
 const colors = require('colors')
 
+const stats = {
+  pageCount: 0,
+  violationCounts: {},
+  passedAuditsCount: 0,
+  startTime: null,
+  auditTimesByPageUrl: {}
+}
+
 module.exports = (options) => {
+  stats.startTime = new Date()
   const configPath = path.resolve(options.config)
   const config = JSON.parse(fs.readFileSync(configPath))
 
@@ -39,6 +48,7 @@ module.exports = (options) => {
   })
   crawler.once('complete', () => {
     lighthouseQueue.drain = () => {
+      printStats()
       if (totalErrorCount > 0) {
         process.exit(1)
       }
@@ -49,6 +59,7 @@ module.exports = (options) => {
 }
 
 function runLighthouse (url, configPath, callback) {
+  stats.pageCount++
   const args = [
     url,
     '--output=json',
@@ -67,7 +78,10 @@ function runLighthouse (url, configPath, callback) {
   lighthouse.stdout.on('data', (data) => {
     output += data
   })
+
+  stats.auditTimesByPageUrl[url] = {startTime: new Date()}
   lighthouse.once('close', () => {
+    stats.auditTimesByPageUrl[url].endTime = new Date()
     let errorCount = 0
 
     let report
@@ -80,22 +94,34 @@ function runLighthouse (url, configPath, callback) {
     }
 
     report.reportCategories.forEach((category) => {
-      console.log();
-      console.log(category.name.bold.underline);
+      let displayedCategory = false
       category.audits.forEach((audit) => {
-        if (audit.score !== 100) {
+        if (audit.score === 100) {
+          stats.passedAuditsCount++
+        } else {
+          if (!displayedCategory) {
+            console.log();
+            console.log(category.name.bold.underline);
+            displayedCategory = true
+          }
           errorCount++
           console.log(url.replace(/\/$/, ''), '\u2717'.red, audit.id.bold, '-', audit.result.description.italic)
 
+          if (stats.violationCounts[category.name] === undefined) {
+            stats.violationCounts[category.name] = 0
+          }
+
           if (audit.result.extendedInfo) {
             const {value} = audit.result.extendedInfo
             if (Array.isArray(value)) {
+              stats.violationCounts[category.name] += value.length
               value.forEach((result) => {
                 if (result.url) {
                   console.log(`   ${result.url}`)
                 }
               })
             } else if (Array.isArray(value.nodes)) {
+              stats.violationCounts[category.name] += value.nodes.length
               const messagesToNodes = {}
               value.nodes.forEach((result) => {
                 let message = result.failureSummary
@@ -109,9 +135,11 @@ function runLighthouse (url, configPath, callback) {
               Object.keys(messagesToNodes).forEach((message) => {
                 console.log(`   ${message}`)
                 messagesToNodes[message].forEach(node => {
-                  console.log(`     ${node}`.dim)
+                  console.log(`     ${node}`.gray)
                 })
               })
+            } else {
+              stats.violationCounts[category.name]++
             }
           }
         }
@@ -121,3 +149,21 @@ function runLighthouse (url, configPath, callback) {
     callback(errorCount)
   })
 }
+
+function printStats() {
+  console.log();
+  console.log();
+  console.log('Lighthouse Summary'.bold.underline);
+  console.log(`  Total Pages Scanned: ${stats.pageCount}`);
+  console.log(`  Total Auditing Time: ${new Date() - stats.startTime} ms`);
+  const totalTime = Object.keys(stats.auditTimesByPageUrl).reduce((sum, url) => {
+    const {endTime, startTime} = stats.auditTimesByPageUrl[url]
+    return (endTime - startTime) + sum
+  }, 0)
+  console.log(`  Average Page Audit Time: ${Math.round(totalTime/stats.pageCount)} ms`);
+  console.log(`  Total Audits Passed: ${stats.passedAuditsCount}`, '\u2713'.green);
+  console.log(`  Total Violations:`);
+  Object.keys(stats.violationCounts).forEach(category => {
+    console.log(`    ${category}: ${stats.violationCounts[category]}`, '\u2717'.red);
+  })
+}