alright
Beautiful assertion library.
Philosophy
-
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).to.eventually.be.boring...
-
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.
Example
Using the Sweet.js macros:
// for macros to work, you need to use 'alright' as your identifiervar alright = // simple assertions a + b not a + b // anything goes assertionsb should b should not // asynchronous assertions with pure fantasy-land monads, or Promises/A+b will b will not
Using vanilla JavaScript:
var _ = // Use verify for synchronous assertions____ // use verifyFuture for monadic Futures, and verifyPromise for Promises/A+__
Installing
The easiest way is to grab it from NPM. If you're running in a Browser environment, you can use Browserify
$ npm install alright
Using with CommonJS
If you're not using NPM, Download the latest release, and require
the alright.umd.js
file:
var Alright =
Using with AMD
Download the latest release, and require the alright.umd.js
file:
Using without modules
Download the latest release, and load the alright.umd.js
file. The properties are exposed in the global Alright
object:
Compiling from source
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://github.com/hifivejs/alright.git
$ cd alright
$ npm install
$ make bundle
This will generate the dist/alright.umd.js
file, which you can load in
any JavaScript environment.
Documentation
You can read the documentation online or build it yourself:
$ git clone git://github.com/hifivejs/alright.git
$ cd alright
$ npm install
$ make documentation
Then open the file docs/index.html
in your browser.
Platform support
This library assumes an ES5 environment, but can be easily supported in ES3 platforms by the use of shims. Just include es5-shim :)
Licence
Copyright (c) 2014 Quildreen Motta.
Released under the MIT licence.