Nimoy Prospers Mystically

    @cucumber/cucumber
    TypeScript icon, indicating that this package has built-in type declarations

    8.10.0 • Public • Published


    Cucumber

    Automated tests in plain language, for Node.js

    #StandWithUkraine npm build coverage backers sponsors pull requests issues

    Cucumber is a tool for running automated tests written in plain language. Because they're written in plain language, they can be read by anyone on your team. Because they can be read by anyone, you can use them to help improve communication, collaboration and trust on your team.

    This is the JavaScript implementation of Cucumber. It runs on maintained versions of Node.js. You can quickly try it via CodeSandbox, or read on to get started locally in a couple of minutes.

    Looking to contribute? Read our code of conduct first, then check the contributing guide to get up and running.

    Install

    Cucumber is available on npm:

    $ npm install @cucumber/cucumber

    Get Started

    Let's take this example of something to test:

    First, write your main code in src/index.js:

    class Greeter {
      sayHello() {
        return 'hello'
      }
    }
    
    module.exports = {
      Greeter
    }

    Then, write your feature in features/greeting.feature:

    Feature: Greeting
    
      Scenario: Say hello
        When the greeter says hello
        Then I should have heard "hello"

    Next, implement your steps in features/support/steps.js:

    const assert = require('assert')
    const { When, Then } = require('@cucumber/cucumber')
    const { Greeter } = require('../../src')
    
    When('the greeter says hello', function () {
      this.whatIHeard = new Greeter().sayHello()
    });
    
    Then('I should have heard {string}', function (expectedResponse) {
      assert.equal(this.whatIHeard, expectedResponse)
    });

    Finally, run Cucumber:

    $ npx cucumber-js

    And see the output:

    Terminal output showing a successful test run with 1 scenario and 2 steps, all passing

    If you learn best by example, we have a repo with several example projects, that might help you get going.

    Documentation

    The following documentation is for main, which might contain some unreleased features. See documentation for older versions if you need it.

    Support

    Support is available from the community if you need it.

    Install

    npm i @cucumber/cucumber

    DownloadsWeekly Downloads

    414,720

    Version

    8.10.0

    License

    MIT

    Unpacked Size

    802 kB

    Total Files

    342

    Last publish

    Collaborators

    • aslakhellesoy
    • cukebot