Merge pull request #98 from ShellyDCMS/move-cypress-to-peer-dep

move cypress to peer deps

README.md

@@ -7,6 +7,19 @@ Making TDD fun in the modular UI area.
 
 CypressHelper makes it saner to write UI testing. It enables creating component drivers that will work on all testing levels (component, integration, e2e).
 
+## Installation
+
+This library provides an API to interact with UI elements - `CypressHelper` that combines the common features.
+To add it to your repo use
+
+`npm i -D @shellygo/cypress-test-utils cypress`
+
+or
+
+`yarn add -D @shellygo/cypress-test-utils cypress`
+
+## Concept
+
 Cypress Helpers can help you develop tests faster
 CypressHelper is designed to be used in any test level, and holds common methods used in Cypress tests
 ![image](https://github.com/ShellyDCMS/cypress-test-utils/assets/60476837/d9aa07d8-2c05-4968-970a-be8445a113c3)
@@ -56,19 +69,6 @@ You may change this behaviour by overriding the default values when creating Cyp
 
 When mounting an angular component, autoSpyOutputs is set to true, meaning all event emitters are automatically spied on and may be accessed during a test using `helper.get.spy("<EventEmitterName>")`
 
-###
-
-## Usage
-
-This library provides an API to interact with UI elements - `CypressHelper` that combines the common features.
-To add it to your repo use
-
-`npm i -D @shellygo/cypress-test-utils`
-
-or
-
-`yarn add -D @shellygo/cypress-test-utils`
-
 ## Developing
 
 1. Set up the repo - `yarn`

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shellygo/cypress-test-utils",
   "description": "Cypress Test Automation Utilities",
-  "version": "2.1.7",
+  "version": "2.1.8",
   "author": "Shelly Goldblit",
   "private": false,
   "license": "MIT",
@@ -30,11 +30,13 @@
     "generate-md-docs": "typedoc --includeVersion --plugin typedoc-plugin-markdown --plugin typedoc-plugin-merge-modules --options typedoc.md.json",
     "generate-docs": "typedoc --includeVersion --plugin typedoc-plugin-merge-modules --options typedoc.html.json"
   },
+  "peerDependencies": {
+    "cypress": ">=12.17.3"
+  },
   "dependencies": {
     "@cypress/mount-utils": "^4.0.0",
     "@types/chai-subset": "^1.3.3",
     "chai-subset": "^1.6.0",
-    "cypress": "12.17.3",
     "cypress-pipe": "^2.0.0",
     "cypress-real-events": "^1.7.6",
     "cypress-wait-if-happens": "^1.3.3",
@@ -48,6 +50,7 @@
     "@types/react": "^18.2.7",
     "cpx": "^1.5.0",
     "cross-var": "^1.1.0",
+    "cypress": "^12.17.3",
     "gh-pages": "^5.0.0",
     "lit": "^2.7.4",
     "mochawesome": "^7.1.3",