jest-html-reporter

What is jest-html-reporter?

jest-html-reporter is a Jest test results processor that generates a customizable HTML report. It helps in visualizing test results in a more readable and accessible format.

What are jest-html-reporter's main functionalities?

Basic HTML Report

This configuration generates a basic HTML report with a custom page title. It is added to the Jest configuration file (jest.config.js or package.json).

{
  "reporters": [
    "default",
    [
      "jest-html-reporter",
      {
        "pageTitle": "Test Report"
      }
    ]
  ]
}

Custom Output Path

This configuration specifies a custom output path for the HTML report. The report will be saved to the specified location.

{
  "reporters": [
    "default",
    [
      "jest-html-reporter",
      {
        "outputPath": "./reports/test-report.html"
      }
    ]
  ]
}

Custom Report Title and Theme

This configuration allows setting a custom title and theme for the HTML report. The 'darkTheme' option provides a dark-themed report.

{
  "reporters": [
    "default",
    [
      "jest-html-reporter",
      {
        "pageTitle": "My Custom Test Report",
        "theme": "darkTheme"
      }
    ]
  ]
}

Include Failure Messages

This configuration includes detailed failure messages in the HTML report, making it easier to debug test failures.

{
  "reporters": [
    "default",
    [
      "jest-html-reporter",
      {
        "includeFailureMsg": true
      }
    ]
  ]
}

Sort Results

This configuration sorts the test results in the HTML report by status, making it easier to identify failed tests.

{
  "reporters": [
    "default",
    [
      "jest-html-reporter",
      {
        "sort": "status"
      }
    ]
  ]
}

Other packages similar to jest-html-reporter

jest-stare

jest-stare is another Jest test results processor that generates an HTML report. It provides a more detailed and interactive report compared to jest-html-reporter, including charts and graphs for better visualization.

jest-html-reporters

jest-html-reporters is a highly customizable HTML report generator for Jest. It supports multiple themes, custom styles, and additional data like screenshots and logs, making it more versatile than jest-html-reporter.

README

📜

jest-html-reporter

A Jest test results processor for generating a summary in HTML.
Documentation »



Inspired by karma-htmlfile-reporter

Installation

$ yarn add jest-html-reporter --dev

Usage

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

"reporters": [
	"default",
	["./node_modules/jest-html-reporter", {
		"pageTitle": "Test Report"
	}]
]

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

There are multiple configuration options available. To read more about these, please refer to the documentation.

Alternative Usage as a Test Results Processor

To run the reporter as a test results processor (after Jest is complete instead of running in parallel), add the following entry to the Jest config (jest.config.json):

{
	"testResultsProcessor": "./node_modules/jest-html-reporter"
}

Note: When running as a testResultsProcessor, the configuration needs be placed within a new file named jesthtmlreporter.config.json residing in the root folder. More information about this can be found in the documentation.

Node Compatibility

This plugin is compatible with Node version ^4.8.3

Configuration

Please note that all configuration properties are optional.

Property	Type	Description	Default
append	BOOLEAN	If set to true, new test results will be appended to the existing test report	false
boilerplate	STRING	The path to a boilerplate file that should be used to render the body of the test results into. {jesthtmlreporter-content} within the boilerplate will be replaced with the test results	null
customScriptPath	STRING	Path to a javascript file that should be injected into the test report	null
dateFormat	STRING	The format in which date/time should be formatted in the test report. Have a look in the documentation for the available date format variables.	"yyyy-mm-dd HH:MM:ss"
executionTimeWarningThreshold	NUMBER	The threshold for test execution time (in seconds) in each test suite that will render a warning on the report page. 5 seconds is the default timeout in Jest.	5
includeConsoleLog	BOOLEAN	If set to true, this will output all triggered console logs for each test suite. Please note that you have to run Jest together with --verbose=false in order to have Jest catch any logs during the tests.	false
includeFailureMsg	BOOLEAN	If this setting is set to true, this will output the detailed failure message for each failed test.	false
includeSuiteFailure	BOOLEAN	If set to true, this will output the detailed failure message for complete suite failures.	false
includeObsoleteSnapshots	BOOLEAN	If set to true, this will output obsolete snapshot names.	false
logo	STRING	Path to a logo that will be included in the header of the report	null
outputPath	STRING	The path to where the plugin will output the HTML report. The path must include the filename and end with .html	"./test-report.html"
pageTitle	STRING	The title of the document. This string will also be outputted on the top of the page.	"Test Suite"
sort	STRING	Sorts the test results using the given method. Available sorting methods can be found in the documentation.	"default"
statusIgnoreFilter	STRING	A comma-separated string of the test result statuses that should be ignored when rendering the report. Available statuses are: "passed", "pending", "failed"	null
styleOverridePath	STRING	The path to a file containing CSS styles that should override the default styling.*	null
useCssFile	BOOLEAN	If set to true, the CSS styles will link in the current theme's .css file instead of inlining its content on the page	false

*The plugin will search for the *styleOverridePath* from the root directory, therefore there is no need to prepend the string with ./ or ../ - You can read more about the themes in the documentation.

Continuous Integration

Configuration may also be performed with environment variables for dynamic file saving paths in different environments. *NOTE: Environment variables will take precedence over configurations set in jesthtmlreporter.config.json and package.json*

Example

Here is an example of dynamically naming your output file and test report title to match your current branch that one might see in a automated deployment pipeline before running their tests.

export BRANCH_NAME=`git symbolic-ref HEAD 2>/dev/null | cut -d"/" -f 3`
export JEST_HTML_REPORTER_OUTPUT_PATH=/home/username/jest-test-output/test-reports/"$BRANCH_NAME".html
export JEST_HTML_REPORTER_PAGE_TITLE="$BRANCH_NAME"\ Test\ Report

Configuration Environment Variables

The environment variables reflect the configuration options available in JSON format. Please read the documentation for more information on these variables.