Run/Debug Configuration: Jest

Configuration file

In this field, optionally specify the jest.config.js or jest.config.ts file to use: select the relevant file from the list, or click and select it in the dialog that opens, or just type the path in the field.

If the field is empty, WebStorm looks for a package.json file with a jest key. The search is performed in the file system upwards from the working directory. If no appropriate package.json file is found, then a Jest default configuration is generated on the fly.

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.

For more information, refer to Configuring remote Node.js interpreters, Configuring a local Node.js interpreter, and Using Node.js on Windows Subsystem for Linux.

Node options

In this field, type the Node.js-specific command-line options to be passed to the Node.js executable file. The acceptable options are:

• Use --require coffeescript/register to have CoffeeScript files compiled into JavaScript on the fly during run.

  This mode requires that the register.js file, which is a part of the coffeescript package, is located inside your project. Therefore make sure you have the coffeescript package installed locally as described in Install the CoffeeScript compiler.

• Use --inspect or --inspect-brk parameter when you are using Node.js v7 for Chrome Debugging Protocol support. Otherwise, by default the debug process will use V8 Debugging Protocol.

• If you are using ECMAScript Modules in your project, WebStorm detects them and adds the —experimental-vm-modules flag to the Node options field automatically.

Jest package

In this field, specify the location of the jest, react-scripts, react-script-ts, react-super-scripts, or react-awesome-scripts package.

Working directory

In this field, specify the working directory of the application. By default, the Working directory field shows the project root folder. To change this predefined setting, specify the path to the desired folder.

Jest options

In this field, type the Jest CLI options to be passed to Jest. For example, add a --watch flag to turn on the autotest-like runner. As a result, any test in the current run configuration restarts automatically on changing the related source code, without clicking the Rerun button .

Environment variables

In this field, optionally specify the environment variables for executing commands. WebStorm will show these variables in completion lists for process.env.

Tests

In this area, specify the tests to be executed. The available options are:

• All tests: choose this option to run all the tests from the jest.config.js or jest.config.ts configuration file or from the generated Jest default configuration. With the default configuration, tests are recognized by the default value of the testRegex property.

• Test file: choose this option to run only the tests from one file and specify the path to this file in the Test file field.

• Suite: choose this option to run individual suites from a test file and specify the path to this file in the Test file field. Click in the Suite name field and configure a list of suites to run using the and buttons.

• Test: choose this option to run individual tests from a test file and specify the path to this file in the Test file field. Click in the Test name field and configure a list of tests to run using the and buttons.

Docker container settings

This read-only field shows port and volume bindings. Click to open the command preview.

warning

This field only appears when a Docker-based remote interpreter is selected.

Docker Compose

In this area, specify the commands and options to be passed to Docker Compose. Accept the default settings or click and specify custom ones, for example, custom Docker Compose flags, like --rm or --service-ports. Learn more from the Docker official website.

Check the Command Preview.

warning

This field only appears when a remote interpreter via Docker Compose is selected.

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.

AltInsert

Create a run/debug configuration.

AltDelete

Delete the selected run/debug configuration. Note that you cannot delete default configurations.

Ctrl0D

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.

AltInsert

Click this icon to add one of the following available tasks:

• Launch Web Browser: select this option to have a browser started. In the dialog that opens, select the type of the browser and provide the start URL. Also, specify if you want the browser be launched with JavaScript debugger.

• Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in WebStorm yet, add its definition. For more information, refer to External tools and External Tools.

• Run Another Configuration: select to execute another run/debug configuration and wait until it finishes before starting the current configuration. If you want to run several configurations in parallel, use a compound run/debug configuration.

• Run File Watchers: select this option to have WebStorm apply all the currently active File Watchers.

• Run Remote External tool: adds a remote SSH external tool.

• Run Grunt task: select this option to run a Grunt task.

  In the Grunt task dialog that opens, specify the Gruntfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool.

  Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the grunt-cli package.

• Run Gulp task: select this option to run a Gulp task.

  In the Gulp task dialog that opens, specify the Gulpfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool.

  Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the gulp package.

• Run npm Script: select this option to execute an npm script.

  In the NPM Script dialog that opens, specify the npm run/debug configuration settings.

• Compile TypeScript: select to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected:

  • If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start.

  • If the Check errors checkbox is cleared, the compiler will show all the detected errors but the run configuration still will be launched.

• Generate CoffeeScript Source Maps: select this option to generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located.

AltDelete

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.

Alt0↑

Alt0↓

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 Alt04 or Alt05.