\n\nThis preprocessor aims to provide a developer experience and behavior similar to that of [Cucumber](https://cucumber.io/), to Cypress.\n\n> :information_source: The repository has recently moved from `github.com/TheBrainFamily` to `github.com/badeball`. Read more about the transfer of ownership [here](https://github.com/badeball/cypress-cucumber-preprocessor/issues/689).\n\n## Installation\n\n```\n$ npm install @badeball/cypress-cucumber-preprocessor\n```\n\n## Introduction\n\nThe preprocessor (with its dependencies) parses Gherkin documents and allows you to write tests as shown below.\n\n```cucumber\n# cypress/e2e/duckduckgo.feature\nFeature: duckduckgo.com\n Scenario: visiting the frontpage\n When I visit duckduckgo.com\n Then I should see a search bar\n```\n\n```ts\n// cypress/e2e/duckduckgo.ts\nimport { When, Then } from \"@badeball/cypress-cucumber-preprocessor\";\n\nWhen(\"I visit duckduckgo.com\", () => {\n cy.visit(\"https://www.duckduckgo.com\");\n});\n\nThen(\"I should see a search bar\", () => {\n cy.get(\"input[type=text]\")\n .should(\"have.attr\", \"placeholder\")\n .and(\n \"match\",\n /Search without being tracked|Search privately/,\n );\n});\n```\n\n## Building\n\nBuilding can be done once using:\n\n```\n$ npm run build\n```\n\nOr upon file changes with:\n\n```\n$ npm run watch\n```\n\nThere are multiple types of tests, all ran using npm scripts:\n\n```\n$ npm run test:fmt\n$ npm run test:types\n$ npm run test:unit\n$ npm run test:integration # make sure to build first\n$ npm run test # runs all of the above\n```\n\n## Attribution & sponsors\n\nA special thanks goes out to [Łukasz Gandecki](https://github.com/lgandecki) for developing and maintaining the cypress-cucumber integration before me, in addition to [all other contributors](https://github.com/badeball/cypress-cucumber-preprocessor/graphs/contributors). Some of the work has partially been sponsored by [Klaveness Digital](https://www.klavenessdigital.com/). This project is currently sponsored by [TestMu AI](https://www.testmuai.com/?utm_medium=sponsor&utm_source=cypress-cucumber-preprocessor).\n\n \n \n\n
![](\"docs/testmu-logo.svg\"){kind=logo}
\n