Socket
Socket
Sign inDemoInstall

chigai-cli

Package Overview
Dependencies
180
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    chigai-cli

Chigai: modern visual regression testing. CLI module.


Version published
Maintainers
1
Created

Readme

Source

chigai-cli Build Status

Modern visual regression testing with puppeteer and blink-diff

Visual regression testing

Visual regression testing: compare your current state against your baseline. It's nothing new. We've done this for ages. Comparing two images. Looking at the current version and the previous one. Searching for the difference. On our own. Manually.

Well, Chiagi does this automatically. It takes a screenshot from a given URI and compares it to the previous version.

Automated. Always

Chigai is designed to be used in your tests. You can use it in your favourite testrunner. As a regression tool. If your layout changes, it won't go on unnoticed.

How to use this?

Chigai-cli provides a clean facade for chiga-core. The regression testing of a given url and creating a fresh reference item beforehand. Chigai-cli is designed to be used in your favourite build script.

Regression testing

Provide a url and options such as the viewport width (default: 1024), viewport height (default: 720) or a threshold (default: 0.01 = 1%) for the image comparison. Chigai-cli creates a new screenshot of the whole page and compares it to the last specified reference. If their difference is lower than the given threshold it will exit with 0``, otherwise 1```.

Fresh reference

If you know you changed the layout, just set a new reference item before running the tests again.

Installation

$ yarn add chigai-cli chigai-cli

Regression test on the CLI

$ chigai regression http://example.com -w 1200 -h 800 -t 0.01

Create a fresh reference on the CLI

$ chigai reference http://example.com -w 1200 -h 800 -t 0.01

Tech Stack

  • ECMAScript 2018 on nodejs v8.5.0
  • blink-diff v^1.0.1
  • fs-extra-plus v0.1.3
  • puppeteer v0.11.0
  • yargs v9.10
  • cross-spawn v5.1.0
  • Complete testsuite based on mocha v3.5.2and chai v4.1.2

Resources

License

Licensed under the MIT license.

Copyright (c) 2016, 2017 Martin Krause github@mkrause.info http://martinkr.github.io)

Keywords

FAQs

Last updated on 06 Oct 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc