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

@parallaxagency/retrogress

v1.0.6

Published

Make reference screenshots and check against them before comitting major changes to reduce chances of visual regression.

Downloads

2

Readme

Introduction

Tested on node version v8.9.4.

Retrogress allows you to make reference screenshots and check against them before comitting major changes to see whats changed and hopefully catch bugs earlier.

Uses puppeteer for generating page screenshots and pixelmatch for visual diffing.

Installation

To install retrogress in a project:

yarn add @parallaxagency/retrogress

Then add retrogress in an npm script for some nicer aliases:

{
  "scripts": {
    "diffs:reference": "retrogress --reference",
    "diffs:latest": "retrogress",
    "diffs:compare": "retrogress --diff"
  }
}

And finally you need to add a config file for the routes and sizes you want to generate screenshots for. Retrogress will look for a .retrogress.js file in the project root but you can change where this is located with the --config flag.

Config

The bare minimum you need in your .retrogress.js config is a routes object.

module.exports = {
  routes: {
    'home': 'http://example.com'
  }
}

The following options are available with defaults shown.

module.exports = {
  rootDir: path.join(process.cwd(), '/.retrogress'), // Defaults (not required)
  referenceFolder: 'reference', // Defaults (not required)
  latestFolder: 'latest', // Defaults (not required)
  diffsFolder: 'diffs', // Defaults (not required)
  sizes: [
    {
      width: 1920,
      height: 1080
    },
    {
      width: 320,
      height: 568
    }
  ],
  loadDelay: 1000, // Defaults (not required)
  pixelDifferenceThreshold: 0.1, // Defaults (not required)
  routes: { // (required)
    'home': 'http://example.com/',
    'about': 'http://example.com/about',
    'services-index': 'http://example.com/services',
    'services-view': 'http://example.com/services/view'
  }
}

Usage

Usage is fairly simple, when your happy with how the site looks run: npm run diffs:reference to generate your reference screenshots.

Then after doing any major changes you can run npm run diffs:latest and npm run diffs:compare to view any changes you've made.

All files generated are stored in the .retrogress folder in the project root.

Development Setup

To compile JS with babel and watch for changes:

npm run dev

To make a release version:

npm run transpile

To run linters:

npm run lint

It's unlikely you will even have to run the last two commands as they are automatically run when publishing a new version or committing changes.