Custom reporter (#103)

- Making Differencify compatible with differencify-jest-reporter
- Save the captured image from the current test run to test the report path by default

Author: NimaSoroush

.gitignore

@@ -33,4 +33,6 @@ dist/
 docs/
 .vscode/
 differencify_reports/
+__differencified_output__/
+__current_output__/
 trace.json

.npmignore

@@ -1,5 +1,4 @@
 src/
-examples/
 .circleci/
 .vscode/
 .idea/

CHANGELOG.md

@@ -1,17 +1,22 @@
-## [1.4.3] - 2018-7-21
+## [1.5.0] - 2018-08-30
+### Added
+- Making Differencify compatible with differencify-jest-reporter
+- Save the captured image from current test run to test report path by default
+
+## [1.4.3] - 2018-07-21
 ### Updated
 - Integrating greenkeeper
 - Updating several packages
 
-## [1.4.2] - 2018-7-13
+## [1.4.2] - 2018-07-13
 ### Fixed
 - Fixing issue with freezeImage command
 
-## [1.4.1] - 2018-6-22
+## [1.4.1] - 2018-06-22
 ### Added
 - A prepare script to keep the artifact uptodated
 
-## [1.4.0] - 2018-6-21
+## [1.4.0] - 2018-06-21
 ### Changed
 - `toMatchScreenshot` updated to accept a callback parameter which is passed
   details of the comparison (See [API.md](/NimaSoroush/differencify/blob/master/API.md#detailed-result-information)
@@ -20,17 +25,17 @@
 ### Added
 - NPM script `test:integration` to streamline running integration tests in Docker
 
-## [1.3.4] - 2018-6-9
+## [1.3.4] - 2018-06-09
 ### Fixed
 - Export module Differencify
 - Make Differencify running with vanilla node
 - Fix screenshot path issue for non jest
 
-## [1.3.3] - 2018-6-6
+## [1.3.3] - 2018-06-06
 ### Fixed
 - Bug fixed for custom test path
 
-## [1.3.1] - 2018-5-25
+## [1.3.1] - 2018-05-25
 ### Fixed
 - Bug fixed for testName not being picked up correctly
 

README.md

@@ -111,6 +111,44 @@ As you can see, you don't need to return `result` as `toMatchSnapshot` will auto
 
 Same way as Jest [snapshots testing](http://facebook.github.io/jest/docs/en/snapshot-testing.html), to update the snapshots, run jest with `--updateSnapshot` or `-u` argument.
 
+## Jest reporter
+
+You can generate an index document of the saved images by using the differencify jest reporter.
+
+```bash
+$ npm i -D differencify-jest-reporter
+```
+
+Enable the reporter in your jest config:
+
+```
+module.exports = {
+  reporters: [
+    'default', // keep the default reporter
+    [
+      'differencify-jest-reporter',
+      {
+        debug: true,
+        reportPath: 'differencify_reports', // relative to root of project
+        reportTypes: {
+          html: 'index.html',
+          json: 'index.json',
+        },
+      },
+    ],
+  ],
+};
+```
+
+Alternatively, enable the reporter with the cli:
+
+```
+jest --reporters default differencify-jest-reporter
+```
+
+### Jest reporter output
+<p align="center"><img alt="differencify-report" src="images/differencify-report.png" width="500"></p>
+
 ## Usage with other test frameworks
 If you are using other test frameworks you can still validate your tests. Differencify will return `true` or `false` by the end of execution. This could be used to assert on. look at the [example](https://github.com/NimaSoroush/differencify#validate-your-changes)
 
@@ -159,7 +197,8 @@ See [API.md](API.md) for full list of API calls
 |---------|----|--------|-----------|-------|
 |`debug`|`boolean`|no|Enables console output|false|
 |`imageSnapshotPath`|`string`|no|Stores reference screenshots in this directory|./differencify_reports|
-|`saveDifferencifiedImage`|`boolean`|no|Save differencified image to testReportPath in case of mismatch|true|
+|`saveDifferencifiedImage`|`boolean`|no|Save differencified image to test report path in case of mismatch|true|
+|`saveCurrentImage`|`boolean`|no|Save the captured image from current test run to test report path|true|
 |`mismatchThreshold`|`integer`|no|Difference tolerance between reference/test image|0.001|
 
 ## TestOptions