reg-suit

reg-suit

Tool for visual regression testing.

• Easy to setup
• Easy to integrate your CI flow
• Easy to extend

Getting Started

$ npm install -g reg-suit
$ cd path-to-your-project
$ reg-suit init
# Answer a few questions...

$ reg-suit run

CLI Usage

reg-suit [options] <command>

run command

Run visual testing, publish the current snapshot images, and send notifications.

init command

Install and configure reg-suit and plugins into your project.

• --use-yarn : By the default cli installs packages using npm. If you prefer yarn pkg, turn this option on.

prepare command

Configure the installed plugin(s). It's useful to configure reg-suit and plugins.

• --plugin : Specify plugin name(s) to be configured.

Global options

T.B.D

If you want more details, please exec reg-suit -h or reg-suit <command> -h.

How it works

reg-suit calls installed plugins according to the following procedure:

• Determine the key of snapshot which will be used as the expected images via installed key-generator plugin. This step will be skipped if key-generator plugin is not set.
• Fetch the previous snapshot images as the expected snapshot via installed publisher plugin. This step will be skipped if publisher plugin is not set.
• Compare images using reg-cli and create report.
• Determine the key of the current snapshot via installed key-generator plugin. If key-Generator is not set, time stamp is used.
• Publish the current snapshot and report via installed publisher-plugin. This step will be skipped if publisher plugin is not set.
• Notify result via installed notifier-plugin.

License

The MIT License (MIT)

Copyright 2017 Quramy

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.