j/snapshot
1
0
Fork 0
mirror of https://github.com/datashard/snapshot.git synced 2024-11-22 06:02:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md to provide information on changes between @datashard/snapshot and @cypress/snapshot, add authors section and update license section

Browse source
This commit is contained in:
Joshua 2023-02-20 20:13:24 +01:00
parent 7f629969d5
commit dbda85c6e1
1 changed files with 26 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
README.md
View file

@ -2,25 +2,23 @@
> Adds value / object / DOM element snapshot testing support to Cypress test runner > Adds value / object / DOM element snapshot testing support to Cypress test runner
[![NPM][npm-icon] ][npm-url] <details>
<summary>Changes between <code>@datashard/snapshot</code> and <code>@cypress/snapshot</code></summary>
<br>
They're mostly the same, as this is a fork of the Latter, though it's not a drop-in replacement.
[![Build status][ci-image] ][ci-url] Unlike `@cypress/snapshot`, this saves snapshots in their own files with a sensible default and strives to have ongoing Support for future Cypress Versions
[![semantic-release][semantic-image] ][semantic-url]
[![renovate-app badge][renovate-badge]][renovate-app]
> **Note** \ </details>
> \
> Please take a look at a few other Cypress snapshot plugins: <!-- [![NPM][npm-icon] ][npm-url] -->
>
> - [cypress-plugin-snapshots](https://github.com/meinaart/cypress-plugin-snapshots)
> - [cypress-image-snapshot](https://github.com/palmerhq/cypress-image-snapshot).
## Install ## Install
Requires [Node](https://nodejs.org/en/) version 10 or above. Requires [Node](https://nodejs.org/en/) version 10 or above.
```sh ```sh
npm install --save-dev @cypress/snapshot npm install --save-dev @datashard/snapshot
``` ```
## Import ## Import
@ -28,7 +26,7 @@ npm install --save-dev @cypress/snapshot
After installing, add the following to your `cypress/support/commands.js` file After installing, add the following to your `cypress/support/commands.js` file
```js ```js
require("@cypress/snapshot").register(); require("@datashard/snapshot").register();
``` ```
This registers a new command to create new snapshot or compare value to old snapshot This registers a new command to create new snapshot or compare value to old snapshot
@ -38,11 +36,13 @@ and add the following to your `cypress.config.js`
```js ```js
e2e: { e2e: {
setupNodeEvents(on, config) { setupNodeEvents(on, config) {
require("@cypress/snapshot").tasks(on, config) require("@datashard/snapshot").tasks(on, config)
}, },
``` ```
**Note:** `@cypress/snapshot` **requires** the `readFileMaybe` plugin to be included, which can be easily done using the code above > **Note** \
> \
> `@datashard/snapshot` **requires** the `readFileMaybe` plugin to be included, which can be easily done using the code above
# Usage # Usage
@ -119,24 +119,23 @@ This module provides some configuration options:
Sets the default Path for saving Snapshots (default: `cypress/snapshots`) Sets the default Path for saving Snapshots (default: `cypress/snapshots`)
## Debugging
To debug this module run with environment variable `DEBUG=@cypress/snapshot`
# #
### Small print ### Small print
Author: Gleb Bahmutov &lt;gleb@cypress.io&gt; &amp; Joshua D. &lt;[data@shard.wtf](mailto:data@shard.wtf)&gt; &copy; Cypress.io 2017-2022 Authors:
- Joshua &lt;[data@shard.wtf](mailto:data@shard.wtf)&gt;
- Gleb Bahmutov &lt;gleb@cypress.io&gt;
<br> <br>
License: MIT - do anything with the code, but don't blame us if it does not work. License: MIT - do anything with the code, but don't blame us if it does not work.
Support: If you find any problems with this module, email / tweet / Support: If you find any problems with this module [open an issue](https://github.com/cypress-io/snapshot/issues) on Github
[open issue](https://github.com/cypress-io/snapshot/issues) on Github
## MIT License ## MIT License
Copyright (c) 2017-2022 Cypress.io &lt;hello@cypress.io&gt; Copyright (c) 2017-2022 Cypress.io &lt;hello@cypress.io&gt; & Joshua &lt;data@shard.wtf&gt;
Permission is hereby granted, free of charge, to any person Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation obtaining a copy of this software and associated documentation
@ -159,11 +158,8 @@ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE. OTHER DEALINGS IN THE SOFTWARE.
[npm-icon]: https://nodei.co/npm/@cypress/snapshot.svg?downloads=true [npm-icon]: https://nodei.co/npm/@datashard/snapshot.svg?downloads=true
[npm-url]: https://npmjs.org/package/@cypress/snapshot [npm-url]: https://npmjs.org/package/@datashard/snapshot
[ci-image]: https://travis-ci.org/cypress-io/snapshot.svg?branch=master
[ci-url]: https://travis-ci.org/cypress-io/snapshot
[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-url]: https://github.com/semantic-release/semantic-release [semantic-url]: https://github.com/semantic-release/semantic-release
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg [renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/ [renovate-app]: https://renovateapp.com/