jest-matcher-utils

What is jest-matcher-utils?

The jest-matcher-utils package provides utility functions for creating custom Jest matchers. It is designed to help developers write their own matchers that integrate seamlessly with Jest's built-in expectation system, offering a way to extend Jest's assertion capabilities with custom logic. The utilities provided by this package include formatting values for error messages, comparing values, and generating matcher error messages.

What are jest-matcher-utils's main functionalities?

pretty-format

Formats any JavaScript value for pretty printing, which is useful for generating readable error messages in custom matchers.

const { prettyFormat } = require('jest-matcher-utils');
console.log(prettyFormat({ foo: 'bar' }));

matcherHint

Generates a hint string for a matcher, which can be used at the beginning of error messages to indicate which matcher failed.

const { matcherHint } = require('jest-matcher-utils');
console.log(matcherHint('.toBe'));

printExpected and printReceived

These functions format the expected and received values to be included in error messages, applying color highlighting to improve readability.

const { printExpected, printReceived } = require('jest-matcher-utils');
console.log(`Expected: ${printExpected(true)}
Received: ${printReceived(false)}`);

Other packages similar to jest-matcher-utils

chai

Chai is a BDD / TDD assertion library for node and the browser that can be delightfully paired with any javascript testing framework. It offers similar functionality to jest-matcher-utils in the sense that it provides a rich set of assertions and plugins to extend its capabilities. However, Chai is a standalone assertion library, not tied to any specific test runner like Jest.

expect

Expect is a minimalist assertion library that comes with Jest but can also be used independently. It provides a similar API for writing test assertions as jest-matcher-utils, but jest-matcher-utils focuses more on the utilities for creating custom matchers rather than providing a comprehensive set of built-in matchers.

README

The README file is missing

Changelog

23.2.0

Features

• [jest-each] Add support for keyPaths in test titles (#6457)
• [jest-cli] Add jest --init option that generates a basic configuration file with a short description for each option (#6442)
• [jest.retryTimes] Add jest.retryTimes() option that allows failed tests to be retried n-times when using jest-circus. (#6498)

Fixes

• [docs] Fixed error in documentation for expect.not.arrayContaining(array). (#6491)
• [jest-cli] Add check to make sure one or more tests have run before notifying when using --notify (#6495)
• [jest-cli] Pass globalConfig as a parameter to globalSetup and globalTeardown functions (#6486)
• [jest-config] Add missing options to the defaults object (#6428)
• [expect] Using symbolic property names in arrays no longer causes the toEqual matcher to fail (#6391)
• [expect] toEqual no longer tries to compare non-enumerable symbolic properties, to be consistent with non-symbolic properties. (#6398)
• [jest-util] console.timeEnd now properly log elapsed time in milliseconds. (#6456)
• [jest-mock] Fix MockNativeMethods access in react-native jest.mock() (#6505)
• [jest-cli] Fix reporters for moduleName = 'default' (#6542)

Chore & Maintenance

• [docs] Add jest-each docs for 1 dimensional arrays (#6444)