Beautiful assertion library.


Beautiful assertion library.

  • Straight-forward: Alright should get out of your way and just let you define your tests with what you already know: plain JavaScript.

  • No verbosity: We don't want expect(x)

  • Helpful error messages: When things go wrong, Alright should do its best to show you exactly what's wrong and how you might fix it.

  • Test-framework agnostic: Alright should work with anything that expect Errors to be thrown when assertions fail.

  • Extensible: It should be easy to extend the built-in assertions with plain JavaScript.

  • Work with older Browsers: Some people still need to support old IEs, Alright should work on them.

Using the Sweet.js macros:

// for macros to work, you need to use 'alright' as your identifier 
var alright = require('alright')
// simple assertions 
add(a)(b) => a + b
add(a)(b) => not a + b
// anything goes assertions 
add(a)(b) should equal(+ b)
add(a)(b) should not equal(+ b)
// asynchronous assertions with pure fantasy-land monads, or Promises/A+ 
asyncAdd(a)(b) will equal(+ b)
asyncAdd(a)(b) will not equal(+ b)

Using vanilla JavaScript:

var _ = require('alright')
// Use verify for synchronous assertions 
_.verify(add(a)(b))(_.equals(+ b))
_.verify(add(a)(b))(_.not(_.equals(+ b)))
// use verifyFuture for monadic Futures, and verifyPromise for Promises/A+ 
_.verifyMonad(asyncAdd(a)(b))(_.equals(+ b))

The easiest way is to grab it from NPM. If you're running in a Browser environment, you can use [Browserify][]

$ npm install alright

If you're not using NPM, [Download the latest release][release], and require the alright.umd.js file:

var Alright = require('alright')

[Download the latest release][release], and require the alright.umd.js file:

require(['alright'], function(Alright) {
  ( ... )

[Download the latest release][release], and load the alright.umd.js file. The properties are exposed in the global Alright object:

<script src="/path/to/alright.umd.js"></script>

If you want to compile this library from the source, you'll need [Git][], [Make][], [Node.js][], and run the following commands:

$ git clone git://
$ cd alright
$ npm install
$ make bundle

This will generate the dist/alright.umd.js file, which you can load in any JavaScript environment.

You can [read the documentation online][docs] or build it yourself:

$ git clone git://
$ cd alright
$ npm install
$ make documentation

Then open the file docs/index.html in your browser.

This library assumes an ES5 environment, but can be easily supported in ES3 platforms by the use of shims. Just include [es5-shim][] :)

Copyright (c) 2014 Quildreen Motta.

Released under the MIT licence.

[Fantasy Land]: [Browserify]: [Git]: [Make]: [Node.js]: [es5-shim]: [docs]: [release]: