Google Git
Sign in
gerrit / plugins / image-diff / refs/heads/master
commit810cf5cfe8037c5d59d7f86c9192e72fa7c29e73[log] [tgz]
authorAntoine Musso <hashar@free.fr>Fri Jul 07 16:55:06 2023 +0200
committerAntoine Musso <hashar@free.fr>Fri Jul 07 17:08:40 2023 +0200
treea6c23866b52861de9bf66c85dbafc355e79b300a
parent49cc3330fea7355a840a3db89518c2f57af477f7 [diff]
Improve README.md build instructions and more

I got a little confused as to setup the symlink since that is the first
time I encounter a polygerrit plugin. I went to remove some ambiguity
and give the full command to symlink the plugin package.json into the
Gerrit tree.

Additionally:
* stop refering to Resemble.JS version number in the README.md since
  it did not get bumped the last few times the library got upgraded.
* Remove Jack Zheng Github URL since it nowadays yields a 404.

Change-Id: Ifb18747a74308e5c69eafd46cecf7a1e52367b67
1 file changed
tree: a6c23866b52861de9bf66c85dbafc355e79b300a
  1. assets/
  2. gr-image-diff-tool/
  3. gr-opacity-diff-mode/
  4. gr-resemble-diff-mode/
  5. test/
  6. external_package.json ⇨ package.json
  7. .eslintrc.json
  8. .gitignore
  9. bower.json
  10. BUILD
  11. LICENSE
  12. package-lock.json
  13. package.json
  14. plugin.js
  15. README.md
  16. rollup.config.js
  17. 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

The build requires to be done from an existing Gerrit tree. All commands below are relative to the root of a copy of Gerrit.

  1. Clone the image-diff repository into the plugins folder of the gerrit repo, or link the image-diff plugin folder to gerrit/plugins folder.
  2. Override Gerrit plugins/package.json with the plugin package.json:
ln --symbolic --force image-diff/package.json plugins/package.json

You can remove all depDependencies from plugins/package.json as they are not needed for the build (they are only needed for running wct tests).

  1. run bazel build plugins/image-diff

Highlight Mode

Highlight example

This mode uses the Resemble.JS library.

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

  • Jack Zheng
  • Raeggin Williams
  • Kasper Nilsson