{"id":15809210,"url":"https://github.com/zordius/visual-reporter","last_synced_at":"2026-02-01T18:31:44.003Z","repository":{"id":35044792,"uuid":"199766060","full_name":"zordius/visual-reporter","owner":"zordius","description":"Generate Visual Changes Report","archived":false,"fork":false,"pushed_at":"2022-12-09T20:40:31.000Z","size":11210,"stargazers_count":4,"open_issues_count":11,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-27T12:08:41.175Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zordius.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-31T02:52:06.000Z","updated_at":"2022-02-20T13:07:00.000Z","dependencies_parsed_at":"2023-01-15T12:45:39.980Z","dependency_job_id":null,"html_url":"https://github.com/zordius/visual-reporter","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/zordius/visual-reporter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zordius%2Fvisual-reporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zordius%2Fvisual-reporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zordius%2Fvisual-reporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zordius%2Fvisual-reporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zordius","download_url":"https://codeload.github.com/zordius/visual-reporter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zordius%2Fvisual-reporter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28985818,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-01T18:17:03.387Z","status":"ssl_error","status_checked_at":"2026-02-01T18:16:57.287Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-05T03:20:32.707Z","updated_at":"2026-02-01T18:31:43.972Z","avatar_url":"https://github.com/zordius.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"visual-reporter\n===============\n\n[![Build Status](https://travis-ci.org/zordius/visual-reporter.svg?branch=master)](https://travis-ci.org/zordius/visual-reporter) \u003ca href=\"https://www.npmjs.com/package/visual-reporter\"\u003e\u003cimg src=\"https://badge.fury.io/js/visual-reporter.svg\" /\u003e\u003c/a\u003e [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)\n\nGenerate Visual Changes Report, here is a life DEMO:\n\n\u003ca href=\"https://zordius.github.io/visual-reporter/\"\u003e\u003cimg src=\"example1.jpg\" /\u003e\u003c/a\u003e\n\nFeatures:\n * One command line tool to generate visual report as static HTML.\n * View visual difference as overlap changes or different images.\n * Options to customize the report.\n * Grouping images by seperator in file names.\n\n\u003ca href=\"https://zordius.github.io/visual-reporter/\"\u003e\u003cimg src=\"diff.gif\" /\u003e\u003c/a\u003e\n\nUsage\n-----\n\n```\n$ npm install visual-reporter -g\n$ visual-reporter --help\n\nUsage: visual-reporter [options] [command]\n\nOptions:\n  -V, --version               output the version number\n  -b --baseline \u003cdir\u003e         baseline directory, default is \".\"\n  -c --compare \u003cdir\u003e          compare directory, default is \"./compare\"\n  -r --report \u003cdir\u003e           report directory, default is \"./report\"\n  -s --seperator \u003cmatch\u003e      group seperator, default is \".\"\n  -w --writeInfo              generate a brief infomation file \"info.txt\", default is false\n  -k --keepUnchanged          keep unchanged diff image, default is false\n  -g --groups \u003cg1,g2,g3,...\u003e  group names, default is \"groups\"\n  -m --customStyle \u003ccss\u003e      add custom css into report\n  -t --threshold \u003c0...1\u003e      matching threshold, default is 0.1\n  -i --includeAA              do not detecting anti-aliased pixels, default is false\n  -a --alpha \u003c0...1\u003e          alpha of unchanged pixels, default is 0.1\n  -h, --help                  output usage information\n\nCommands:\n  generate|gen                Generate visual report\n```\n\nUsecases\n--------\n\n* Put your old visual files into a directory as `baseline`.\n* Run your visual automation testing.\n* New generated visual files are placed in another directory as `compare`.\n* Generate your visual report:\n```\n$ visual-reporter gen --baseline path/to/baseline --compare path/to/compare\n```\n\n* When you named your image files as [browser]_[testCase].png, you can enable grouping by:\n```\nfiles:\nchrome_login.png\nchrome_logout.png\niphone_login.png\niphone_logout.png\n\n$ visual-reporter gen --baseline baseline --compare compare --seperator '_' --groups browser,testcase\n```\n\n* By default, the image description is the file name. You can customize the image description in the report by placing *.txt files besides the *.png files:\n```\nimages:\nchrome_login.png\nchrome_logout.png\niphone_login.png\niphone_logout.png\n\ndescriptions:\nchrome_login.txt\niphone_login.txt\n```\n\n* If you want to customize style for your description, you can use this:\n```\n$ visual-reporter gen --baseline baseline --compare compare --customStyle \".card-content { ...}\"\n```\n\n* The image comparison is done by \u003ca href=\"https://github.com/mapbox/pixelmatch\"\u003epixelmatch\u003c/a\u003e, you can pass more options to it.\n```\n$ visual-reporter gen --baseline foo --compare bar --seperator --alpha 0.3 --threshold 0.3 --includeAA\n```\n\nError Codes\n-----------\n\nThe error code will be sum of detected change types:\n\n| Change Type                  | Exit Code |\n|------------------------------|-----------|\n| No any chnages are detected  | 0         |\n| new image files are detected | 1         |\n| old image files are missing  | 2         |\n| image size is changed        | 4         |\n| image content is changed     | 8         |\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzordius%2Fvisual-reporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzordius%2Fvisual-reporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzordius%2Fvisual-reporter/lists"}