j/snapshot
1
0
Fork 0
mirror of https://github.com/datashard/snapshot.git synced 2024-11-24 14:52:28 +00:00
Code Issues Projects Releases Packages Wiki Activity

start rewriting readme

Browse source
This commit is contained in:
Joshua 2023-02-20 19:21:40 +01:00
parent af82f108ad
commit 7f629969d5
1 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,4 +1,4 @@
# @cypress/snapshot # @datashard/snapshot
> Adds value / object / DOM element snapshot testing support to Cypress test runner > Adds value / object / DOM element snapshot testing support to Cypress test runner
@ -30,6 +30,7 @@ After installing, add the following to your `cypress/support/commands.js` file
```js ```js
require("@cypress/snapshot").register(); require("@cypress/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
and add the following to your `cypress.config.js` and add the following to your `cypress.config.js`
@ -43,7 +44,6 @@ and add the following to your `cypress.config.js`
**Note:** `@cypress/snapshot` **requires** the `readFileMaybe` plugin to be included, which can be easily done using the code above **Note:** `@cypress/snapshot` **requires** the `readFileMaybe` plugin to be included, which can be easily done using the code above
# Usage # Usage
Currently, if you want to take more than one snapshot, you need to pass a Step Name to prevent overwrites / test failures Currently, if you want to take more than one snapshot, you need to pass a Step Name to prevent overwrites / test failures
@ -83,10 +83,10 @@ You can control snapshot comparison and behavior through a few options.
cy.get(...).snapshot({ cy.get(...).snapshot({
snapshotName: 'Snapshot Name', // to use as a File Name snapshotName: 'Snapshot Name', // to use as a File Name
snapshotPath: 'cypress/not_snapshots', // where to save the Snapshot snapshotPath: 'cypress/not_snapshots', // where to save the Snapshot
json: false // convert DOM elements into JSON json: false // convert DOM elements into JSON
}) // when storing in the snapshot file }) // when storing in the snapshot file
// will save as // will save as
// cypress/not_snapshots/Snapshot-Name.json // cypress/not_snapshots/Snapshot-Name.json
``` ```
@ -94,7 +94,7 @@ You can also pass a "Step Name" to the Function
```js ```js
cy.get(...).snapshot("Intercepted API Request") cy.get(...).snapshot("Intercepted API Request")
// will save as // will save as
// cypress/snapshots/<context>-<describe>-<it>-Intercepted-API-Request.json // cypress/snapshots/<context>-<describe>-<it>-Intercepted-API-Request.json
// to prevent duplications // to prevent duplications
``` ```
@ -104,10 +104,10 @@ or both
```js ```js
cy.get(...).snapshot("Intercepted API Request", { cy.get(...).snapshot("Intercepted API Request", {
snapshotPath: "cypress/snapshots/api", snapshotPath: "cypress/snapshots/api",
snapshotName: "first_intercept" snapshotName: "first_intercept"
}) })
// will save as // will save as
// cypress/snapshots/api/first_intercept.json // cypress/snapshots/api/first_intercept.json
``` ```
@ -116,17 +116,18 @@ cy.get(...).snapshot("Intercepted API Request", {
This module provides some configuration options: This module provides some configuration options:
#### snapshotPath #### snapshotPath
Sets the default Path for saving Snapshots (default: `cypress/snapshots`) Sets the default Path for saving Snapshots (default: `cypress/snapshots`)
## Debugging ## Debugging
To debug this module run with environment variable `DEBUG=@cypress/snapshot` 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 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
<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.