Merge pull request #156 from S-H-GAMELINKS/support/cypress-v10or-later

Supports Cypress v10 or later

Author: searls

README.md

@@ -50,7 +50,7 @@ Once installed, you'll want to run:
 $ rake cypress:init
 ```
 
-This will override a few configurations in your `cypress.json` configuration
+This will override a few configurations in your `cypress.config.js` configuration
 file.
 
 ## Usage
@@ -161,7 +161,7 @@ preferred environment variables project-wide using a tool like
   the Rails test server on
 * **CYPRESS_RAILS_BASE_PATH** (default: `"/"`) the base path for all Cypress's
   requests to the app (e.g. via `cy.visit()`). If you've customized your
-  `baseUrl` setting (e.g. in `cypress.json`), you'll need to duplicate it with
+  `baseUrl` setting (e.g. in `cypress.config.js`), you'll need to duplicate it with
   this environment variable
 * **CYPRESS_RAILS_TRANSACTIONAL_SERVER** (default: `true`) when true, will start
   a transaction on all database connections before launching the server. In

example/cypress.config.js

@@ -0,0 +1,16 @@
+const { defineConfig } = require('cypress')
+
+module.exports = defineConfig({
+  // setupNodeEvents can be defined in either
+  // the e2e or component configuration
+  e2e: {
+    setupNodeEvents(on, config) {
+      on('before:browser:launch', (browser = {}, launchOptions) => {
+        /* ... */
+      })
+    },
+  },
+  screenshotsFolder: "tmp/cypress_screenshots",
+  videosFolder: "tmp/cypress_videos",
+  trashAssetsBeforeRuns: false
+})

example/cypress.json

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }

example/cypress/integration/compliments.js renamed to example/cypress/e2e/compliments_test.cy.js

@@ -1,5 +1,5 @@
 // ***********************************************************
-// This example support/index.js is processed and
+// This example support/e2e.ts is processed and
 // loaded automatically before your test files.
 //
 // This is a great place to put global configuration and
@@ -12,3 +12,9 @@
 // You can read more here:
 // https://on.cypress.io/configuration
 // ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands';
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

example/cypress/integration/external-service.js renamed to example/cypress/e2e/external-service.cy.js

@@ -11,7 +11,7 @@
   },
   "version": "0.1.0",
   "devDependencies": {
-    "cypress": "9.6.1",
+    "cypress": "^12.13.0",
     "webpack-dev-server": "^3.8.0"
   }
 }