jest-md-dashboard
Advanced tools
Generating a pretty Markdown dashboard for Jest
See https://github.com/tasshi-me/jest-md-dashboard/issues/20
npm install -D jest-md-dashboard
yarn add -D jest-md-dashboard
pnpm add -D jest-md-dashboard
Add reporters field in jest.config.js.
const config = {
reporters: ["default", "jest-md-dashboard"],
};
module.exports = config;
Run jest and the dashboard is generated to test-dashboard.md.
const config = {
reporters: ["default", ["jest-md-dashboard", { title: "My Dashboard" }]],
};
module.exports = config;
| Name | Type | Default | Description |
|---|---|---|---|
title | string | "Test Dashboard" | The title of a dashboard. It will be printed at the top of the markdown output. |
outputPath | string | test-dashboard.md | The file path to output dashboard. If you want to output to stdout, specify -. |
permalinkBaseUrl | string | undefined | Override baseUrl of permalink. See Permalink section for more information. |
jest-md-dashboard generates permalink to test files on GitHub (or other services) by default.
It tries to find git information from the following sources.
permalinkBaseUrl optionpermalinkBaseUrl optionIf permalinkBaseUrl is specified on jest config, jest-md-dashboard generates permalink using it.
Specify this option when if generated permalinks are incorrect.
The URL must have a trailing slash.
e.g. https://github.com/tasshi-me/jest-md-dashboard/blob/
If jest runs on GitHub Actions, jest-md-dashboard refers to the the environment variables.
If jest runs in a git repository, jest-md-dashboard refers to the local repository config.
We appreciate your help!
FAQs
Generating a pretty Markdown dashboard for Jest
We found that jest-md-dashboard demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Following last week’s supply chain attack, Nx published findings on the GitHub Actions exploit and moved npm publishing to Trusted Publishers.
Security News
AGENTS.md is a fast-growing open format giving AI coding agents a shared, predictable way to understand project setup, style, and workflows.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.