BDD / TDD assertion framework for node.js and the browser that can be paired with any testing framework.
JavaScript Other
Latest commit b7ff144 Nov 24, 2016 @shvaikalesh shvaikalesh committed on GitHub Merge pull request #875 from bdadam/patch-1
Provided browser field in package.json
Permalink
Failed to load latest commit information.
lib docs: rewrite `.throw` jsdoc Nov 15, 2016
support/sauce tests: [sauce] error in setup Sep 18, 2013
test test: comment out broken tests in Safari 10 (#869) Nov 17, 2016
.gitignore Automate release process as much as possible Jun 3, 2015
.mailmap Add a .mailmap file to fix my name in shortlogs. May 20, 2012
.npmignore Add coverage to npmignore Jan 26, 2014
.travis.yml Drop support of node v0.10 Oct 2, 2016
CODE_OF_CONDUCT.md Add email to CODE_OF_CONDUCT.md Mar 12, 2016
CONTRIBUTING.md Add lucasfcosta to contributors on README.md and CONTRIBUTING.md Mar 11, 2016
History.md Automate release process as much as possible Jun 3, 2015
LICENSE Create LICENSE Oct 25, 2016
MAINTAINERS Add @shvaikalesh to MAINTAINERS Oct 3, 2016
Makefile Run clean-browser before testing with karma Dec 19, 2015
README.md Auto register side effects and Update documentation (#872) Nov 18, 2016
ReleaseNotes.md Automate release process as much as possible Jun 3, 2015
bower.json Remove moot `version` property from bower.json Jun 12, 2015
chai.js improved documentation for .throws Apr 22, 2016
index.js clean up index.js to not check for cov, revert package.json to use in… Nov 29, 2012
karma.conf.js Refactor global.err to test error properties Apr 12, 2016
karma.sauce.js chore: tweak saucelab build settings Feb 8, 2016
package.json Provided browser field in package.json Nov 23, 2016
register-assert.js Auto register side effects and Update documentation (#872) Nov 18, 2016
register-expect.js Auto register side effects and Update documentation (#872) Nov 18, 2016
register-should.js Auto register side effects and Update documentation (#872) Nov 18, 2016
sauce.browsers.js chore: tweak saucelab build settings Feb 8, 2016

README.md

ChaiJS chai

Chai is a BDD / TDD assertion library for node and the browser that can be delightfully paired with any javascript testing framework.

license:mit tag:? node:?
Selenium Test Status
downloads:? build:? coverage:? devDependencies:?
Join the Slack chat Join the Gitter chat OpenCollective Backers

For more information or to download plugins, view the documentation.

What is Chai?

Chai is an assertion library, similar to Node's build in assert. It makes testing much easier by giving you lots of assertions you can run against your code.

Installation

Node.js

chai is available on npm. To install it, type:

$ npm install chai

Browsers

You can also use it within the browser; install via npm and use the chai.js file found within the download. For example:

<script src="./node_modules/chai/chai.js"></script>

Usage

Import the library in your code, and then pick one of the styles you'd like to use - either assert, expect or should:

var chai = require('chai');  
var assert = chai.assert;    // Using Assert style
var expect = chai.expect;    // Using Expect style
var should = chai.should();  // Using Should style

Pre-Native Modules Usage (registers the chai testing style globally)

require('chai/register-assert');  // Using Assert style
require('chai/register-expect');  // Using Expect style
require('chai/register-should');  // Using Should style

Pre-Native Modules Usage (as local variables)

const { assert } = require('chai');  // Using Assert style
const { expect } = require('chai');  // Using Expect style
const { should } = require('chai');  // Using Should style
should();  // Modifies `Object.prototype`

const { expect, use } = require('chai');  // Creates local variables `expect` and `use`; useful for plugin use

Native Modules Usage (registers the chai testing style globally)

import 'chai/register-assert';  // Using Assert style
import 'chai/register-expect';  // Using Expect style
import 'chai/register-should';  // Using Should style

Native Modules Usage (local import only)

import { assert } from 'chai';  // Using Assert style
import { expect } from 'chai';  // Using Expect style
import { should } from 'chai';  // Using Should style
should();  // Modifies `Object.prototype`

Usage with Mocha

mocha spec.js -r chai/register-assert  # Using Assert style
mocha spec.js -r chai/register-expect  # Using Expect style
mocha spec.js -r chai/register-should  # Using Should style

Read more about these styles in our docs.

Plugins

Chai offers a robust Plugin architecture for extending Chai's assertions and interfaces.

  • Need a plugin? View the official plugin list.
  • Want to build a plugin? Read the plugin api documentation.
  • Have a plugin and want it listed? Simply add the following keywords to your package.json:
    • chai-plugin
    • browser if your plugin works in the browser as well as Node.js
    • browser-only if your plugin does not work with Node.js

Related Projects

Contributing

Thank you very much for considering to contribute!

Please make sure you follow our Code Of Conduct and we also strongly recommend reading our Contributing Guide.

Here are a few issues other contributors frequently ran into when opening pull requests:

  • Please do not commit changes to the chai.js build. We do it once per release.
  • Before pushing your commits, please make sure you rebase them.

Contributors

Please see the full Contributors Graph for our list of contributors.

Core Contributors

Feel free to reach out to any of the core contributors with your questions or concerns. We will do our best to respond in a timely manner.

Jake Luer Veselin Todorov Keith Cirkel Lucas Fernandes da Costa Grant Snodgrass