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 🙏

© 2020 – Ryan Hefner

reg-cli

v0.16.0

Published

![reg-cli](./docs/reg-cli.jpg)

Downloads

81,892

Maintainers

bokuwebbokuweb

Keywords

Readme

reg-cli

[Build Status](https://circleci.com/gh/reg-viz/reg-cli/tree/master) [Build Status](https://travis-ci.org/reg-viz/reg-cli) [Build Status](https://ci.appveyor.com/project/bokuweb/reg-cli) [npm package](https://www.npmjs.com/package/reg-cli) [npm package downloads](https://www.npmjs.com/package/reg-cli)

Visual regression test tool with html reporter.

Table of Contents

Installation

Requirements

  • Node.js v8+

reg-cli support Node.js v8+

$ npm i -D reg-cli

Usage

CLI

$ reg-cli /path/to/actual-dir /path/to/expected-dir /path/to/diff-dir -R ./report.html

Options

  • -U, --update Update expected images.(Copy `actual images` to `expected images`).
  • -R, --report Output html report to specified directory.
  • -J, --json Specified json report path. If omitted ./reg.json
  • -I, --ignoreChange If true, error will not be thrown when image change detected.
  • -E, --extendedErrors If true, also added/deleted images will throw an error.
  • -P, --urlPrefix Add prefix to all image src.
  • -M, --matchingThreshold Matching threshold, ranges from 0 to 1. Smaller values make the comparison more sensitive. 0 by default.
  • -T, --thresholdRate Rate threshold for detecting change. When the difference ratio of the image is larger than the set rate detects the change. Applied after matchingThreshold.
  • -S, --thresholdPixel Pixel threshold for detecting change. When the difference pixel of the image is larger than the set pixel detects the change. This value takes precedence over thresholdRate. Applied after matchingThreshold.
  • -C, --concurrency How many processes launches in parallel. If omitted 4.
  • -A, --enableAntialias Enable antialias. If omitted false.
  • -X, --additionalDetection. Enable additional difference detection(highly experimental). Select "none" or "client" (default: "none").
  • -F, --from Generate report from json. Please specify json file. If set, only report will be output without comparing images.

html report

If -R option set, output html report to specified directory. https://reg-viz.github.io/reg-cli/

open close viewer

from json

If -F option set, only report will be output without comparing images.

reg-cli.js -F ./sample/reg.json -R ./sample/index.html"
  • json format
{
    "failedItems": ["sample.png"],
    "newItems":[],
    "deletedItems":[],
    "passedItems":[],
    "expectedItems":["sample.png"],
    "actualItems":["sample.png"],
    "diffItems":["sample.png"],
    "actualDir":"./actual",
    "expectedDir":"./expected",
    "diffDir":"./diff"
}

Test

$ npm t

Contribute

PRs welcome.

License

The MIT License (MIT)

Copyright (c) 2017 bokuweb

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

reg-viz