add-matchers

add-matchers

What: A JavaScript library to write test Matchers compatible with all versions of Jest and Jasmine.

Why: The way you write tests in Jasmine and Jest is extremely similar, but the APIs for adding custom matchers vary wildly between Jasmine 1.x, Jasmine 2.x, and Jest. This library aims to remove those obstacles and encourage Developers to share useful matchers they've created with the community.

How: Developers use the API from this library, which converts them to be compatible with whichever test framework is running.

Contents

• Installation
• API
• Writing Matchers
  • Examples
• Related Projects

Installation

npm install --save-dev add-matchers

Include add-matchers after your test framework but before your tests, and register your matchers before your tests as well.

API

Add Custom Matchers

import { addMatchers } from 'add-matchers';

addMatchers({
  toBeFoo(value) {
    return value === 'foo';
  },
  toInclude(other, value) {
    return value.includes(other);
  }
});

expect('foo').toBeFoo();
expect('jamie').toInclude('jam');

Add Custom Asymmetric Matchers

import { addMatchers } from 'add-matchers';

addMatchers.asymmetric({
  toBeFoo(value) {
    return value === 'foo';
  },
  toInclude(other, value) {
    return value.includes(other);
  }
});

expect({ key: 'foo', prop: 'bar' }).toEqual({
  key: any.toBeFoo(),
  prop: any.toInclude('ar')
});

Writing Matchers

The argument passed to expect is always the last argument passed to your Matcher, with any other arguments appearing before it in the order they were supplied.

This means that, in the case of expect(received).toBeAwesome(arg1, arg2, arg3), your function will be called with fn(arg1, arg2, arg3, received).

Arguments are ordered in this way to support partial application and increase re-use of matchers.

Examples

If we wanted to use the following Matchers in our tests;

// matcher with 0 arguments
expect(4).toBeEvenNumber();

// matcher with 1 argument
expect({}).toBeOfType('Object');

// matcher with Many arguments
expect([100, 14, 15, 2]).toContainItems(2, 15, 100);

We would create them as follows;

import { addMatchers } from 'add-matchers';

addMatchers({
  // matcher with 0 arguments
  toBeEvenNumber: function(received) {
    // received : 4
    return received % 2 === 0;
  },
  // matcher with 1 argument
  toBeOfType: function(type, received) {
    // type     : 'Object'
    // received : {}
    return Object.prototype.toString.call(received) === '[object ' + type + ']';
  },
  // matcher with many arguments
  toContainItems: function(arg1, arg2, arg3, received) {
    // arg1     : 2
    // arg2     : 15
    // arg3     : 100
    // received : [100, 14, 15, 2]
    return (
      received.indexOf(arg1) !== -1 &&
      received.indexOf(arg2) !== -1 &&
      received.indexOf(arg3) !== -1
    );
  }
});

For more examples, see Jasmine Matchers which is built using this library.

Related Projects

• Jasmine Matchers: A huge library of test assertion matchers to improve readability.
• karma-benchmark: A Karma plugin to run Benchmark.js over multiple browsers, with CI compatible output.
• karma-jasmine-matchers: A Karma plugin to inject Jasmine Matchers.
• karma-nested-reporter: Easy to read test output with nested describe and it blocks.

Changelog

0.6.2 (2019-01-12)

Bug Fixes

• matchers: handle optional messages correctly (a439683)