vitest-markdown-reporter

Generating a pretty Markdown report for Vitest, based on jest-md-dashboard, markdown design heavily inspired by Test Reporter.

Table of Contents

• Example
• Installation
• Usage
• Options
• Contribution
• License

Example

See #1

Installation

pnpm

pnpm install -D vitest-markdown-reporter

Usage

Add reporters field in vitest.config.ts or under test in vite.config.ts.

/// <reference types="vitest" />
import { defineConfig } from "vite";
import { VitestMarkdownReporter } from "vitest-markdown-reporter";

export default defineConfig({
  test: {
    reporters: ["default", new VitestMarkdownReporter()],
    outputFile: {
      markdown: "test-report.md",
    },
  },
});

Run vitest and the report will be saved to test-report.md. If neither Vitest's native outputFile option nor this library's own is used, the report will instead be printed to the console.

With options

/// <reference types="vitest" />
import { defineConfig } from "vite";
import { VitestMarkdownReporter } from "vitest-markdown-reporter";

export default defineConfig({
  test: {
    reporters: [
      "default",
      new VitestMarkdownReporter({ title: "My Test Report" }),
    ],
    outputFile: {
      markdown: "test-report.md",
    },
  },
});

Options

Name	Type	Default	Description
title	string	"Test Report"	The title of the report. It will be printed at the top of the markdown output.
outputPath	string	undefined	The file path to save the report to.
permalinkBaseUrl	string	undefined	Override baseUrl of permalink. See Permalink section for more information.
enableGithubActionsSummary	boolean	true	Enable GitHub Actions summary when running in CI.
flat	boolean	true	Flatten Test suites in report.

Permalink

vitest-markdown-reporter generates permalinks to test files on GitHub (or other services) by default.

It tries to find git information from the following sources.

1. permalinkBaseUrl option
2. (on GitHub Actions) environment variables
3. (in git repository) repository config

1. permalinkBaseUrl option

If permalinkBaseUrl is supplied vitest-markdown-reporter will use it to generate permalinks.

Specify this option when if generated permalinks are incorrect.

The URL must have a trailing slash.

e.g. https://github.com/pecirep/vitest-markdown-reporter/blob/

2. Run on GitHub Actions

If vitest runs on GitHub Actions, vitest-markdown-reporter refers to the the environment variables.

3. Run in git repository

If vitest runs in a git repository, vitest-markdown-reporter refers to the local repository config.

Contribution

We appreciate your help!

License

• MIT