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

fuzi

v1.2.0-alpha

Published

🐻 fuzzy image diff'ing for the terminal

Downloads

19

Readme

🚧 Alpha Version (Work in Progress)

API subject to change


Fuzi!

🐻 fuzzy image diff'ing for the terminal

Build Status Coverage Status NPM Version XO code style

Support

Support the development of Fuzi by becoming a patreon.

Example

Need to check the difference between two images? Ask Fuzi! 🐻

$ fuzi red-square.png green-circle.jpg -v

Fuzi! in action

Features

  • Diff images from the CLI
  • Diff in API Mode for use in test frameworks
  • Images do not have to match
    • Size can be different
    • Dimensions can be different
    • File type can be different
  • Supports file-types: PNG, JPG
  • Configurable settings for tweaking each tests

About

Fuzi is an image diffing tool for Ref-Testing in a CI environment, (Travis, Circle, etc). Fuzi outputs graphics to your terminal, making it quicker to understand why a test is failing.

CLI plus API

Fuzi can diff in the CLI so that you can experiment and get used to it's inputs and outputs. Fuzi diff as a Node API to use in your testing framework.

Call it a "PASS"

When your tests fail in the cloud, Fuzi gives you the tolerance settings required to make the test pass the next time it runs. Phew!

Test details in the Terminal

Installation

For global use:

$ npm i -g fuzi
$ yarn --global add fuzi

For local testing:

$ npm i --save-dev fuzi
$ yarn add fuzi

How does Fuzi work?

Grid

Rather than try to compare the whole image, Fuzi splits each image into a spatial grid and compares the two. This helps to evaluated which parts of the image match, and which are different.

Channels

Fuzi splits your images into 4 channels to finds the average value for each grid square. These chanels are:

  • Hue
  • Saturation
  • Luminance
  • Alpha

Tolerance

Fuzi then takes the tolerance parameter you provide, and compares the average chanel values in each square to see if they are above or below your threshold.

The thresholds default to 0:

const opts = {
	tolerance: {
		hue: 0,
		sat: 0,
		lum: 0,
		alp: 0
	}
}

PASS or FAIL

If any grid square's average channel value is above the tolerance (for any channel), your images are considered to be different.

This results in a FAIL.

If all grid squares average channel values are below your provided tolerance threshold, then your images are considered to the alike.

Using Fuzi with your Test Framework

import test from 'ava'
import fuzi from 'fuzi'

test('Different images fail', async t => {
	const img1 = 'fixtures/green-circle.png'
	const img2 = 'fixtures/red-square.png'

	const opts = {
		grid: {
			columns: 8,
			rows: 8
		},
		tolerance: {
			hue: 0,
			sat: 0,
			lum: 0,
			alp: 0
		}
	}

	const result = await fuzi(img1, img2, opts)
	t.true(result.fail)
})
import test from 'ava'
import fuzi from 'fuzi'

test('Identical images pass', async t => {
	const img1 = 'fixtures/green-circle.png'
	const img2 = 'fixtures/green-circle.png'
	const opts = {
		grid: {
			columns: 8,
			rows: 8
		},
		tolerance: {
			hue: 0,
			sat: 0,
			lum: 0,
			alp: 0
		}
	}
	const result = await fuzi(img1, img2, opts)
	t.true(result.pass)
})