Run/Debug Configuration: NodeUnit
Create:
This page describes the configuration-specific items as well as options that are common for all run/debug configurations. To learn how to use this configuration, see Testing Node.js.
In this dialog, create configurations to run unit tests for Node.js applications.
Before you start
Make sure you have Node.js on your computer.
Make sure the JavaScript and TypeScript and Node.js required plugins are enabled on the Settings | Plugins page, tab Installed, see Managing plugins for details.
Install the Nodeunit testing framework in one of the following ways:
Download the framework at https://github.com/caolan/nodeunit and install it according to the official instructions.
Install the
nodeunit
package using the Node Package Manager (NPM) as described in npm, pnpm, and Yarn.
NodeUnit-specific configuration settings
Item | Description |
---|---|
Node interpreter | In this field, specify the Node.js interpreter to use. If you choose the Project alias, WebStorm will automatically use the project default interpreter from the Node interpreter field on the Node.js page . In most cases, WebStorm detects the project default interpreter and fills in the field itself. You can also choose another configured local or remote interpreter or click and configure a new one. See Configuring remote Node.js interpreters, Configuring a local Node.js interpreter, and Using Node.js on Windows Subsystem for Linux for details. |
Working Directory | In this field, specify the folder to find tests under. This can be the project root folder or the parent directory for the test folder. Type the path manually or click Browse and select the location in the dialog, that opens. |
Environment Variables | In this field, specify the environment variables for the Node.js executable file, if applicable. Click Browse to the right of the field and configure a list of variables in the Environment Variables dialog, that opens:
The definitions of variables are displayed in the Environment variables read-only field with semicolons as separators, for example:
|
Nodeunit Module | In this text box, specify the installation folder of the Nodeunit framework. Type the path manually or click and choose the folder in the dialog box that opens. |
Run | From this drop-down list, choose the scope of tests to execute. The available options are:
|
Common settings
When you edit a run configuration (but not a run configuration template), you can specify the following options:
Item | Description |
---|---|
Name | Specify a name for the run configuration to quickly identify it among others when editing or running. |
Allow multiple instances | Allow running multiple instances of this run configuration in parallel. By default, it is disabled, and when you start this configuration while another instance is still running, WebStorm suggests stopping the running instance and starting another one. This is helpful when a run configuration consumes a lot of resources and there is no good reason to run multiple instances. |
Store as project file | Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project. By default, it is disabled, and WebStorm stores run configuration settings in .idea/workspace.xml. |
Toolbar
The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.
Item | Shortcut | Description |
---|---|---|
Alt+Insert | Create a run/debug configuration. | |
Alt+Delete | Delete the selected run/debug configuration. Note that you cannot delete default configurations. | |
Ctrl+D | Create a copy of the selected run/debug configuration. Note that you create copies of default configurations. | |
The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent. | ||
Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders. To create a folder, select the configurations within a category, click , and specify the folder name. If only a category is in focus, an empty folder is created. Then, to move a configuration into a folder, between the folders or out of a folder, use drag or and buttons. To remove grouping, select a folder and click . | ||
Click this button to sort configurations in the alphabetical order. |
Before launch
In this area, you can specify tasks to be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.
Item | Shortcut | Description |
---|---|---|
Alt+Insert | Click this icon to add one of the following available tasks:
| |
Alt+Delete | Click this icon to remove the selected task from the list. | |
Enter | Click this icon to edit the selected task. Make the necessary changes in the dialog that opens. | |
/ | Alt+Up/Alt+Down | Click these icons to move the selected task one line up or down in the list. The tasks are performed in the order that they appear in the list. |
Show this page | Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration. | |
Activate tool window | By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration. Otherwise, if the checkbox is cleared, the tool window is hidden. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5. |