Skip to content

ateliee/img-report

Repository files navigation

Image Report

Build Status Coverage Status npm version Codacy Badge License: MIT

Extract image differences between directories and output HTML reports

Demo

Try Now!

Usage

for Development

Install

npm install ateliee/img-report --save-dev

Howto

diff image directory reporting

img-report diff ./assets ./dist
# clear ./dist and reporting
img-report diff ./assets ./dist -f
# and reporting html
img-report diff ./assets ./dist -r
# config setting
img-report diff ./assets ./dist -c config.json

config parameters examples(see Resemble.js)

{
  "Resemble": {
    "errorColor": {
      "red": 0,
      "green": 255,
      "blue": 0,
      "alpha": 255
    },
    // flat|movement|flatDifferenceIntensity|movementDifferenceIntensity|diffOnly
    "errorType": "movement",
    "transparency": 0.2,
    "largeImageThreshold": 1200,
    "useCrossOrigin": false,
    "outputDiff": true
  }
}

Output Image Dir Report

img-report build -s ./assets/ -d ./dist/

create current directory .img-report

report dev server start

img-report serve -s ./assets/ -d ./dist/

For Development

pre-commit lint and unit testing.

lint

npm run-script lint
npm run-script lint:fix

unit test

npm test

Exmaple Images

About

CLIでディレクトリ間での画像差分を比較抽出し、HTML形式でレポート表示します。

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published