cucumber-editor

Load your cucumber-js step definitions and write valid feature files. Also compatible with other projects based on cucumber (see nightwatch-cucumber).

Requirements

You need one or more step definition files in your project. Find out more about step definition files.

This is a very simple example of a step definition file.

// scripts/steps/steps.js

module.exports = function () {
    this.Given(/^I have already visited the site$/, function () {
        // do things...
    });
  
    this.Then(/^Then the response status is (.*)$/, function (status) {
        // do things...
    });

    this.When(/^I view my profile$/, function () {
        // do things...
    });
};

The regular expressions will be extracted and parsed so you can use them when creating new feature files.

Installation

Install this module globally

npm install -g cucumber-editor

Usage

cd project/root/folder
cucumber-editor

This will open the cucumber editor.

Configuration

In your project root folder you can add a json configuration file named .cucumbereditor. If you do not add this file, or if you don't provide all variables, these defaults will be used.

{
    "stepsFolder": "scripts/steps",
    "componentsFile": "scripts/libs/components.js"
}

stepsFolder

The folder where your step definition files are stored.

componentsFile (optional)

A file that exports a list of components, used for autocomplete when step definitions are parameterized. This file should export an object that contains a _components property.

// scripts/libs/components.js

module.exports{
    _components: [
        'component1',
        'component2',
        'component3',
        'component4'
    ]
}

Help needed!

If you have any improvements to make or if you have encountered any issues, please contribute or get in touch!

Local development

This project is setup to work with VS Code. For debugging, add the following into your settings.json in VS Code.

"cucumber.editor.debug.cwd": "C:\\Path\\To\\Nightwatch\\Project\\Folder"