feat(cli): print audit title and documentation link

GoogleChrome · Oct 21, 2019 · 261fd0a · 261fd0a
1 parent 2bb88a6
commit 261fd0a
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 2 deletions.
diff --git a/packages/cli/src/assert/assert.js b/packages/cli/src/assert/assert.js
@@ -72,12 +72,23 @@ async function runCommand(options) {
     for (const result of sortedResults) {
       hasFailure = hasFailure || result.level === 'error';
       const label = result.level === 'warn' ? 'warning' : 'failure';
-      const warningOrErrorIcon = result.level === 'warn' ? '⚠️ ' : `${log.redify(log.cross)} `;
+      const icon = result.level === 'warn' ? '⚠️ ' : `${log.redify(log.cross)} `;
       const idPart = `${log.bold}${result.auditId}${log.reset}`;
       const propertyPart = result.auditProperty ? `.${result.auditProperty}` : '';
       const namePart = `${log.bold}${result.name}${log.reset}`;
+
+      const auditTitlePart = result.auditTitle || '';
+      const documentationPart = result.auditDocumentationLink
+        ? `Documentation: ${result.auditDocumentationLink}`
+        : '';
+      const titleAndDocs = [auditTitlePart, documentationPart]
+        .filter(Boolean)
+        .map(s => `     ` + s)
+        .join('\n');
+      const humanFriendlyParts = titleAndDocs ? `\n${titleAndDocs}\n` : '';
+
       process.stderr.write(`
-  ${warningOrErrorIcon} ${idPart}${propertyPart} ${label} for ${namePart} assertion
+  ${icon} ${idPart}${propertyPart} ${label} for ${namePart} assertion${humanFriendlyParts}
         expected: ${result.operator}${log.greenify(result.expected)}
            found: ${log.redify(result.actual)}
       ${log.dim}all values: ${result.values.join(', ')}${log.reset}\n\n`);

diff --git a/packages/cli/test/autorun.test.js b/packages/cli/test/autorun.test.js
@@ -56,6 +56,9 @@ describe('Lighthouse CI autorun CLI', () => {
       1 result(s) for [1mhttp://localhost:XXXX/good.html[0m
 
         [31m✘[0m  [1mviewport[0m failure for [1mminScore[0m assertion
+           Does not have a \`<meta name=\\"viewport\\">\` tag with \`width\` or \`initial-scale\`
+           Documentation: https://web.dev/viewport
+
               expected: >=[32m1[0m
                  found: [31m0[0m
             [2mall values: 0, 0, 0[0m

diff --git a/packages/cli/test/cli.test.js b/packages/cli/test/cli.test.js
@@ -234,6 +234,9 @@ describe('Lighthouse CI CLI', () => {
         1 result(s) for [1mhttp://localhost:XXXX/app/[0m
 
           [31m✘[0m  [1mworks-offline[0m failure for [1mminScore[0m assertion
+             Current page does not respond with a 200 when offline
+             Documentation: https://web.dev/works-offline
+
                 expected: >=[32m1[0m
                    found: [31m0[0m
               [2mall values: 0, 0[0m
@@ -265,6 +268,9 @@ describe('Lighthouse CI CLI', () => {
         1 result(s) for [1mhttp://localhost:XXXX/app/[0m
 
           [31m✘[0m  [1mperformance-budget[0m.script.size failure for [1mmaxNumericValue[0m assertion
+             Performance budget
+             Documentation: https://developers.google.com/web/tools/lighthouse/audits/budgets
+
                 expected: <=[32mXXXX[0m
                    found: [31mXXXX[0m
               [2mall values: XXXX[0m
@@ -295,12 +301,18 @@ describe('Lighthouse CI CLI', () => {
         2 result(s) for [1mhttp://localhost:XXXX/app/[0m
 
           [31m✘[0m  [1mfirst-contentful-paint[0m failure for [1mmaxNumericValue[0m assertion
+             First Contentful Paint
+             Documentation: https://web.dev/first-contentful-paint
+
                 expected: <=[32m1[0m
                    found: [31mXXXX[0m
               [2mall values: XXXX, XXXX[0m
 
 
           [31m✘[0m  [1mperformance-budget[0m.script.size failure for [1mmaxNumericValue[0m assertion
+             Performance budget
+             Documentation: https://developers.google.com/web/tools/lighthouse/audits/budgets
+
                 expected: <=[32mXXXX[0m
                    found: [31mXXXX[0m
               [2mall values: XXXX[0m
@@ -329,6 +341,9 @@ describe('Lighthouse CI CLI', () => {
         1 result(s) for [1mhttp://localhost:XXXX/app/[0m
 
           [31m✘[0m  [1mresource-summary[0m.script.size failure for [1mmaxNumericValue[0m assertion
+             Keep request counts low and transfer sizes small
+             Documentation: https://developers.google.com/web/tools/lighthouse/audits/budgets
+
                 expected: <=[32m1[0m
                    found: [31mXXXX[0m
               [2mall values: XXXX, XXXX[0m