RubyMine 2018.1 Help

Jest

The following is only valid when NodeJS Plugin is installed and enabled!

Jest is a testing platform for client-side JavaScript applications and React applications specifically. Learn more about the platform from Jest Official website.

You can run and debug tests with Jest right in RubyMine. You can see the test results in a treeview and easily navigate to the test source from there. Test status is shown next to the test in the editor with an option to quickly run it or debug it.

Running tests

With RubyMine, you can quickly run a single Jest test right from the editor or create a run/debug configuration to execute some or all of your tests.

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.

Specify the Node interpreter to use and the location of the jest, react-scripts, react-script-ts, react-super-scripts, or react-awesome-scripts package.

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.

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, RubyMine 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 the Jest default configuration is used.

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

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

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

Navigation

With RubyMine, you can jump between a file and the related test file. Navigation from a test result in the Test Runner Tab to the test is also supported.

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.

The test file should follow popular naming conventions, e.g. have a .test., .spec. or _spec. suffix and should be located either next to the source file or in a test folder.

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.

Snapshot testing

RubyMine integration with Jest supports such a great feature as snapshot testing. If a snapshot does not match the rendered application the test fails. This indicates that either some changes in your code have caused this mismatch or the snapshot is outdated and needs to be updated. 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:

Debugging tests

With RubyMine, you can quickly start debugging a single Jest test right from the editor or create a run/debug configuration to debug some or all of your tests.

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.

Monitoring code coverage

With RubyMine, you can also monitor how much of your code is covered with Jest tests. RubyMine displays this statistics in a dedicated tool window and marks covered and uncovered lines visually right in the editor.

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.

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: