https://github.com/sholzmayer/jest-performance-reporter

Visualize and report jest test execution performance
https://github.com/sholzmayer/jest-performance-reporter

Last synced: 3 months ago
JSON representation

Visualize and report jest test execution performance

• Host: GitHub
• URL: https://github.com/sholzmayer/jest-performance-reporter
• Owner: sholzmayer
• License: mit
• Created: 2021-12-11T12:32:39.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-28T16:23:28.000Z (over 1 year ago)
• Last Synced: 2024-07-19T23:13:26.543Z (4 months ago)
• Language: TypeScript
• Size: 685 KB
• Stars: 16
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-jest - jest-performance-reporter

README

        
# Overview

🧐 Identify slow tests during development

📚 Create json or csv report including the test execution times

```bash

yarn add -DE @jest-performance-reporter/core

```

![Example test run](https://raw.githubusercontent.com/sholzmayer/jest-performance-reporter/c766d041e908170f968a33d0c2b00cabfb111d4f/docs/test-example.png)

# Setup

Configure jest to use this reporter via the jest section in the package.json or your jest config.

```json

{

  "reporters": [

    "default",

    [

      "@jest-performance-reporter/core",

      {

        "errorAfterMs": 1000,

        "warnAfterMs": 500,

        "logLevel": "warn",

        "maxItems": 5,

        "jsonReportPath": "performance-report.json",

        "csvReportPath": "performance-report.csv"

      }

    ]

  ]

}

```

The "default"-reporter creates the default jest output. If you don't need it, of course you can remove it.