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

@quave/performance-audit

v1.0.5

Published

Easily check the performance of a web address according to Google's Lighthouse and compare with an expected baseline.

Downloads

67

Readme

Performance Audit by Quave

Easily check the performance of a web address according to Google's PageSpeed and compare with an expected baseline. To know more about the scores, see https://developers.google.com/web/tools/lighthouse. This test is designed to run on a CI to monitor the scores over time and notify when a regression occurs.

Installation

npm install @quave/performance-audit

How to use

Pass a array of tests to the checkPerformance function.

Test object structure:

  • url: The link to test
  • stategy: Should be desktop or mobile
  • threshold: How much the results need to differ to trigger a fail
  • pwa, bestPractices, accessibility, seo, performance: Scores baselines for the tests (optional)
  • appJsTransferSize, appCssTransferSize: Sizes baselines of the js and css bundles (optional)
  • jsIdentifier, cssIdentifier: String used to identify your app's bundle. (required if using appJsTransferSize or appCssTrasnferSize)

Additionally, you may pass a options as a second argument, to use values commom for all tests.

Example

// Example file app.slow.test.js
import { checkPerformance } from "@quave/performance-audit";

checkPerformance({
  applications: [
    {
      url: "https://www.meteor.com",
      strategy: "desktop",
      pwa: 0.69,
      bestPractices: 0.77,
      accessibility: 0.55,
      seo: 0.6,
      performance: 0.2,
      appJsTransferSize: 2168542,
      appCssTransferSize: 4513,
    },
  ],
  options: {
    threshold: 0.95,
    jsIdentifier: '.js?meteor_js_resource=true',
    cssIdentifier: '.css?meteor_css_resource=true',
  },
)

Jest

The library uses jest to run the test. It is set as a peer dependency, so you may choose which version to install.

Slow tests

This test usually takes several seconds to complete, and that is not great. We recommend creating a new test group e.g. slow group:

//File jest.slow.config.js
module.exports = {
  ...
  testRegex: '(/__tests__/.*|(\\.|/)(slow\\.test))\\.jsx?$',
  ...
};

And then creating the performance tests in a file with the suffix slow.test.js. These tests then can be executed by calling jest -c jest.slow.config.js.