@badeball/cypress-cucumber-preprocessor

cypress-cucumber-preprocessor

Quick start • Documentation • Contributing

This preprocessor aims to provide a developer experience and behavior similar to that of Cucumber, to Cypress.

:information_source: The repository has recently moved from github.com/TheBrainFamily to github.com/badeball. Read more about the transfer of ownership here.

Installation

$ npm install @badeball/cypress-cucumber-preprocessor

Introduction

The preprocessor (with its dependencies) parses Gherkin documents and allows you to write tests as shown below.

# cypress/e2e/duckduckgo.feature
Feature: duckduckgo.com
  Scenario: visiting the frontpage
    When I visit duckduckgo.com
    Then I should see a search bar

// cypress/e2e/duckduckgo.ts
import { When, Then } from "@badeball/cypress-cucumber-preprocessor";

When("I visit duckduckgo.com", () => {
  cy.visit("https://www.duckduckgo.com");
});

Then("I should see a search bar", () => {
  cy.get("input").should(
    "have.attr",
    "placeholder",
    "Search the web without being tracked"
  );
});

Building

Building can be done once using:

$ npm run build

Or upon file changes with:

$ npm run watch

There are multiple types of tests, all ran using npm scripts:

$ npm run test:fmt
$ npm run test:types
$ npm run test:unit
$ npm run test:integration # make sure to build first
$ npm run test # runs all of the above

Attribution

A special thanks goes out to Łukasz Gandecki for developing and maintaining the cypress-cucumber integration before me, in addition to all other contributors. Some of the work has partially been sponsored by Klaveness Digital.

Changelog

v23.1.0

• Bumb engine requirement to Node v20.

  • This was accidentally left out during release of v23.0.0, where dropped support for v18 was announced. Due to the announcement, I don't consider this to be another breaking change.

• Expand type signature of scenario and step hooks, to allow tags to be defined using pure string arguments. This is in line with how cucumber-js behaves.

• Add support for attachments with filenames. This is in line with how cucumber-js behaves.

• Implement log, as seen in cucumber-js.

• Implement link, as seen in cucumber-js.

• Minor changes to the messages report, to ensure compatibility with cucumber-js.

Similar packages

Other packages similar to @badeball/cypress-cucumber-preprocessor

cypress-cucumber-preprocessor

cypress-cucumber-preprocessor is another plugin for integrating Cucumber with Cypress. It provides similar functionality to @badeball/cypress-cucumber-preprocessor, allowing you to write Gherkin syntax for your tests. However, @badeball/cypress-cucumber-preprocessor is a fork of this package and may have additional features or improvements.

jest-cucumber

jest-cucumber is a package that allows you to use Cucumber with Jest, a popular JavaScript testing framework. While it provides similar Gherkin syntax support, it is designed for unit and integration testing rather than end-to-end testing like Cypress.