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

@jungvonmatt/visual-test

v1.1.2

Published

Automated visual regression testing

Downloads

11

Readme

JvM Visual Regression Tester

Automates visual regression testing of our projects by comparing DOM screenshots over time. Convinience wrapper around BackstopJS.

Browser report

Getting started

Install

npm i @jungvonmatt/visual-test

Usage

Initialize project

visual-test reference

Run tests

visual-test test

Approve tests

visual-test approve

You can optionally add query parameters to the requests with the --query argument

visual-test test --query 'optimize-css=1&debug=true'

You can specify a custom config directory using the --config-dir option

visual-test test --config-dir ~/.my-visualtest-directory

Or just call with the url to the sitemap

visual-test test https://www.jvm.com/sitemap.xml

Add projects

To add a projects you need to place a config file in one of the following locations:

  • In a custom path specified by --config-dir
  • In the current working directory

Name: project.visualtest.config.js

Configuration

Config values

| Key | Description | | ------------ | ------------------------------------------------------------- | | name | Project name | | environments | Environment config. See below. | | urls | Array with urls or async function returning the urls to test. |

Environment Config values

| Key | Description | | ------- | --------------------------------- | | name | Environment name | | host | Hostname | | user | RFC2617 basic authorization: user | | | | pass | RFC2617 basic authorization: pass | | base | Base directory on host | | sitemap | Path to sitemap |

Examples

Minimal example

module.exports = {
  environments: [
    {
      name: 'Production',
      host: 'https://www.example.com',
      sitemap: '/sitemap.xml',
    },
  ],
};

Static urls

module.exports = {
  environments: [
    {
      name: 'Production',
      host: 'https://www.example.com',
    },
  ],
  urls: ['index.html', 'imprint.html'],
};

With urls function

module.exports = {
  environments: [
    {
      name: 'PREVIEW (EN)',
      host: 'http://preview.example.com',
      base: '/en',
      user: '',
      pass: '',
      sitemap: '/en/sitemap.xml',
    },
    {
      name: 'PROD',
      host: 'https://www.example.com',
      sitemap: '/sitemap.xml',
    },
  ],
  urls: async (environment) => {
    // The urls from the sitemap are available here
    const { urls } = environment || {};
    return urls.filter((url) => /regex/.test(url));
  },
};

Can I contribute?

Of course. We appreciate all of our contributors and welcome contributions to improve the project further. If you're uncertain whether an addition should be made, feel free to open up an issue and we can discuss it.

License

MIT