@jest/reporters

What is @jest/reporters?

The @jest/reporters package provides utilities for handling and customizing the output of test results when using Jest, a popular JavaScript testing framework. It allows developers to create custom reporters to modify how test results are reported, making it easier to integrate with various CI tools, generate reports in different formats, or enhance the testing experience with additional logging and notifications.

What are @jest/reporters's main functionalities?

Custom Test Reporter

This feature allows developers to create a custom test reporter by implementing methods that Jest calls at different stages of the test run. The example shows a basic custom reporter that logs messages at the start and end of the test suite, as well as after each test result.

class MyCustomReporter {
  onRunStart(results, options) {
    console.log('Test suite started');
  }

  onTestResult(test, testResult, aggregatedResult) {
    console.log(`Test ${test.path} finished with ${testResult.numFailingTests} failures`);
  }

  onRunComplete(contexts, results) {
    console.log('All tests completed');
  }
}

module.exports = MyCustomReporter;

Other packages similar to @jest/reporters

mocha-reporter

Similar to @jest/reporters, mocha-reporter is used with the Mocha testing framework to customize the output of test results. While @jest/reporters is specific to Jest, mocha-reporter offers similar customization capabilities for those using Mocha, allowing for a tailored reporting experience depending on the user's needs.

karma-jasmine-html-reporter

This package is a plugin for the Karma test runner that provides detailed HTML reporting for tests written with Jasmine. It's similar to @jest/reporters in that it enhances the reporting capabilities of test results, but it is specifically designed for use with Karma and Jasmine, showcasing a more visual and interactive report compared to the typically console-based reports of @jest/reporters.

README

The README file is missing

Changelog

24.3.1

Fixes

• [jest-cli] export functions compatible with import {default} (#8080)
• [jest-worker]: Fix retries and error notification in workers (#8079)

Chore & Maintenance

• [pretty-format]: Use react-is instead of manual $$typeof checks (#8060)