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

@mercuryworks/lighthouse

v0.0.25

Published

Run a Mercury Lighthouse test for a client URL against the PageSpeed Insights API.

Downloads

6

Readme

Getting Started

  1. You'll need Node installed locally or on your CI release environment (use the LTS version, currently >= 12.x.x)

  2. You'll need either npm or yarn available

  3. Create a new folder in your Mercury project: Let's call it basic-lighthouse-test

  4. Add a package.json file inside of basic-lighthouse-test with the following JSON code:

    {
      "dependencies": {
        "@mercuryworks/lighthouse": "0.0.25",
        "@types/node": "14.0.27",
        "dotenv": "8.2.0",
        "ts-node": "8.10.2",
        "typescript": "3.9.7"
      },
      "license": "UNLICENSED",
      "name": "basic-lighthouse-test",
      "scripts": {
        "test": "ts-node index.ts"
      },
      "version": "0.0.1"
    }
  5. Add an index.ts file inside of basic-lighthouse-test with the following TypeScript code:

    import dotenv from 'dotenv';
    dotenv.config();
    import runMercuryLighthouseReport from '@mercuryworks/lighthouse';
    
    const run = async () => {
      try {
        const passed = await runMercuryLighthouseReport({ apiKey: process.env.API_KEY as string, url: process.env.APP_URL as string });
        // optional: exit node with an error code
        if (!passed) {
          process.exit(1);
        } else {
          process.exit(0);
        }
      } catch (err) {
        // runMercuryLighthouseReport always resolves when configured correctly
        console.error(err);
      }
    };
    
    run();
  6. To run locally, add a .env file inside of basic-lighthouse-test (replace APP_URL with your project URL):

    API_KEY=""
    APP_URL="https://www.mercuryworks.com"
  7. To run in a CI release, make sure to have an app setting/environment variable available for APP_URL

  8. With a terminal pointed to the basic-lighthouse-test directory, run with either yarn test or npm run test

Options

The runMercuryLighthouseReport Promise takes the following options:

interface IMercuryLighthouseReportOptions {
  accessibilityScoreMin?: number; // default is 90
  bestPracticesScoreMin?: number; // default is 90
  performanceScoreMin?: number; // default is 90
  pwaScoreMin?: number; // default is 90
  seoScoreMin?: number; // default is 90
  strategyType?: 'mobile' | 'desktop'; // default is 'mobile'
  timeout?: number; // default is 120000 (two minutes)
  url: string;
}

Publishing

  1. Run yarn build
  2. Login to npm locally with npm login
  3. Test publishing this package by running npm publish ./build --access public --dry-run
  4. Publish this package by running npm publish ./build --access public
  5. Verify the version updated at https://www.npmjs.com/package/@mercuryworks/lighthouse