Adding new form factor and improving PR comments

README.md

@@ -503,7 +503,7 @@ Below are options for the exported `lighthouseCheck` function or `lighthouse-che
   <tr>
     <td><code>emulatedFormFactor</code></td>
     <td>Lighthouse setting only used for local audits. See <a href="src/lighthouseConfig.js">src/lighthouseConfig.js</a> comments for details.</td>
-    <td><code>oneOf(['mobile', 'desktop']</code></td>
+    <td><code>oneOf(['mobile', 'desktop','both'])</code></td>
     <td><code>local</code></td>
     <td><code>undefined</code></td>
     <td>no</td>

src/lighthouseCheck.js

@@ -17,7 +17,7 @@ export default ({
   awsBucket,
   awsRegion,
   awsSecretAccessKey,
-  emulatedFormFactor,
+  emulatedFormFactor = 'mobile',
   extraHeaders,
   branch,
   isGitHubAction,

src/localLighthouse.js

@@ -108,6 +108,7 @@ export const localLighthouse = async ({
     url,
     localReport,
     report,
+    emulatedFormFactor,
     scores
   };
 };
@@ -143,11 +144,7 @@ export default async ({
   let index = 1;
 
   for (const url of urls) {
-    if (verbose) {
-      console.log(`${NAME}: Auditing (${index}/${urls.length}) ${url}`);
-    }
-
-    const lighthouseAuditResult = await localLighthouse({
+    const options = {
       awsAccessKeyId,
       awsBucket,
       awsRegion,
@@ -160,11 +157,38 @@ export default async ({
       overrides,
       throttling,
       throttlingMethod,
-      url
-    });
+      url,
+      verbose
+    };
 
-    auditResults.push(lighthouseAuditResult);
-    index++;
+    if (options.emulatedFormFactor !== 'both') {
+      if (verbose) {
+        console.log(
+          `${NAME}: Auditing (${index}/${urls.length}) ${options.url} in Mode:${options.emulatedFormFactor}`
+        );
+      }
+      const lighthouseAuditResult = await localLighthouse(options);
+      auditResults.push(lighthouseAuditResult);
+      index++;
+    } else {
+      options.emulatedFormFactor = 'desktop';
+      if (verbose) {
+        console.log(
+          `${NAME}: Auditing (${index}/${urls.length}) ${options.url} in Mode:${options.emulatedFormFactor}`
+        );
+      }
+      const lighthouseAuditResultDesktop = await localLighthouse(options);
+      options.emulatedFormFactor = 'mobile';
+      if (verbose) {
+        console.log(
+          `${NAME}: Auditing (${index}/${urls.length}) ${options.url} in Mode:${options.emulatedFormFactor}`
+        );
+      }
+      const lighthouseAuditResultMobile = await localLighthouse(options);
+      auditResults.push(lighthouseAuditResultDesktop);
+      auditResults.push(lighthouseAuditResultMobile);
+      index++;
+    }
   }
 
   // if outputDirectory is specified write the results to disk

src/postPrComment.js

@@ -32,6 +32,9 @@ export default async ({
         });
       });
 
+      // the emulatedformfactor
+      markdown += `\n\n Mode: **${result.emulatedFormFactor}**`;
+
       // the url
       markdown += `\n\n${result.url}`;
 
@@ -48,7 +51,7 @@ export default async ({
 
     // create an identifier within the comment when searching comments
     // in the future
-    const commentIdentifier = '<!-- generated by lighthouse-check -->';
+    const commentIdentifier = '\n<!-- generated by lighthouse-check -->';
     markdown += commentIdentifier;
 
     // establish existing comment