An enhanced image diff plugin for PolyGerrit.

Clone this repo:

Branches

  1. 32c182d Reword/slightly rename options by Kasper Nilsson · 12 days ago master
  2. 0e5697d Update README.md by Jack Zheng · 2 weeks ago
  3. c006cb7 Add margin to wrapper to keep style consistency between modes by Jack Zheng · 2 weeks ago
  4. 75c36ac Fix inconsistent height and width in opacity mode by Kasper Nilsson · 2 weeks ago
  5. baabc34 Change resemble errorType to flat by Jack Zheng · 2 weeks ago

Image Diff

A plugin that provides a rich image diffing experience in PolyGerrit. Currently, the plugin features two modes: Highlight Mode and Onion Skin.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Yarn - Node package manager

Installing

Use Homebrew to install yarn on macOS:

brew install yarn

Reference here for instruction on how to install on other systems.

Clone the repo and run

yarn install

to install the dependencies.

Highlight Mode

Highlight example

This mode uses the Resemble.JS (1.2.1) library in its development The following features are included in this mode:

  • Percentage of difference between the images
  • Ability to ignore color in the comparison
  • Ability to make the diff color more discernible
  • Change the diff color
  • View the diff in full screen

Onion Skin

Opacity example

Onion Skin mode is a great way for users to notice changes in the images that might be overlooked when you look at them side by side. By overlaying the new image on top of the old image, the users can change the opacity to see the transition that were made.

The following features are included in this mode:

  • Scale the new image to the same size as the old image
  • Changing the opacity of the top image

Testing

This plugin uses polymer-cli to test.

Inside your image-diff repo, run polymer serve to start a local web server and open localhost:8080/test to view your tests. See here for more info.

Development

Reference here on how to set up your Gerrit testsite and here for PolyGerrit plugin development.

Authors