WebStorm 9.0.0 Web Help

In this dialog box, create configurations for running and debugging JavaScript unit tests using the Cucumber.js test runner.

On this page:

Getting Access to the Run/Debug Configuration: Cucumber.js Dialog Box

  1. Make sure the Node.js plugin is enabled. The plugin is bundled with WebStorm and activated by default. If not, enable it as described in Enabling and Disabling Plugins.
  2. Download and install the NodeJS framework that contains the Node Package Manager(npm).
  3. Using the Node Package Manager, install the Cucumber.js as described in Preparing to Use Cucumber.Js Test Runner.
  4. Make sure the Cucumber.js and Gherkin plugins are enabled. The plugins are bundled with WebStorm and activated by default. If not, enable them as described in Enabling and Disabling Plugins.

Cucumber.js-Specific Configuration Settings

Item Description
Feature file or directory In this text box, specify the tests to run. Cucumber.js runs tests that are called features and are written in the Gherkin language. Each feature is described in a separate file with the extension feature.
  • To have one feature executed, specify the path to the corresponding .feature file.
  • To have a bunch of features executed, specify the folder where the .feature files to run are stored.
Type the path manually or click the Browse button browseButton.png and choose the file or folder in the dialog box that opens.
Cucumber.js arguments In this text box, specify the command line arguments to be passed to the Cucumber.js executable file, such as -r (--require LIBRARY|DIR), -t (--tags TAG_EXPRESSION), or --coffee. For details, see Cucumber's native built-in help available through the following command:
cucumber-js --help
                
Executable path In this text box, specify the location of the cucumber executable file, .cmd, .bat, or other depending on the operating system used. The location depends on the installation mode, see Installing the Cucumber.js test runner.

Type the path manually or click the Browse button browseButton.png and choose the file in the dialog box that opens.

Toolbar

Item Shortcut Description
add Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertCtrl+N or Alt+InsertAlt+InsertAlt+InsertCommand N or Control EnterControl N or Control EnterCommand N or Control Enter Click this button to add a new configuration to the list.
delete Alt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteCommand DeleteCommand DeleteCommand Delete Click this button to remove the selected configuration from the list.
copy Ctrl+DCtrl+DCtrl+DCtrl+DMeta+DCtrl+DCtrl+D, Ctrl+Shift+Down or Ctrl+Shift+UpCtrl+DCommand DCommand DCommand D Click this button to create a copy of the selected configuration.
settings Edit defaults Click this button to edit the default configuration templates. The defaults are used for newly created configurations.
arrowUp or arrowDown Alt+UpAlt+UpAlt+UpAlt+UpAlt+Up or Ctrl+Alt+AAlt+UpCtrl+Alt+UpCtrl+Shift+UpControl UpControl UpControl Alt Up or Alt+DownAlt+DownAlt+DownAlt+DownAlt+Down or Ctrl+Alt+EAlt+DownCtrl+Alt+DownCtrl+Shift+DownControl DownControl DownControl Alt Down Use these buttons to move the selected configuration or folder up and down in the list.

The order of configurations or folders in the list defines the order in which configurations appear in the Run/Debug drop-down list on the main toolbar.

folder Move into new folder / Create new folder Use this button to create a new folder.

If one or more run/debug configurations are in focus, the selected run/debug configurations are automatically moved to the newly created folder. If only a category is in focus, an empty folder is created.

Move run/debug configurations to a folder using drag-and-drop, or the arrowUp arrowDown buttons.

sortAlphabetically Sort configurations Click this button to sort configurations in alphabetical order.

Common Options

Item Description
Name In this text box, specify the name of the current run/debug configuration. This field does not appear for the default run/debug configurations.
Defaults This node in the left-hand pane of the dialog box contains the default run/debug configuration settings. Select the desired configuration to change its default settings in the right-hand pane. The defaults are applied to all newly created run/debug configurations.
Share Select this check box to make the run/debug configuration available to other team members.

The shared run/debug configurations are kept in separate xml files under .idea\runConfigurations folder, while the local run/debug configurations are kept in the .idea\workspace.xml.

This check box is not available when editing the run/debug configuration defaults.

Single instance only If this check box is selected, this run/debug configuration cannot be launched more than once.

Every time a new run/debug configuration is launched, WebStorm checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog box. If you click OK in the confirmation dialog box, the first instance of the runner will be stopped, and the next one will take its place.

This make sense, when usage of certain resources can cause conflicts, or when launching two run/debug configurations of the same type consumes too much of the CPU and memory resources.

If this check box is not selected, it is possible to launch as many instances of the runner as required. So doing, each runner will start in its own tab of the Run tool window.

Before launch Specify which tasks must be performed before applying the run/debug configuration. The specified tasks are performed in the order they appear in the list.
Item Keyboard shortcut Description
add Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+Insert or Ctrl+NAlt+InsertCommand N or Control EnterControl N or Control EnterCommand N or Control Enter Click this icon to add a task to the list. Select the task to be added:
  • Run External tool. Select this option to run an application which is external to WebStorm. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in WebStorm yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
  • Run Another Configuration. Select this option to have another run/debug configuration executed. In the dialog that opens, select the configuration to be run.
  • Generate CoffeeScript Source Maps. Select this option to have the source maps for your CoffeeScript sources generated. In the dialog that opens, specify where your CoffeeScript source files are located. For more information, see CoffeeScript Support.
delete Alt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteCommand DeleteCommand DeleteCommand Delete Click this icon to remove the selected task from the list.
edit1 EnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
arrowUp Alt+UpAlt+UpAlt+UpAlt+UpAlt+Up or Ctrl+Alt+AAlt+UpCtrl+Alt+UpCtrl+Shift+UpControl UpControl UpControl Alt Up Click this icon to move the selected task one line up in the list.
arrowDown Alt+DownAlt+DownAlt+DownAlt+DownAlt+Down or Ctrl+Alt+EAlt+DownCtrl+Alt+DownCtrl+Shift+DownControl DownControl DownControl Alt Down Click this icon to move the selected task one line down in the list.
Show this page Select this check box to have the run/debug configuration settings shown prior to actually starting the run/debug configuration.

See Also

Procedures:

External Links:

Web Resources: