Jest

• Open the built-in PhpStorm Terminal (Alt+F12) and type npm install --save-dev jest at the command prompt.
  See also Getting Started on the Jest official website.

To run a single test from the editor

• Click or in the left gutter and choose Run <test_name> from the pop-up list. You can also see whether a test has passed or failed right in the editor, thanks to the test status icons in the left gutter.

To create a Jest run configuration

1. Select a test file in the Project tool window and choose Create <file name> on the context menu. The Run/Debug Configuration: Jest dialog box opens.

2. Specify the Node.js interpreter to use. This can be a local Node.js interpreter or a Node.js on Windows Subsystem for Linux.

3. Specify the location of the jest, react-scripts, react-script-ts, react-super-scripts, or react-awesome-scripts package and 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.

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

5. Optionally configure rerunning the tests automatically on changes in the related source files. To do that, add the --watch flag in the Jest options field.

To run tests via a run configuration

1. Select the Jest run/debug configuration from the list on the main toolbar and click  to the right of the list.

   

2. The test server starts automatically without any steps from your side. View and analyze messages from the test server in the Run tool window.

3. Monitor test execution in the Test Runner tab of the Run tool window.

To rerun failed tests

• In the Test Runner tab, click on the toolbar. PhpStorm will execute all the tests that failed during the previous session.

• To rerun a specific failed test, select Run <test name> on its context menu.

To jump between a file and the related test file

• Open the file in the editor and choose Go To | Test or Go To | Test Subject on the context menu, or just press Ctrl+Shift+T.

To jump from a test result to the test

• Select the test name in the Test Runner tab and choose Jump to Source on the context menu. The test file opens in the editor with the cursor placed at the test definition.

• For failed tests, PhpStorm brings you to the failure line in the test from the stack trace. If the exact line is not in the stack trace, you will be taken to the test definition.

  

To update the snapshot for a failed test

• Use the Click to update snapshot link in the Test Runner tab of the Run tool window:

  

To navigate from a test file to the related snapshot file

• Click in the left gutter next to the test.

• With the cursor at toMatchSnapshot(), press Ctrl+Alt+Home and select the required snapshot from the list.

  

To compare the actual output with the expected snapshot

• Use the Click to see difference link in the right-hand pane of the Test Runner tab.

  

To start debugging a single test from the editor

• Click or in the left gutter and choose Debug <test_name> from the pop-up list.

To launch test debugging via a run/debug configuration

1. Create a Jest run/debug configuration as described above.

2. Select the Jest run/debug configuration from the list on the main toolbar and click  to the right of the list.

   

3. In the Debug Tool Window that opens, proceed as usual: step through the tests, stop and resume test execution, examine the test when suspended, etc.

To run tests with coverage

1. Create a Jest run/debug configuration as described above.

2. Select the Jest run/debug configuration from the list on the main toolbar and click  to the right of the list.
   Alternatively, quickly run a specific suite or a test with coverage from the editor: click or in the left gutter and choose Run <test_name> with Coverage from the pop-up list.

3. Monitor the code coverage in the Coverage tool window. The report shows how many files were covered with tests and the percentage of covered lines in them. From the report you can jump to the file and see what lines were covered – marked green – and what lines were not covered – marked red: