Add support for Cypress v10

Co-authored-by: Anthony Champagne <[email protected]>

Author: badeball

README.md

@@ -18,15 +18,15 @@ $ npm install @badeball/cypress-cucumber-preprocessor
 The preprocessor (with its dependencies) parses Gherkin documents and allows you to write tests as shown below.
 
 ```cucumber
-# cypress/integration/duckduckgo.feature
+# cypress/e2e/duckduckgo.feature
 Feature: duckduckgo.com
   Scenario: visting the frontpage
     When I visit duckduckgo.com
     Then I should see a search bar
 ```
 
 ```ts
-// cypress/integration/duckduckgo.ts
+// cypress/e2e/duckduckgo.ts
 import { When, Then } from "@badeball/cypress-cucumber-preprocessor";
 
 When("I visit duckduckgo.com", () => {

docs/configuration.md

@@ -43,7 +43,7 @@ Every configuration option has a similar key which can be use to override it, sh
 
 | JSON path          | Environment key   | Example(s)                               |
 |--------------------|-------------------|------------------------------------------|
-| `stepDefinitions`  | `stepDefinitions` | `cypress/integration/[filepath].{js,ts}` |
+| `stepDefinitions`  | `stepDefinitions` | `[filepath].{js,ts}` |
 | `messages.enabled` | `messagesEnabled` | `true`, `false`                          |
 | `messages.output`  | `messagesOutput`  | `cucumber-messages.ndjson`               |
 | `json.enabled`     | `jsonEnabled`     | `true`, `false`                          |

docs/quick-start.md

@@ -6,12 +6,16 @@ $ npm install @badeball/cypress-cucumber-preprocessor
 
 # Configuration
 
-[Configure](https://docs.cypress.io/guides/references/configuration) `testFiles` with `"**/*.feature"`, using EG. `cypress.json`.
+[Configure](https://docs.cypress.io/guides/references/configuration) `specPattern` with `"**/*.feature"`, using EG. `cypress.config.ts`.
 
-```json
-{
-  "testFiles": "**/*.feature"
-}
+```js
+import { defineConfig } from "cypress";
+
+export default defineConfig({
+  e2e: {
+    specPattern: "**/*.feature"
+  }
+});
 ```
 
 Configure your preferred bundler to process features files, with examples for
@@ -24,18 +28,18 @@ Read more about configuration options at [docs/configuration.md](configuration.m
 
 # Write a test
 
-Write Gherkin documents anywhere in your configured integration folder (defaults to `cypress/integration`) and add a file for type definitions with a corresponding name (read more about how step definitions are resolved in [docs/step-definitions.md](step-definitions.md)). Reading [docs/cucumber-basics.md](cucumber-basics.md) is highly recommended.
+Write Gherkin documents and add a file for type definitions with a corresponding name (read more about how step definitions are resolved in [docs/step-definitions.md](step-definitions.md)). Reading [docs/cucumber-basics.md](cucumber-basics.md) is highly recommended.
 
 ```cucumber
-# cypress/integration/duckduckgo.feature
+# cypress/e2e/duckduckgo.feature
 Feature: duckduckgo.com
   Scenario: visting the frontpage
     When I visit duckduckgo.com
     Then I should see a search bar
 ```
 
 ```ts
-// cypress/integration/duckduckgo.ts
+// cypress/e2e/duckduckgo.ts
 import { When, Then } from "@badeball/cypress-cucumber-preprocessor";
 
 When("I visit duckduckgo.com", () => {

docs/state-management.md

@@ -23,7 +23,7 @@ Please note that if you use arrow functions, you won’t be able to share state
 Even though `setWorldConstructor` isn't implemented, it's behavior can be closely replicated like shown below.
 
 ```gherkin
-# cypress/integration/math.feature
+# cypress/e2e/math.feature
 Feature: Replicating setWorldConstructor()
   Scenario: easy maths
     Given a variable set to 1
@@ -32,7 +32,7 @@ Feature: Replicating setWorldConstructor()
 ```
 
 ```ts
-// cypress/support/index.ts
+// cypress/support/e2e.ts
 beforeEach(function () {
   const world = {
     variable: 0,

docs/step-definitions.md

@@ -5,17 +5,17 @@ Step definitions are resolved using search paths that are configurable through t
 ```json
 {
   "stepDefinitions": [
-    "cypress/integration/[filepath]/**/*.{js,ts}",
-    "cypress/integration/[filepath].{js,ts}",
+    "[filepath]/**/*.{js,ts}",
+    "[filepath].{js,ts}",
     "cypress/support/step_definitions/**/*.{js,ts}",
   ]
 }
 ```
 
-This means that if you have a file `cypress/integration/duckduckgo.feature`, it will match step definitions found in
+This means that if you have a file `cypress/e2e/duckduckgo.feature`, it will match step definitions found in
 
-* `cypress/integration/duckduckgo/steps.ts`
-* `cypress/integration/duckduckgo.ts`
+* `cypress/e2e/duckduckgo/steps.ts`
+* `cypress/e2e/duckduckgo.ts`
 * `cypress/support/step_definitions/duckduckgo.ts`
 
 ## Hierarchy
@@ -25,14 +25,14 @@ There's also a `[filepart]` option available. Given a configuration shown below
 ```json
 {
   "stepDefinitions": [
-    "cypress/integration/[filepart]/step_definitions/**/*.{js,ts}"
+    "[filepart]/step_definitions/**/*.{js,ts}"
   ]
 }
 ```
 
-... and a feature file `cypress/integration/foo/bar/baz.feature`, the preprocessor would look for step definitions in
+... and a feature file `cypress/e2e/foo/bar/baz.feature`, the preprocessor would look for step definitions in
 
-* `cypress/integration/foo/bar/baz/step_definitions/**/*.{js,ts}`
-* `cypress/integration/foo/bar/step_definitions/**/*.{js,ts}`
-* `cypress/integration/foo/step_definitions/**/*.{js,ts}`
-* `cypress/integration/step_definitions/**/*.{js,ts}`
+* `cypress/e2e/foo/bar/baz/step_definitions/**/*.{js,ts}`
+* `cypress/e2e/foo/bar/step_definitions/**/*.{js,ts}`
+* `cypress/e2e/foo/step_definitions/**/*.{js,ts}`
+* `cypress/e2e/step_definitions/**/*.{js,ts}`

…ples/browserify/cypress/plugins/index.ts examples/browserify/cypress.config.tsexamples/browserify/cypress/plugins/index.ts renamed to examples/browserify/cypress.config.ts examples/browserify/cypress/plugins/index.ts renamed to examples/browserify/cypress.config.ts

@@ -1,11 +1,12 @@
+import { defineConfig } from "cypress";
 import * as browserify from "@cypress/browserify-preprocessor";
 import { addCucumberPreprocessorPlugin } from "@badeball/cypress-cucumber-preprocessor";
 import { preprocessor } from "@badeball/cypress-cucumber-preprocessor/browserify";
 
-export default async (
+export async function setupNodeEvents(
   on: Cypress.PluginEvents,
   config: Cypress.PluginConfigOptions
-): Promise<Cypress.PluginConfigOptions> => {
+): Promise<Cypress.PluginConfigOptions> {
   await addCucumberPreprocessorPlugin(on, config);
 
   on(
@@ -18,4 +19,12 @@ export default async (
 
   // Make sure to return the config object as it might have been modified by the plugin.
   return config;
-};
+}
+
+export default defineConfig({
+  e2e: {
+    specPattern: "**/*.feature",
+    supportFile: false,
+    setupNodeEvents,
+  },
+});

examples/browserify/cypress.json

@@ -1,11 +1,12 @@
-import * as createBundler from "@bahmutov/cypress-esbuild-preprocessor";
+import { defineConfig } from "cypress";
+import createBundler from "@bahmutov/cypress-esbuild-preprocessor";
 import { addCucumberPreprocessorPlugin } from "@badeball/cypress-cucumber-preprocessor";
 import { createEsbuildPlugin } from "@badeball/cypress-cucumber-preprocessor/esbuild";
 
-export default async (
+export async function setupNodeEvents(
   on: Cypress.PluginEvents,
   config: Cypress.PluginConfigOptions
-): Promise<Cypress.PluginConfigOptions> => {
+): Promise<Cypress.PluginConfigOptions> {
   await addCucumberPreprocessorPlugin(on, config);
 
   on(
@@ -17,4 +18,12 @@ export default async (
 
   // Make sure to return the config object as it might have been modified by the plugin.
   return config;
-};
+}
+
+export default defineConfig({
+  e2e: {
+    specPattern: "**/*.feature",
+    supportFile: false,
+    setupNodeEvents,
+  },
+});