repository·main·Indexed 25 days ago
https://github.com/jest-community/jest-extendedA collection of additional matchers for Jest and Vitest that provide more specific and expressive assertions. Includes matchers for date comparisons (toBeAfter, toBeBefore, toBeBetween), array validation (toBeArray, toBeArrayOfSize), and mutation tracking (toChange, toChangeBy, toChangeTo). Supports global registration via setupFilesAfterEnv and provides an optional ESLint plugin for rule enforcement.
jest-extended provides a wide range of additional Jest matchers categorized by the data type they validate. You can use these matchers to write more expressive and readable assertions.
Available matcher categories include:
.pass(), .fail(), .toBeEmpty(), .toBeOneOf(), .toBeNil(), .toSatisfy().toBeArray(), .toBeArrayOfSize(), .toIncludeAllMembers(), etc..toBeBoolean(), .toBeTrue(), .toBeFalse().toBeDate(), .toBeValidDate(), .toBeAfter(), .toBeBetween(), etc..toBeFunction(), .toChange(), .toThrowWithMessage().toHaveBeenCalledBefore(), .toHaveBeenCalledOnce(), etc..toBeNumber(), .toBeNaN(), .toBeEven(), .toBeWithin(), etc..toBeObject(), .toContainKey(), .toContainValue(), .toBeFrozen(), etc..toResolve(), .toReject().toBeString(), .toBeHexadecimal(), .toEqualCaseInsensitive(), .toStartWith(), etc..toBeSymbol()To use jest-extended in your project, you need to follow the official installation and setup guides. The project provides additional matchers to Jest's default assertion APIs to make testing more convenient.
For detailed instructions on how to install the package and configure it within your Jest environment, please refer to the official documentation site.
jest-extended in a TypeScript project, you must explicitly tell TypeScript where to find the type declarations by adding a files property to your tsconfig.json pointing to the jest-extended type index.To generate the static content for the website, run yarn build. The resulting static files will be located in the build directory and can be hosted on any static content hosting service.
$ yarn buildTo enable the plugin, add jest-extended to the plugins array in your .eslintrc configuration file. You can omit the eslint-plugin- prefix. After adding the plugin, you can enable specific rules in the rules section using the jest-extended/ prefix.
{
"plugins": ["jest-extended"],
"rules": {
"jest-extended/prefer-to-be-true": "warn",
"jest-extended/prefer-to-be-false": "error"
}
}To use jest-extended in your project, install it as a development dependency using either npm or yarn.
npm install --save-dev jest-extendedyarn add -D jest-extendedTo use ESLint rules provided by jest-extended, you must install both eslint and eslint-plugin-jest-extended.
Note: If you have installed ESLint globally, you must also install eslint-plugin-jest-extended globally.
npm install --save-dev eslint eslint-plugin-jest-extendedTo enable TypeScript type checking for jest-extended matchers in Vitest, you must create a declaration file named jest-extended.d.ts. The content of this file depends on your Vitest version.
Use the vitest module declaration:
import type CustomMatchers from 'jest-extended';
import 'vitest';
declare module 'vitest' {
interface Assertion<T = any> extends CustomMatchers<T> {}
interface AsymmetricMatchersContaining<T = any> extends CustomMatchers<T> {}
interface ExpectStatic<T = any> extends CustomMatchers<T> {}
}Use the vi module declaration:
import type CustomMatchers from 'jest-extended';
import 'vi';
declare module 'vi' {
interface Assertion<T = any> extends CustomMatchers<T> {}
interface AsymmetricMatchersContaining<T = any> extends CustomMatchers<T> {}
interface ExpectStatic<T = any> extends CustomMatchers<T> {}
}You can also extend these declarations with your own custom matchers by adding them to the interface inheritance chain.
import type CustomMatchers from 'jest-extended';
import 'vitest';
interface MyCustomMatchers {
toBeFoo(): any;
}
declare module 'vitest' {
interface Assertion<T = any> extends CustomMatchers<T>, MyCustomMatchers {}
interface AsymmetricMatchersContaining<T = any> extends CustomMatchers<T>, MyCustomMatchers {}
interface ExpectStatic extends CustomMatchers, MyCustomMatchers {}
}If your editor does not recognize the custom jest-extended matchers, you need to declare them in a declaration file. Create a global.d.ts file in your project and add the following import:
import 'jest-extended';The website can be deployed using different methods depending on your hosting setup:
USE_SSH environment variable to true.GIT_USER environment variable to your GitHub username. This will build the site and push it to the gh-pages branch.To use jest-extended matchers globally across your Jest tests, you must register jest-extended/all in your Jest configuration file using the setupFilesAfterEnv property.
module.exports = {
setupFilesAfterEnv: ['jest-extended/all'],
};