Move image-diff to polymer 3

Change-Id: If36dc5c0b4ae95841360e5f8ce20f8b049015be2
23 files changed
tree: 3bf122c69d9aa4b3922869c16069e88891df4717
  1. .eslintrc.json
  2. .gitignore
  3. BUILD
  4. LICENSE
  5. README.md
  6. assets/
  7. bower.json
  8. gr-image-diff-tool/
  9. gr-opacity-diff-mode/
  10. gr-resemble-diff-mode/
  11. package-lock.json
  12. package.json
  13. plugin.js
  14. rollup.config.js
  15. test/
  16. yarn.lock
README.md

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.

Build

  1. Clone the package into plugins folder of gerrit repo or link the plugin folder to gerrit/plugins folder
  2. Override plugins/package.json with package.json, you can remove all depDependencies as they are not needed for the build (needed for running wct tests)
  3. Run bazel build plugins/image-diff

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.

Or run npm run wct-test to run all your tests.

Development

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

Authors