@jscutlery/cypress-harness 0.3.12 → 0.4.1

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.4.1](https://github.com/jscutlery/devkit/compare/cypress-harness-0.4.0...cypress-harness-0.4.1) (2022-12-01)
+
+
+
+# [0.4.0](https://github.com/jscutlery/devkit/compare/cypress-harness-0.3.12...cypress-harness-0.4.0) (2022-12-01)
+
+
+### Features
+
+* **cypress-harness:** ✨ provide getPreprocessorConfig util ([56d74c9](https://github.com/jscutlery/devkit/commit/56d74c954785b4cc30d4aac63d7e87015e4b858f))
+* **cypress-harness:** ✨add support for Cypress 10 & 11 ([4d29535](https://github.com/jscutlery/devkit/commit/4d2953594f280031d8df0e5f429f74171ad236bf))
+
+
+
 ## [0.3.12](https://github.com/jscutlery/devkit/compare/cypress-harness-0.3.11...cypress-harness-0.3.12) (2022-06-24)
 
 

package/README.md

@@ -24,14 +24,43 @@ yarn add -D @jscutlery/cypress-harness @angular/cdk cypress-pipe
 npm install -D @jscutlery/cypress-harness @angular/cdk cypress-pipe
 ```
 
-### 2. Import support commands
+### 2. Setup
 
-Update your e2e folder's `*-e2e/src/support/index.ts` and add:
+#### 2.a. Cypress E2E
+
+Update your e2e folder's `cypress/support/e2e.ts` and add:
 
 ```ts
 import '@jscutlery/cypress-harness/support';
 ```
 
+then update the `cypress.config.ts` file as follows:
+
+```ts
+import { defineConfig } from 'cypress';
+import { getPreprocessorConfig } from '@jscutlery/cypress-harness/preprocessor-config';
+
+export default defineConfig({
+  e2e: {
+    // ... other existing settings if any (like nxE2EPreset() if using Nx).
+    ...getPreprocessorConfig()
+  }
+});
+```
+
+This last part is needed to add support for [package exports conditionals](https://nodejs.org/api/packages.html#conditional-exports)
+and allow us to import harnesses from `@angular/cdk/testing` for example.
+
+#### 2.b. Cypress Component Testing
+
+If you are using Cypress Component Testing then there is a different import to add to the following file: `cypress/support/component.ts`:
+
+```ts
+import '@jscutlery/cypress-harness/support-ct';
+```
+
+_(the `getPreprocessorConfig()` is not required here as it is already set up by `cypress/angular`.)_
+
 ## Usage
 
 ```ts
@@ -42,6 +71,7 @@ describe('datepicker', () => {
   const calendars = getAllHarnesses(MatCalendarHarness);
 
   it('should set date', () => {
+    cy.visit('/'); // or cy.mount(MyComponent); for component testing.
     datepicker.setValue('1/1/2010');
     datepicker.openCalendar();
     datepicker.getCalendar().invoke('next'); // next method is already used

package/package.json

@@ -1,17 +1,40 @@
 {
   "name": "@jscutlery/cypress-harness",
-  "version": "0.3.12",
+  "version": "0.4.1",
   "repository": {
     "url": "https://github.com/jscutlery/devkit"
   },
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js",
+      "require": "./src/index.js"
+    },
+    "./preprocessor-config": {
+      "types": "./src/preprocessor-config.d.ts",
+      "default": "./src/preprocessor-config.js"
+    },
+    "./support": {
+      "types": "./src/support.d.ts",
+      "default": "./src/support.js"
+    },
+    "./support-ct": {
+      "types": "./src/support-ct.d.ts",
+      "default": "./src/support-ct.js"
+    }
+  },
+  "dependencies": {
+    "@cypress/webpack-batteries-included-preprocessor": "^2.2.4",
+    "@cypress/webpack-preprocessor": "^5.0.0",
+    "webpack": "^5.0.0"
+  },
   "peerDependencies": {
     "@angular/cdk": "*",
     "cypress": "*",
     "cypress-pipe": "*",
-    "zone.js": "^0.11.4",
+    "zone.js": "*",
     "tslib": "2.4.0"
   },
   "main": "./src/index.js",
-  "typings": "./src/index.d.ts",
-  "dependencies": {}
+  "types": "./src/index.d.ts"
 }

package/src/preprocessor-config.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="cypress" />
+export declare function getPreprocessorConfig(): Pick<Cypress.Config, 'setupNodeEvents'>;

package/src/preprocessor-config.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPreprocessorConfig = void 0;
+const tslib_1 = require("tslib");
+const webpack_batteries_included_preprocessor_1 = tslib_1.__importDefault(require("@cypress/webpack-batteries-included-preprocessor"));
+function getPreprocessorConfig() {
+    return {
+        setupNodeEvents(on) {
+            /**
+             * We need this setup in e2e tests to fix "package exports conditionals"
+             * support.
+             * In fact, without this, importing @angular/cdk/testing (used by harnesses)
+             * will simply fail with a "Module not found" error.
+             */
+            on('file:preprocessor', (0, webpack_batteries_included_preprocessor_1.default)({
+                typescript: require.resolve('typescript')
+            }));
+        }
+    };
+}
+exports.getPreprocessorConfig = getPreprocessorConfig;
+//# sourceMappingURL=preprocessor-config.js.map

package/src/preprocessor-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"preprocessor-config.js","sourceRoot":"","sources":["../../../../packages/cypress-harness/src/preprocessor-config.ts"],"names":[],"mappings":";;;;AAAA,uIAAmF;AAGnF,SAAgB,qBAAqB;IACnC,OAAO;QACL,eAAe,CAAC,EAAE;YAChB;;;;;eAKG;YACH,EAAE,CAAC,mBAAmB,EAAE,IAAA,iDAAmB,EAAC;gBAC1C,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC;aAC1C,CAAC,CAAC,CAAC;QACN,CAAC;KACF,CAAC;AACJ,CAAC;AAdD,sDAcC"}

package/src/support-ct.d.ts

@@ -0,0 +1 @@
+import 'cypress-pipe';

package/src/support-ct.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("cypress-pipe");
+//# sourceMappingURL=support-ct.js.map

package/src/support-ct.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"support-ct.js","sourceRoot":"","sources":["../../../../packages/cypress-harness/src/support-ct.ts"],"names":[],"mappings":";;AAAA,wBAAsB"}

package/src/support.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"support.js","sourceRoot":"","sources":["../../../../packages/cypress-harness/src/support.ts"],"names":[],"mappings":";;AAAA,wBAAsB;AAEtB;;;;;GAKG;AACH,6BAA2B;AAE3B,mEAAmE;AACnE,8DAA8D;AAC7D,UAAkB,CAAC,OAAO,CAAC,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC;AAEvD,qCAAmC"}

package/support.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"support.js","sourceRoot":"","sources":["../../../packages/cypress-harness/support.ts"],"names":[],"mappings":";;AAAA,wBAAsB;AAEtB;;;;;GAKG;AACH,6BAA2B;AAC3B,mEAAmE;AACnE,8DAA8D;AAC7D,UAAkB,CAAC,OAAO,CAAC,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC;AACvD,qCAAmC"}