The jest-html-reporters from 1akshat

1akshat / jest-html-reporters Goto Github PK

View Code? Open in Web Editor NEW

🌈Reporter for jest test framework. 🌈

License: MIT License

JavaScript 81.66% HTML 9.31% CSS 8.29% Shell 0.73%

jest-html-reporters's Introduction

Jest reporter

Jest test results processor for generating a summary in HTML

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
`pageTitle`	string	Report	specify header and page title
`logoImgPath`	string	undefined	specify path of the image that will be displayed to the right of page title
`hideIcon`	Boolean	false	hide default icon
`customInfos`	array	undefined	show some custom data info in the report, example value `[ {title: 'test1', value: 'test1'}, {title: 'test2', value: 'test2'}]`, you can also set value to a environment variable JEST_HTML_REPORTERS_CUSTOM_INFOS, see detail in #32

example add config options

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

Recommend Projects