Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reg-viz/reg-cli
📷 Visual regression test tool.
https://github.com/reg-viz/reg-cli
reg-suit visual-recognition visual-regression-testing visual-tests
Last synced: about 1 month ago
JSON representation
📷 Visual regression test tool.
- Host: GitHub
- URL: https://github.com/reg-viz/reg-cli
- Owner: reg-viz
- License: mit
- Created: 2016-12-04T08:06:30.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T01:27:11.000Z (8 months ago)
- Last Synced: 2024-05-01T23:02:13.247Z (7 months ago)
- Topics: reg-suit, visual-recognition, visual-regression-testing, visual-tests
- Language: JavaScript
- Homepage: https://reg-viz.github.io/reg-cli/
- Size: 11.9 MB
- Stars: 332
- Watchers: 5
- Forks: 24
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-regression-testing - reg-cli - Visual regression test tool which output easy-to-read single file html report. (Tools and frameworks)
README
](https://travis-ci.org/reg-viz/reg-cli.svg?branch=master)
](https://ci.appveyor.com/api/projects/status/ir907qbc633q9na4?svg=true)
](https://img.shields.io/npm/v/reg-cli.svg)
](https://img.shields.io/npm/dm/reg-cli.svg)
> Visual regression test tool with html reporter.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Test](#test)
- [Contribute](#contribute)
- [License](#license)
## Installation
### Requirements
- Node.js v18+
`reg-cli` support Node.js v18+
``` sh
$ npm i -D reg-cli
```
## Usage
### CLI
``` sh
$ 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. Specifically, you can set how much of a difference in the YIQ difference metric should be considered a different pixel. If there is a difference between pixels, it will be treated as "same pixel" if it is within this threshold.
* `-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`. 0 by default.
* `-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`. 0 by default.
* `-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/
### from json
If `-F` option set, only report will be output without comparing images.
``` sh
reg-cli.js -F ./sample/reg.json -R ./sample/index.html"
```
- json format
``` json
{
"failedItems": ["sample.png"],
"newItems":[],
"deletedItems":[],
"passedItems":[],
"expectedItems":["sample.png"],
"actualItems":["sample.png"],
"diffItems":["sample.png"],
"actualDir":"./actual",
"expectedDir":"./expected",
"diffDir":"./diff"
}
```
## Test
```sh
$ 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.
