sealights-cypress-plugin 2.0.18 → 2.0.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +23 -0
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -8,6 +8,29 @@ This plugin adds support for Sealights, reporting coverage and test skipping as
8
8
  - Node >= 12
9
9
  - Cypress >= 9
10
10
 
11
+ ## ⚠️ Usage with other plugins
12
+
13
+ If you're using the Sealights plugin with other plugins, please read the following **carefully!** <br>
14
+
15
+ This plugin will register multiple types of life-cycle event handlers.
16
+ However, only a single event handler can exist for each type of event (due to a limitation in Cypress).
17
+ Thus, if you attempt to define any of the same handlers,
18
+ your handler will either be overriden by this plugin or you will override this plugin's handler.
19
+ Either way, one of the plugins will stop functioning as expected.
20
+
21
+ There's an (multiple actually) open [issue](https://github.com/cypress-io/cypress/issues/22428) at Cypress tracking this limitation.
22
+
23
+ These are the events this plugin will subscribe to:
24
+
25
+ - before:run
26
+ - after:run
27
+
28
+ For example, if you specify a handler for `before:run` and override this plugin's handler,
29
+ then no test events will be sent to Sealights.
30
+
31
+ For a workaround and ability to use multiple plugins please refer to: [cypress-on-fix](https://github.com/bahmutov/cypress-on-fix),
32
+ or the original issue linked above.
33
+
11
34
  ## Features
12
35
 
13
36
  - **Support File:** The plugin introduces a support file, it is automatically loaded before each test, providing a centralized location to manage the Sealights information and execute the required hooks
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sealights-cypress-plugin",
3
- "version": "2.0.18",
3
+ "version": "2.0.23",
4
4
  "description": "Support and config files for Cypress to support Sealights integration.",
5
5
  "scripts": {
6
6
  "build": "tsc",
@@ -33,5 +33,5 @@
33
33
  "support.js"
34
34
  ],
35
35
  "main": "tsOutputs/index.js",
36
- "gitHead": "bf6c83664e2af721d5d1224a67dcfca412edf25b"
36
+ "gitHead": "9420ba107f08fe2c66c356111f59c43ad4b2cffd"
37
37
  }