/jest-html-reporters

Reporter for jest test framework.

Primary LanguageJavaScriptMIT LicenseMIT

Jest reporter

npm NPM downloads license

Jest test results processor for generating a summary in HTML

example picture

Installation


  npm install jest-html-reporters --save-dev

Usage


Configure Jest to process the test results by adding the following entry to the Jest config (jest.config.json):

"jest": {
  ...,
  "reporters": [
    "default",
    "jest-html-reporters"
  ],
  ...
}

As you run Jest from within the terminal, a file called jest_html_reporters.html will be created within your root folder containing information about your tests.

Available Options

The options below are specific to the reporter.

Option Name Type Default Description
publicPath string '' specify the base path
filename string jest_html_reporters.html Filename of saved report
Applies to the generated html
expand Boolean false specify whether default expand all data

example add config options

...,
"reporters": [
  "default",
  ["jest-html-reporters", {
    "publicPath": "./html-report",
    "filename": "report.html",
    "expand": true
  }]
]