Lighthouse_Feature

Author: akshayp7

Lighthouse.js

@@ -0,0 +1,25 @@
+const fs = require('fs');
+const lighthouse = require('lighthouse');
+const chromeLauncher = require('chrome-launcher');
+
+(async () => {
+  const chrome = await chromeLauncher.launch({chromeFlags: ['--headless']});
+  const options = {logLevel: 'info',output: 'html',onlyCategories: ['performance'],port: chrome.port};
+  
+   // Below configuration is for Desktop mode
+  const config = { extends: 'lighthouse:default', settings: {formFactor: 'desktop', screenEmulation:{mobile:false}} }
+  // Below configuration is for Mobile devices 
+  // const config = { extends: 'lighthouse:default', settings: {formFactor: 'mobile', screenEmulation:{mobile:true}} }
+
+  const runnerResult = await lighthouse('https://www.google.com',options,config);
+
+  // `.report` is the HTML report as a string
+  const reportHtml = runnerResult.report;
+  fs.writeFileSync('LighthouseReport.html', reportHtml);
+
+  // `.lhr` is the Lighthouse Result as a JS object
+  console.log('Report is done for', runnerResult.lhr.finalUrl);
+  console.log('Performance score was', runnerResult.lhr.categories.performance.score * 100);
+
+  await chrome.kill();
+})();

README.md

@@ -21,6 +21,7 @@
             <li><a href="#reports">Reports</a></li>
             <li><a href="#sonarqube">SonarQube</a></li>
             <li><a href="#docker">Docker</a></li>
+            <li><a href="#lighthouse">Lighthouse</a></li>
           </ol>
         </h5>    
     </details>
@@ -65,6 +66,7 @@ Bonus:
 - [adm-zip](https://www.npmjs.com/package/adm-zip)
 - [ESLint](https://eslint.org/)
 - [SonarQube](https://www.sonarqube.org/)
+- [Lighthouse](https://developers.google.com/web/tools/lighthouse)
 
 ## Getting Started
 
@@ -237,6 +239,16 @@ Once you have edited the CMD section we have to follow Step 1 to build a new ima
 CMD ["npx","cross-env","ENV=qa","npm","run","test:serial"]
 ```
 
+## Lighthouse
+Lighthouse is an open-source, automated tool for improving the quality of web pages. You can run it against any web page, public or requiring authentication. It has audits for performance, accessibility, progressive web apps, SEO and more.
+I have configure Lighthouse for Performance in my Project.
+- To configure Lighthouse navigate to "Lighthouse.js" and replace "https://www.google.com" with desired URL to test.
+- To run test on Mobile devices, comment out desktop mode config line and uncomment the config line written for mobile devices, Default Device is Moto G4
+- To run Lighhouse test use below command, reports will be generated in htnl format in root directory with name "LighthouseReport.html" 
+```JS
+npm run lighthouse
+```
+
 <!-- MARKDOWN LINKS & IMAGES -->
 
 [overall-report-screenshot]: ReadMeImages/OverallReport.PNG