TypeScript icon, indicating that this package has built-in type declarations

3.1.4 • Public • Published

Jest reporter

npm NPM downloads license

English | 简体中文

Jest test results processor for generating a summary in HTML

Example page

example picture


  # yarn
  yarn add jest-html-reporters --dev
  # npm
  npm install jest-html-reporters --save-dev


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

"jest": {
  "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 env variables name Type Default Description
publicPath JEST_HTML_REPORTERS_PUBLIC_PATH string '' specify the base path
filename JEST_HTML_REPORTERS_FILE_NAME string jest_html_reporters.html Filename of saved report
Applies to the generated html
expand JEST_HTML_REPORTERS_EXPAND Boolean false specify whether default expand all data
pageTitle JEST_HTML_REPORTERS_PAGE_TITLE string Report specify header and page title
logoImgPath JEST_HTML_REPORTERS_LOGO_IMG_PATH string undefined specify path of the image that will be displayed to the right of page title
hideIcon JEST_HTML_REPORTERS_HIDE_ICON boolean false hide default icon
customInfos JEST_HTML_REPORTERS_CUSTOM_INFOS 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
testCommand JEST_HTML_REPORTERS_TEST_COMMAND string "" copy command content to quickly run test file
openReport JEST_HTML_REPORTERS_OPEN_REPORT json in dev=true, rest=false options for npm package open
env variable support only JEST_HTML_REPORTERS_TEMP_DIR_PATH string system default temporary directory path to a temporary folder with attachments
failureMessageOnly JEST_HTML_REPORTERS_FAILURE_MESSAGE_ONLY number 0 0 : always create report.
1 : show failure test suites messages only in Report.
2 : only create report when some test suites failed.
enableMergeData JEST_HTML_REPORTERS_ENABLE_MERGE_DATA boolean false for default enable merge test data feature
dataMergeLevel JEST_HTML_REPORTERS_DATA_MERGE_LEVEL number 1 default merge test data level
inlineSource JEST_HTML_REPORTERS_INLINE_SOURCE boolean false Option to save report in a single combined HTML file #184
urlForTestFiles JEST_HTML_REPORTERS_URL_FOR_TEST_FILES string '' url for test files. If user set this value, Details table shows an icon link to each rows. The link is constructed by joining urlForTestFiles and relativePath (like /src/utils/index.test.js) for each tests. See the detail in #221
darkTheme JEST_HTML_REPORTERS_DARK_THEME boolean false set true to generate dark theme report page
includeConsoleLog JEST_HTML_REPORTERS_INCLUDE_CONSOLE_LOG boolean false set true to display console logs for each test suite. NOTE: the precondition is to run Jest with --verbose=false in order to catch all logs during the tests.

example add config options

"reporters": [
  ["jest-html-reporters", {
    "publicPath": "./html-report",
    "filename": "report.html",
    "openReport": true

some features.

  • Collapsable Test Groups

This feature regrading to #37, if a test file has many test cases, here will show a Merge Data checkbox on the expanded table. You can check it to merge data and set the merge level to control how to combine those data.

For Example merge data example

  • Attach screenshot to report

This feature regrading to #36, this package will a new method named addAttach.

interface IAddAttachParams {
    attach: string | Buffer;
    description: string;
    context: any;
    bufferFormat: string;

There are three params of this method, description is easy to understand. The param attach referring to the image, you can pass a buffer or string, if it was a buffer the package will help you create a dir named jest-html-reporters-attach and save that buffer as a jpg image in it under the publicPath. if you have already saved the image, just pass the image's path as the attach param. context is an optional parameter. Here can be specified context (default is

Here is an Example with puppeteer.

// Example attach with **buffer**
const { addAttach } = require("jest-html-reporters/helper");
const puppeteer = require("puppeteer");

describe("just examples", () => {
  test("test buffer", async () => {
    const browser = await puppeteer.launch();
    const page = await browser.newPage();
    await page.goto("");
    const data = await page.screenshot();
    await browser.close();
    await addAttach({
      attach: data,
      description: 'img 1',
    await addAttach({
      attach: await fs.readFileSync('./test.mp4'),
      description: 'img 1',
      bufferFormat: 'mp4',
// Example attach with **string**
const { addAttach } = require("jest-html-reporters/helper");
const puppeteer = require("puppeteer");
const path = require("path");

describe("just examples", () => {
  test("case string", async () => {
    const filePath = path.resolve(__dirname, "./test.jpg");
    await browser.close();
    await addAttach({
      attach: filePath,
      description: 'test google 2',

    await addAttach({
      attach: '',
      description: 'test video 2',

it will show like this example

  • Attach a message to the report

This feature is in regards to #63 & #64. It allows you to add a message or log something to the html report with addMsg()

 * @param {object} options - options object
 * @param {string} options.message - message string
 * @param {any} [options.context] - custom context (optional)
const addMsg = async ({ message, context }) => { ... }

Only one parameter is required. If you stringify an object like this JSON.stringify(object, null, 2), the object will be prettified. context is an optional parameter. Here can be specified context (default is

Here is an Example with Nightmare.

const { addAttach, addMsg } = require("jest-html-reporters/helper");
const Nightmare = require("nightmare");

describe("Yet another example", () => {
  test("Both addAttach & addMsg with failure", async () => {
    const nightmare = Nightmare({ show: true });
    await addMsg({ message: JSON.stringify({ won: 1, too: 2 }, null, 2) });
    await nightmare.goto("");
    const s1 = await nightmare.screenshot();
    await addAttach(s1, "test duckduckgo 1");
    await nightmare.end();
    await addMsg({ message: JSON.stringify(process, null, 2) });
  }, 20000);
  test("addMsg with success", async () => {
    await addMsg({ message: JSON.stringify({ free: 3, for: 4 }, null, 2) });


Message still displays without screenshots and with a successful test example

  • Show a link for each test file

If user set some value to urlForTestFiles, Details table shows an icon link to each rows. The link is constructed by joining urlForTestFiles (ex: and relativePath (ex: /src/utils/index.test.js) for each tests.

Details Table shows an icon link to each rows.


npm i jest-html-reporters

DownloadsWeekly Downloads






Unpacked Size

3.18 MB

Total Files


Last publish


  • hazyzh