Run/Debug Configuration: Jest
In this dialog, create configurations for running Jest tests.
Before you start
Download and install Node.js.
Jest-specific configuration settings
In this field, optionally specify the jest.config 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, PyCharm 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 field, type the Node.js-specific command line options to be passed to the Node.js executable file. The acceptable options are:
This mode requires that the register.js file, which is a part of the 3 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-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.
In this field, specify the location of the jest, react-scripts, react-script-ts, react-super-scripts, or react-awesome-scripts package.
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 or choose a previously used folder from the list.
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 .
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:
In this field, 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.
Share through VCS
Select this checkbox to put the run/debug configuration under version control and make it 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 .
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.
| || 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.
View and edit the template (that is, the default run/debug configuration settings). The templates are displayed under the Templates node and 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 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.
In this area you can specify tasks that must 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 PyCharm yet, add its definition. For more information, see External 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 PyCharm apply all the currently active file watchers.
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.
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.
Run Remote External tool: adds a remote SSH external tool.
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.
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 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: 21 January 2020