puppeteer-screenshot-tester - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

package.json

 {
   "name": "puppeteer-screenshot-tester",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Small library that allows us to compare screenshots generated by puppeteer in our tests",
@@ -5,0 +5,0 @@ "main": "src/index.js",

README.md

@@ -77,3 +77,4 @@ puppeteer-screenshot-tester
 - `screenshotOptions` <[Object]> options passed to Puppeteer's screenshot method [See the Puppeteer documentation for more info](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagescreenshotoptions), _plus_ the following keys:
-  - `saveNewImageOnError`: <[boolean]> saves the undiffed new image on error as `${saveFolder}/${name}-diff${ext}`
+  - `saveNewImageOnError`: <[boolean]> saves the undiffed new image on error as `${saveFolder}/${name}-new${ext}`
+  - `overwriteImageOnChange`: <[boolean]> overwrites the reference image (`${saveFolder}/${name}${ext}`) on error / change 
 
@@ -137,7 +138,17 @@ #### Returns
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore -->
-| [<img src="https://avatars0.githubusercontent.com/u/3284639?v=4" width="100px;"/><br /><sub><b>Kemal Erdem</b></sub>](https://github.com/burnpiro)<br />[💻](https://github.com/burnpiro/puppeteer-screenshot-tester/commits?author=burnpiro "Code") [📖](https://github.com/burnpiro/puppeteer-screenshot-tester/commits?author=burnpiro "Documentation") [👀](#review-burnpiro "Reviewed Pull Requests") | [<img src="https://avatars0.githubusercontent.com/u/3769985?v=4" width="100px;"/><br /><sub><b>Max Harris</b></sub>](https://github.com/maxharris9)<br />[🐛](https://github.com/burnpiro/puppeteer-screenshot-tester/issues?q=author%3Amaxharris9 "Bug reports") [💻](https://github.com/burnpiro/puppeteer-screenshot-tester/commits?author=maxharris9 "Code") | [<img src="https://avatars2.githubusercontent.com/u/426677?v=4" width="100px;"/><br /><sub><b>Andi Smith</b></sub>](http://www.andismith.com)<br />[📖](https://github.com/burnpiro/puppeteer-screenshot-tester/commits?author=andismith "Documentation") [⚠️](https://github.com/burnpiro/puppeteer-screenshot-tester/commits?author=andismith "Tests") |
-| :---: | :---: | :---: |
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/burnpiro"><img src="https://avatars0.githubusercontent.com/u/3284639?v=4" width="100px;" alt=""/><br /><sub><b>Kemal Erdem</b></sub></a><br /><a href="https://github.com/burnpiro/puppeteer-screenshot-tester/commits?author=burnpiro" title="Code">💻</a> <a href="https://github.com/burnpiro/puppeteer-screenshot-tester/commits?author=burnpiro" title="Documentation">📖</a> <a href="https://github.com/burnpiro/puppeteer-screenshot-tester/pulls?q=is%3Apr+reviewed-by%3Aburnpiro" title="Reviewed Pull Requests">👀</a></td>
+    <td align="center"><a href="https://github.com/maxharris9"><img src="https://avatars0.githubusercontent.com/u/3769985?v=4" width="100px;" alt=""/><br /><sub><b>Max Harris</b></sub></a><br /><a href="https://github.com/burnpiro/puppeteer-screenshot-tester/issues?q=author%3Amaxharris9" title="Bug reports">🐛</a> <a href="https://github.com/burnpiro/puppeteer-screenshot-tester/commits?author=maxharris9" title="Code">💻</a></td>
+    <td align="center"><a href="http://www.andismith.com"><img src="https://avatars2.githubusercontent.com/u/426677?v=4" width="100px;" alt=""/><br /><sub><b>Andi Smith</b></sub></a><br /><a href="https://github.com/burnpiro/puppeteer-screenshot-tester/commits?author=andismith" title="Documentation">📖</a> <a href="https://github.com/burnpiro/puppeteer-screenshot-tester/commits?author=andismith" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://github.com/JacobJust"><img src="https://avatars2.githubusercontent.com/u/442674?v=4" width="100px;" alt=""/><br /><sub><b>JacobJust</b></sub></a><br /><a href="https://github.com/burnpiro/puppeteer-screenshot-tester/commits?author=JacobJust" title="Code">💻</a> <a href="https://github.com/burnpiro/puppeteer-screenshot-tester/commits?author=JacobJust" title="Documentation">📖</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!

src/index.js

@@ -73,4 +73,7 @@ const resemble = require('node-resemble-js');
                   fs.writeFileSync(`${saveFolder}/${name}-new${ext}`, screenShot);
+                } else if (screenshotOptions.overwriteImageOnChange) {
+                  fs.writeFileSync(`${saveFolder}/${name}${ext}`, screenShot);
                 }
 
+
                 resolve(false)
@@ -77,0 +80,0 @@ } else {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

142

increased by1.43%

Number of lines in readme file

152

increased by7.8%

Worsened metrics

Total package byte prevSize

16909

decreased by-96.43%

Number of package files

8

decreased by-27.27%

No dependency changes