npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

lighthouse-aggregate-report

v1.4.2

Published

Google Lighthouse aggregate report

Downloads

36

Readme

lighthouse-aggregate-report

A Google Lighthouse aggregate Test Reporter

PDF CI

Installation

npm install lighthouse-aggregate-report

Usage

More examples can be found inspecting the Tests

  1. Default Lighthouse report (performance, accessibility, best-practices, seo):

     import { lighthouseReport } from 'lighthouse-aggregate-report';
     const options = {
          url: 'https://google.com',
     };
     const results = await lighthouseReport(options);
     console.log(results)
     Output:  { performance: 50, 'accessibility': 83, best-practices: 90, seo:100}
     Assertion: expect(results.performance >= 80).toBeTruthy();
  2. Only selected metrics (e.g., 'accessibility'):

     import { lighthouseReport, Categories } from 'lighthouse-aggregate-report';
     const options = {
          url: 'https://google.com',
          lighthouse: { 
          onlyCategories: [
              Categories.accessibility,
          ] 
        },
     };
     const results = await lighthouseReport(options);
     console.log(results)
     Output:  { 'accessibility': 83 }
     Assertion: expect(results.accessibility).to.eq(myThreshold)
      
  3. Selected Audit metrics:

     import { lighthouseReport, Audits } from 'lighthouse-aggregate-report';
     const options = {
          targetUrl: 'https://google.com',
          lighthouse: {
            onlyAudits: [
                Audits.firstContentfulPaint,
                Audits.interactive
            ],
         },
     };
     const results = await lighthouseReport(options);
     console.log(results)
     Output: {  performance: 97,  accessibility: 80, 'best-practices': 100,  seo: 85, interactive: 100,  'first-contentful-paint': 99 }
     Assertion: expect(results.interactive).to.eq(myThreshold)
      
  4. Full head (will open the browser) to troubleshoot the Login (set headed=true in the Login parameter):

     import { lighthouseReport } from 'lighthouse-aggregate-report';
     const options = {
          Login: {
              headed: true
          },
     }; 
  5. Mobile Report (set isMobile=true):

     import { lighthouseReport } from 'lighthouse-aggregate-report';
      const options = {
           isMobile: true,
           targetUrl: 'https://google.com',
      };
    
  6. Generate HTML Report (set htmlReport=true):

     import { lighthouseReport } from 'lighthouse-aggregate-report';
      const options = {
           htmlReport: true,
           targetUrl: 'https://google.com',
      };
  7. Debug errors (set debug=true):

     import { lighthouseReport } from 'lighthouse-aggregate-report';
     const options = {
          targetUrl: 'https://notavalidurl.com/',
          lighthouse: {
             debug: true,
          },
     };
    results = await lighthouseReport(options);
    console.log(results.error)

Contribution

Fork, add your changes and create a pull request