rsmbl/Resemble.js

Feature request: separate colors for errors in image 1 and 2

Open

#198 opened on Apr 19, 2020

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (4,364 stars) (433 forks)batch import
Feature requestGood first issue

Description

I'm using resemble via the wdio-image-comparison-service. It works great, but I would love to be able to specify that the erroneous pixels present in image 1 (my baseline) are green (expected) while the errors from image 2 (the comparison) are red. Hopefully that makes sense. Basically I want it to display like a git diff.

Contributor guide

Tech stack
javascript
Domain
testing
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with JavaScriptBasic understanding of image comparison libraries
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Examine the Resemble.js source code, particularly the output rendering logic in 'resemble.js'. Look for where error pixels are colored, likely in the `compareImages` or `createImageData` functions. The feature request is to add an option for users to specify separate colors for baseline and comparison errors (like a git diff). Check if any existing PRs or forks address this. Since there are no linked issues or PRs, the implementation would involve modifying the output color mapping to accept two color strings instead of one, and applying them to the respective image differences.