Gathering detailed insights and metrics for jest-html-reporter
Gathering detailed insights and metrics for jest-html-reporter
Jest test results processor for generating a summary in HTML
Installations
npm install jest-html-reporterDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
>=14.0.0
Node Version
20.10.0
NPM Version
10.9.2
Score
78
Supply Chain
27.5
Quality
82.3
Maintenance
100
Vulnerability
97
License
Releases
44
Languages
5
TypeScript
CSS
Shell
JavaScript
Dockerfile
TypeScript (88.44%)
CSS (5.68%)
Shell (3.04%)
JavaScript (1.43%)
Dockerfile (1.42%)
Developer
Hargne
Download Statistics
Total Downloads
43,660,256
Last Day
8,637
Last Week
300,268
Last Month
1,253,911
Last Year
12,166,614
GitHub Statistics
MIT License
278 Stars
348 Commits
76 Forks
6 Watchers
3 Branches
16 Contributors
Updated on Mar 26, 2025
Bundle Size
75.58 kB
Minified
18.09 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
4.1.0
Package Id
jest-html-reporter@4.1.0
Unpacked Size
35.53 kB
Size
8.91 kB
File Count
5
NPM Version
10.9.2
Node Version
20.10.0
Published on
Mar 12, 2025
Total Downloads
Cumulative downloads
Total Downloads
43,660,256
Last Day
-11.5%
8,637
Compared to previous day
Last Week
1%
300,268
Compared to previous week
Last Month
-0.5%
1,253,911
Compared to previous month
Last Year
21.1%
12,166,614
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
2
Dev Dependencies
21
📜
jest-html-reporter
A Jest test results processor for generating a summary in HTML.
Inspired by karma-htmlfile-reporter
Installation
npm:
$ npm install jest-html-reporter --save-dev
yarn:
$ 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):
1"reporters": [ 2 "default", 3 ["./node_modules/jest-html-reporter", { 4 "pageTitle": "Test Report" 5 }] 6]
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. Read more about these further down in this document.
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):
1{ 2 "testResultsProcessor": "./node_modules/jest-html-reporter" 3}
Note: When running as a testResultsProcessor, the configuration needs either to be placed within a new file named jesthtmlreporter.config.json residing in the root folder
1{ 2 "pageTitle": "Test Report", 3}
or via adding a key to package.json named "jest-html-reporter":
1{ 2 ... 3 "jest-html-reporter": { 4 "pageTitle": "Test Report", 5 } 6}
📌 Configuration Options (All Optional)
| Option | Type | Default | Description |
|---|---|---|---|
additionalInformation | Array<{ label: string; value: string; }> | null | A list of additional information to be added to the top of the report. |
append | boolean | false | Append test results to an existing report. |
boilerplate | string | null | Path to an HTML boilerplate file. The {jesthtmlreporter-content} variable will be replaced with test results. |
collapseSuitesByDefault | boolean | false | Collapse test suites (accordions) by default. |
customScriptPath | string | null | Path to an external script file injected into the report. |
dateFormat | string | yyyy-mm-dd HH:MM:ss | Date format for timestamps. See documentation for available formats. |
executionTimeWarningThreshold | number | 5 | Warn if a test suite exceeds this execution time (in seconds). |
includeConsoleLog | boolean | false | Include console.log outputs in the report (requires --verbose=false). |
includeFailureMsg | boolean | false | Show detailed error messages for failed tests. |
includeStackTrace | boolean | true | Show stack traces for failed tests. |
includeSuiteFailure | boolean | false | Show detailed errors for entire failed test suites. |
includeObsoleteSnapshots | boolean | false | Show obsolete snapshot names. |
logo | string | null | Path to an image file to display in the report header. |
outputPath | string | ./test-report.html | Full path for the output report file (must end in .html). |
pageTitle | string | "Test Report" | Title of the document and top-level heading. |
sort | string | null | Sort test results by a specific method. Available values: ➤ status → Sorts by test status (pending → failed → passed).➤ status:{custom-order} → Custom status order (e.g., "status:failed,passed,pending").➤ executionasc → Sorts by execution time ascending.➤ executiondesc → Sorts by execution time descending.➤ titleasc → Sorts by suite filename/test name ascending.➤ titledesc → Sorts by suite filename/test name descending. |
statusIgnoreFilter | string | null | Comma-separated list of statuses to exclude: "passed", "pending", "failed". |
styleOverridePath | string | null | Path to a CSS file to override default styles. |
useCssFile | boolean | false | Link to the CSS file instead of inlining styles. |
Continuous Integration
All the configuration options provided in the table above are available via environment variables and follows the pattern of snake case in uppercase prepended with JEST_HTML_REPORTER_
Example: customScriptPath -> JEST_HTML_REPORTER_CUSTOM_SCRIPT_PATH
*NOTE: Environment variables will take precedence over configurations set in jesthtmlreporter.config.json and package.json*
CI 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.
1export BRANCH_NAME=`git symbolic-ref HEAD 2>/dev/null | cut -d"/" -f 3` 2export JEST_HTML_REPORTER_OUTPUT_PATH=/home/username/jest-test-output/test-reports/"$BRANCH_NAME".html 3export JEST_HTML_REPORTER_PAGE_TITLE="$BRANCH_NAME"\ Test\ Report
No vulnerabilities found.
Reason
30 commit(s) and 5 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
1 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Reason
Found 0/11 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Warn: no topLevel permission defined: .github/workflows/test-with-docker.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/Hargne/jest-html-reporter/main.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/Hargne/jest-html-reporter/main.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-with-docker.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/Hargne/jest-html-reporter/test-with-docker.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-with-docker.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/Hargne/jest-html-reporter/test-with-docker.yml/master?enable=pin
- Warn: containerImage not pinned by hash: Dockerfile:4
- Warn: containerImage not pinned by hash: Dockerfile:16
- Warn: npmCommand not pinned by hash: Dockerfile:33
- Warn: npmCommand not pinned by hash: Dockerfile:38
- Warn: npmCommand not pinned by hash: e2e/run_tests.sh:76
- Info: 0 out of 3 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
- Info: 0 out of 2 containerImage dependencies pinned
- Info: 0 out of 3 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 30 are checked with a SAST tool
Score
4.7
/10
Last Scanned on 2025-03-31
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More