Jest Open

An understated problem is that some developers will write unit tests without ever checking the test coverage. jest-open makes it easier to open the coverage html report by outputting a link and command.

Most modern terminal emulators will allow you to click the link this reporter outputs to open it in the default browser. For example, Alacritty supports this feature. Some require you to ctrl+click.

Respects jest's collectCoverage config value. If collectCoverage is false, this reporter does not output anything.

Complements jest's text-summary coverage reporter.

Install

yarn add --dev jest-open or npm install --save-dev jest-open

Use

npx jest-open or yarn jest-open after a coverage report has been output by jest.

Setup

Add jest-open to the reporters array in your jest.config.js:

reporters: [
  'default',
  'jest-open'
],

You will probably also want to keep the default reporter set if no other reporters are.

If you are using any other version of jest than jest 27, you will need to force jest-config@27 to resolve to whatever version of jest you are using. For example, if you are using jest 24.9.0 then set this in your package.json and re-yarn:

"resolutions": {
  "jest-config": "24.9.0"
}

Supported Reporters

All html outputting istanbul reports are supported. More specifically, html, hmtl-spa, and lcov are supported.

If you use a custom reporter you can pass a path option. For example, you can support jest-html-reporter by adding this to your jest.config.js:

reporters: [
  'jest-html-reporter',
  ['jest-open', { path: '<rootDir>/test-report.html' }]
],

Limitations

• Only one report path is supported.
• I use linux btw, so I can't test this on windows.