Jest-specific configuration settings

Item

Description

Configuration file

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, JetBrains Rider 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, JetBrains Rider will automatically use the project default interpreter from the Node interpreter field on the Node.js and NPM page. In most cases, JetBrains Rider detects it and fills in the field automatically. You can also choose another configured local interpreter or click and configure a new one. See Configuring Node.js Interpreters for details.

Node options

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:

Use --require coffee-script/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 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.

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 field shows the project root folder.

Jest options

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 .

Environment variables

In this field, optionally specify the environment variables for executing commands.

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 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

Toolbar

Item

Shortcut

Description

Alt+Insert

Click this button to add a new configuration to the list.

Ctrl+R, D

Click this button to remove the selected configuration from the list.

Ctrl+D

Click this button to create a copy of the selected configuration.

Edit defaults

Click this button to edit the default configuration templates. The defaults are used for newly created configurations.

or

Alt+Up or 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.

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, JetBrains Rider 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 makes sense when the 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

Ctrl+N

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 JetBrains Rider. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in JetBrains Rider yet, add its definition.

Run Another Configuration. Select this option to have another run/debug configuration executed. In the dialog that opens, select the configuration to run.

This option is available only if you have already at least one run/debug configuration in the current project.

Run File Watchers. Select this option to have JetBrains Rider 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 grunt-cli package.

Run Gulp task. Select this option to run a Grunt 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 gulp package.

Compile TypeScript. Select this option 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 have the source maps for your CoffeeScript sources generated. 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.

Ctrl+R, D

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

Click this icon to move the selected task one line up in the list.

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.

Active tool window

Select this option if you want the Run/Debug tool windows to be activated automatically when you run/debug your application. This option is enabled by default.