Run/Debug Configuration: Jest
In this dialog box, create configurations for running Jest tests.
Jest-specific configuration settings
In this field, optionally specify the
jest.config file to use: choose the relevant file from the drop-down list, or click and choose it in the dialog that opens, or just type the path in the text box. If the field is empty, PhpStorm 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.
In this field, specify the Node.js interpreter to use. This can be a local Node.js interpreter or a Node.js on Windows Subsystem for Linux.
| In this text box, type the Node.js-specific command line options to be passed to the Node.js executable file. The acceptable options are: |
register.js file, which is a part of the
coffee-script package, should be located inside the project. Therefore you need to install the
coffee-script package on the Node.js page locally, as described in npm and Yarn.
--inspect parameter when you are using Node.js v7 for Chrome Debugging Protocol support. Otherwise, by default the debug process will use V8 Debugging Protocol.
In this field, specify the location of the
In this field, specify the working directory of the application. By default, the field shows the project root folder.
In this text box, 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 .
In this field, optionally specify the environment variables for executing commands.
| 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 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 the Suite name field and configure a list of suites to run. To add a suite to the list, click and type the name of the required suite. To remove a suite, select it in the list and click
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 the Test name field and configure a list of tests to run. To add a test to the list, click and type the name of the required test. To remove a test, select it in the list and click
When you edit a run configuration (but not a run configuration template), you can specify the following options for it:
In this text box, specify the name for the run/debug configuration. The name will help you identify the created configuration when you choose to edit it later, or when you invoke it, for example. from the Run popup (Shift+Alt+F10).
| 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
Single instance only
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.
Create a run/debug configuration.
Delete the selected run/debug configuration. Note that you cannot delete default configurations.
Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.
View and edit the default template for the selected run/debug configuration. The templates are used for newly created configurations.
Move the selected run/debug configuration up and down in the list.
The order of configurations in the list defines the order, in which the configurations appear when you choose a run/debug configuration.
Default templates of run/debug configurations are always sorted alphabetically.
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 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-and-drop or and buttons.
To remove grouping, select a folder and click .
Click this button to sort configurations in the alphabetical order.
Under the Templates node in the tree view of run configurations, you can select a run configuration template and edit its default settings. This will not affect the configurations that are already created, but will be used as defaults when creating new configurations of the corresponding type.
When you select the Templates node itself, you will be able to adjust general settings that apply to all run/debug configurations:
Configurations available in Run Dashboard
In this section you can create a list of run configurations available in the Run Dashboard — a tool window that helps you execute and manage multiple run/debug configurations.
Note that the dashboard will only display the configuration types for which you have created one ore more configurations.
Thus, if you add a configuration type for which no configurations exist in the project, this type will not be displayed on the dashboard until you create a configuration of this type.
Confirm rerun with process termination
|The behavior of this checkbox depends on whether the Single instance only option is selected for a particular run/debug configuration. |
If this checkbox is selected, in case of a single instance, launching a new process (for example, by clicking on the main toolbar) while another process is still running, results in showing a dialog box prompting to terminate the current process before launching a new one.
If this checkbox is not selected (or in case of multiple instances), PhpStorm starts the new process silently.
Temporary configurations limit
Specify the maximum number of temporary configurations to be stored and shown in the Select Run/Debug Configuration drop-down list.
Before Launch options
In this area you can specify tasks that must be be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.
Click this icon to add one of the following available tasks:
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 PhpStorm yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
Run Another Configuration: select to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.
Run File Watchers: select this option to have PhpStorm apply all the currently active file watchers.
- Run Grunt task: select this option to run a Grunt task. In the Grunt task dialog box 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
- Run Gulp task: select this option to run a Gulp task. In the Gulp task dialog box 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
Run npm Script: select this option to execute an npm script. In the NPM Script dialog box that opens, specify the npm run/debug configuration settings.
Run Phing target: add this task to execute the specified Phing target prior to running or debugging. To appoint a Phing target, click Browse and select the desired target in the dialog that opens.
Start React Native Bundler: select this option to run the bundler automatically, as part of a running or debugging session. by default, this is done through
react-native start. If your application uses Expo, you need to run the development server via the
start npm task. To do that, click , then in the Configure React Native dialog, choose npm script and select start from the list.
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.
Upload files to Remote Host: select this option to have the application files automatically uploaded to the server according to the default server access configuration.
Run Remote External tool: adds a remote SSH external tool.
Click this icon to remove the selected task from the list.
Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
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
If this checkbox is selected, which it is by default, the Run or the Debug tool window opens when you start the run/debug configuration.
Otherwise, the tool window isn't shown. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5.
Last modified: 2 November 2018