Supports Cypress v10 or later

Author: S-H-GAMELINKS

Diff for: 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

Diff for: 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
+})

Diff for: 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>
+//     }
+//   }
+// }

Diff for: 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')

Diff for: 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"
   }
 }

Diff for: example/cypress/integration/static-html.js renamed to example/cypress/e2e/static-html.cy.js

@@ -2225,10 +2225,10 @@ commander@^2.20.0:
   resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33"
   integrity sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==
 
-commander@^5.1.0:
-  version "5.1.0"
-  resolved "https://registry.yarnpkg.com/commander/-/commander-5.1.0.tgz#46abbd1652f8e059bddaef99bbdcb2ad9cf179ae"
-  integrity sha512-P0CysNDQ7rtVw4QIQtm+MRxV66vKFSvlsQvGYXZWR3qFU0jlMKHZZZgw8e+8DSah4UDKMqnknRDQz+xuQXQ/Zg==
+commander@^6.2.1:
+  version "6.2.1"
+  resolved "https://registry.yarnpkg.com/commander/-/commander-6.2.1.tgz#0792eb682dfbc325999bb2b84fddddba110ac73c"
+  integrity sha512-U7VdrJFnJgo4xjrHpTzu0yrHPGImdsmD95ZlgYSEajAn2JKzDhDTPG9kBTefmObL2w/ngeZnilk+OV9CG3d7UA==
 
 common-tags@^1.8.0:
   version "1.8.2"
@@ -2654,10 +2654,10 @@ cyclist@^1.0.1:
   resolved "https://registry.yarnpkg.com/cyclist/-/cyclist-1.0.1.tgz#596e9698fd0c80e12038c2b82d6eb1b35b6224d9"
   integrity sha1-WW6WmP0MgOEgOMK4LW6xs1tiJNk=
 
-cypress@9.6.1:
-  version "9.6.1"
-  resolved "https://registry.yarnpkg.com/cypress/-/cypress-9.6.1.tgz#a7d6b5a53325b3dc4960181f5800a5ade0f085eb"
-  integrity sha512-ECzmV7pJSkk+NuAhEw6C3D+RIRATkSb2VAHXDY6qGZbca/F9mv5pPsj2LO6Ty6oIFVBTrwCyL9agl28MtJMe2g==
+cypress@^12.13.0:
+  version "12.13.0"
+  resolved "https://registry.yarnpkg.com/cypress/-/cypress-12.13.0.tgz#725b6617ea19e41e5c59cc509fc3e08097142b01"
+  integrity sha512-QJlSmdPk+53Zhy69woJMySZQJoWfEWun3X5OOenGsXjRPVfByVTHorxNehbzhZrEzH9RDUDqVcck0ahtlS+N/Q==
   dependencies:
     "@cypress/request" "^2.88.10"
     "@cypress/xvfb" "^1.2.4"
@@ -2673,12 +2673,12 @@ [email protected]:
     check-more-types "^2.24.0"
     cli-cursor "^3.1.0"
     cli-table3 "~0.6.1"
-    commander "^5.1.0"
+    commander "^6.2.1"
     common-tags "^1.8.0"
     dayjs "^1.10.4"
-    debug "^4.3.2"
+    debug "^4.3.4"
     enquirer "^2.3.6"
-    eventemitter2 "^6.4.3"
+    eventemitter2 "6.4.7"
     execa "4.1.0"
     executable "^4.1.1"
     extract-zip "2.0.1"
@@ -2691,7 +2691,7 @@ [email protected]:
     listr2 "^3.8.3"
     lodash "^4.17.21"
     log-symbols "^4.0.0"
-    minimist "^1.2.6"
+    minimist "^1.2.8"
     ospath "^1.2.2"
     pretty-bytes "^5.6.0"
     proxy-from-env "1.0.0"
@@ -2728,7 +2728,7 @@ debug@^3.1.0, debug@^3.1.1, debug@^3.2.7:
   dependencies:
     ms "^2.1.1"
 
-debug@^4.1.0, debug@^4.1.1, debug@^4.3.2:
+debug@^4.1.0, debug@^4.1.1, debug@^4.3.4:
   version "4.3.4"
   resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.4.tgz#1319f6579357f2338d3337d2cdd4914bb5dcc865"
   integrity sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==
@@ -3124,10 +3124,10 @@ etag@~1.8.1:
   resolved "https://registry.yarnpkg.com/etag/-/etag-1.8.1.tgz#41ae2eeb65efa62268aebfea83ac7d79299b0887"
   integrity sha1-Qa4u62XvpiJorr/qg6x9eSmbCIc=
 
-eventemitter2@^6.4.3:
-  version "6.4.5"
-  resolved "https://registry.yarnpkg.com/eventemitter2/-/eventemitter2-6.4.5.tgz#97380f758ae24ac15df8353e0cc27f8b95644655"
-  integrity sha512-bXE7Dyc1i6oQElDG0jMRZJrRAn9QR2xyyFGmBdZleNmyQX0FqGYmhZIrIrpPfm/w//LTo4tVQGOGQcGCb5q9uw==
+[email protected].7:
+  version "6.4.7"
+  resolved "https://registry.yarnpkg.com/eventemitter2/-/eventemitter2-6.4.7.tgz#a7f6c4d7abf28a14c1ef3442f21cb306a054271d"
+  integrity sha512-tYUSVOGeQPKt/eC1ABfhHy5Xd96N3oIijJvN3O9+TsC28T5V9yX9oEfEK5faP0EFSNVOG97qtAS68GBrQB2hDg==
 
 eventemitter3@^4.0.0:
   version "4.0.7"
@@ -4898,6 +4898,11 @@ minimist@^1.1.0, minimist@^1.2.0, minimist@^1.2.5, minimist@^1.2.6:
   resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.6.tgz#8637a5b759ea0d6e98702cfb3a9283323c93af44"
   integrity sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==
 
+minimist@^1.2.8:
+  version "1.2.8"
+  resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.8.tgz#c1a464e7693302e082a075cee0c057741ac4772c"
+  integrity sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==
+
 minipass-collect@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/minipass-collect/-/minipass-collect-1.0.2.tgz#22b813bf745dc6edba2576b940022ad6edc8c617"

Diff for: example/cypress/plugins/index.js

@@ -1,30 +1,44 @@
 module CypressRails
   class Init
-    DEFAULT_CONFIG = {
-      "screenshotsFolder" => "tmp/cypress_screenshots",
-      "videosFolder" => "tmp/cypress_videos",
-      "trashAssetsBeforeRuns" => false
-    }
+    DEFAULT_CONFIG = <<~CYPRESS_CONFIG
+    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
+    })
+
+    CYPRESS_CONFIG
 
     def call(dir = Dir.pwd)
-      config_path = File.join(dir, "cypress.json")
-      json = JSON.pretty_generate(determine_new_config(config_path))
-      File.write(config_path, json)
+      config_path = File.join(dir, "cypress.config.js")
+      config_content = determine_new_config(config_path)
+      File.write(config_path, config_content)
       puts "Cypress config (re)initialized in #{config_path}"
     end
 
     private
 
     def determine_new_config(config_path)
       if File.exist?(config_path)
-        merge_existing_with_defaults(config_path)
+        merge_existing_with_defaults(config_path) 
       else
         DEFAULT_CONFIG
       end
     end
 
-    def merge_existing_with_defaults(json_path)
-      JSON.parse(File.read(json_path)).merge(DEFAULT_CONFIG).sort.to_h
+    def merge_existing_with_defaults(config_path)
+      File.read(config_path)
     end
   end
 end

Diff for: example/cypress/support/commands.js

@@ -1,7 +1,7 @@
 require "pathname"
 CLI = Pathname.new(File.dirname(__FILE__)).join("../../exe/cypress-rails")
 
-desc "Initialize cypress.json"
+desc "Initialize cypress.config.js"
 task :"cypress:init" do
   system "#{CLI} init"
 end