expect-more-jest

expect-more-jest

Write Beautiful Specs with Custom Matchers for Jest

Status

This is a new project which needs a lot of work on documentation. It is under active development so there will likely be changes, but at its core it is a rewrite of jasmine-expect which is a mature, well-tested library.

Contributors welcome, please get in touch.

Installation

npm install expect-more-jest --save-dev

Setup

Add a setupTestFrameworkScriptFile entry to your Jest Configuration which points to a JavaScript file somewhere in your project.

{
  "setupTestFrameworkScriptFile": "<rootDir>/test/setup-test-framework-script-file.js"
}

In that file (in this example we have chosen ./test/setup-test-framework-script-file.js) include the following:

import { asymmetric, matchers } from 'expect-more-jest';

beforeEach(() => {
  // register asymmetric matchers such as expect.nonEmptyArray()
  Object.assign(expect, asymmetric);
  // register test matchers such as expect().toBeArray()
  expect.extend(matchers);
});

API

Asymmetric Matchers

• expect.after
• expect.arrayOfBooleans
• expect.arrayOfNumbers
• expect.arrayOfObjects
• expect.arrayOfSize
• expect.arrayOfStrings
• expect.before
• expect.calculable
• expect.divisibleBy
• expect.endingWith
• expect.evenNumber
• expect.iso8601
• expect.jsonString
• expect.longerThan
• expect.near
• expect.nonEmptyArray
• expect.nonEmptyObject
• expect.nonEmptyString
• expect.oddNumber
• expect.sameLengthAs
• expect.shorterThan
• expect.startingWith
• expect.validDate
• expect.whitespace
• expect.wholeNumber
• expect.withinRange

Generators

• gen.missingBranches
• gen.missingLeaves
• gen.missingNodes
• gen.nullBranches
• gen.nullLeaves
• gen.nullNodes

Matchers

• expect().toBeAfter
• expect().toBeArrayOfBooleans
• expect().toBeArrayOfNumbers
• expect().toBeArrayOfObjects
• expect().toBeArrayOfSize
• expect().toBeArrayOfStrings
• expect().toBeArray
• expect().toBeBefore
• expect().toBeBoolean
• expect().toBeCalculable
• expect().toBeDate
• expect().toBeDivisibleBy
• expect().toBeEmptyArray
• expect().toBeEmptyObject
• expect().toBeEmptyString
• expect().toBeEvenNumber
• expect().toBeFalse
• expect().toBeFunction
• expect().toBeIso8601
• expect().toBeJsonString
• expect().toBeLongerThan
• expect().toBeNonEmptyArray
• expect().toBeNonEmptyObject
• expect().toBeNonEmptyString
• expect().toBeNumber
• expect().toBeObject
• expect().toBeOddNumber
• expect().toBeRegExp
• expect().toBeSameLengthAs
• expect().toBeShorterThan
• expect().toBeString
• expect().toBeTrue
• expect().toBeValidDate
• expect().toBeWhitespace
• expect().toBeWholeNumber
• expect().toBeWithinRange
• expect().toEndWith
• expect().toStartWith
• expect().toSurvive