https://github.com/paazmaya/hideo
Visual regression testing reporter
https://github.com/paazmaya/hideo
reporting test-report visual-regression-testing
Last synced: 2 months ago
JSON representation
Visual regression testing reporter
- Host: GitHub
- URL: https://github.com/paazmaya/hideo
- Owner: paazmaya
- License: mit
- Created: 2019-05-09T21:08:46.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-04T22:22:57.000Z (3 months ago)
- Last Synced: 2025-04-04T23:23:44.824Z (3 months ago)
- Topics: reporting, test-report, visual-regression-testing
- Language: JavaScript
- Size: 604 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Hideo (秀雄)
> Visual regression testing reporter
[](https://paazmaya.semaphoreci.com/projects/hideo)
This project is
generates an report, one or more web pages, from directories of screen captures and a possible meta data, such as generated by `shigehachi`
## Background for the project name
The name of the project is for honouring the legacy of Mrs Sonobe Hideo (園部 秀雄),
who was the 15th head master of
[Jikishinkageryu Naginatajutsu (直心影流薙刀術)](https://naginata.fi/en/koryu),
which is an ancient Japanese martial art, focusing the handling of a long pole like weapon
called naginata.
[Read more about why these martial arts are important for me at `karatejukka.fi`.](https://karatejukka.fi)
## Getting started
Please note that the minimum supported version of [Node.js](https://nodejs.org/en/) is `14.15.0`, which is [the active Long Term Support (LTS) version](https://github.com/nodejs/Release#release-schedule).
The metrics input is expected to look something similar to, such as provided by [shigehachi](https://www.npmjs.com/package/shigehachi) version 6 onwards:
```json
{
"5317107e6e45bc44da564197e8478702": {
"metric": "RootMeanSquaredError",
"normalized": {
"red": "0.0410206303",
"green": "0.2454052653",
"blue": "0.2478704718",
"opacity": "0.3134753265",
"total": "0.2353789431"
},
"absolute": {
"red": "2688.3",
"green": "16082.6",
"blue": "16244.2",
"opacity": "20543.6",
"total": "15425.6"
},
"A": "tests/fixtures/prev/postcss.png",
"B": "tests/fixtures/curr/postcss.png",
"diff": "tests/fixtures/output/postcss-rmse-tint.png"
}
}
```
The data collected by [`shigehachi`](https://www.npmjs.com/package/shigehachi) is basically gathering what GraphicsMagick tells when using its [`compare` utility](http://www.graphicsmagick.org/compare.html).
The resulting HTML site is build by using JavaScript [template strings](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals).
## Command line options
The output of `hideo --help` pretty much covers all the options:
```sh
```
## Contributing
["A Beginner's Guide to Open Source: The Best Advice for Making your First Contribution"](http://www.erikaheidi.com/blog/a-beginners-guide-to-open-source-the-best-advice-for-making-your-first-contribution/).
[Also there is a blog post about "45 Github Issues Dos and Don’ts"](https://davidwalsh.name/45-github-issues-dos-donts).
Linting is done with [ESLint](http://eslint.org) and can be executed with `npm run lint`.
There should be no errors appearing after any JavaScript file changes.
Unit tests are written with [`tape`](https://github.com/substack/tape) and can be executed with `npm test`.
Code coverage is inspected with [`nyc`](https://github.com/istanbuljs/nyc) and
can be executed with `npm run coverage` after running `npm test`.
Please make sure it is over 90% at all times.
## Version history
[Changes happening across different versions and upcoming changes are tracked in the `CHANGELOG.md` file.](CHANGELOG.md)
## License
Copyright (c) [Juga Paazmaya](https://paazmaya.fi)
Licensed under [the MIT license](./LICENSE).