chaijs/chai


BDD / TDD assertion framework for node.js and the browser that can be paired with any testing framework.

http://chaijs.com

License: MIT

Language: JavaScript

Keywords: assertions, bdd, chai, javascript, tdd


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 built-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

Project Statistics

Sourcerank 24
Repository Size 3.98 MB
Stars 6,209
Forks 558
Watchers 125
Open issues 12
Dependencies 319
Contributors 149
Tags 77
Created
Last updated
Last pushed

Top Contributors See all

Jake Luer Keith Cirkel Grant Snodgrass Veselin Lucas Fernandes da Costa Domenic Denicola Jérémie Astori Lucas Vieira Aleksey Shvayka Joshua Perry Johannes Loewe Greenkeeper Tobias Bieniek Chris Polis Chris Tramel Ruben Verborgh greenkeeper[bot] Tomoaki Abe Inanc Gumus Andreas Leidig

Packages Referencing this Repo

chai
BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
Latest release 4.2.0 - Updated - 6.21K stars
chai
BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
Latest release 1.5.0 - Updated - 6.21K stars
chai_test
BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
Latest release 3.5.1 - Published - 6.21K stars
Testchai2
BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
Latest release 3.5.2 - Published - 6.21K stars
@cameron-martin/chai
BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
Latest release 3.5.0 - Published - 6.21K stars
chai
BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
Latest release 4.2.0 - Published - 6.21K stars
org.webjars.npm:chai
WebJar for chai
Latest release 4.1.2 - Updated - 6.21K stars
Testchai21
BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
Latest release 3.5.3 - Published - 6.21K stars
hybrid-chai
BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
Latest release 0.0.1 - Published - 6.21K stars

Recent Tags See all

4.2.0 September 26, 2018
4.1.2 August 31, 2017
4.1.1 August 05, 2017
4.1.0 July 11, 2017
4.0.2 June 05, 2017
4.0.1 May 31, 2017
4.0.0-canary.2 April 12, 2017
4.0.0-canary.1 October 24, 2016
4.0.0 October 19, 2016
3.5.0 January 28, 2016
3.4.2 November 15, 2015
3.4.1 November 07, 2015
3.4.0 October 21, 2015
3.3.0 September 11, 2015
3.2.0 July 19, 2015

Interesting Forks See all

nightwatchjs/chai-nightwatch
Expect assertion interface for Nightwatch.js based on chaijs
JavaScript - MIT - Last pushed - 3 stars - 3 forks
JamesLinus/chai
BDD / TDD assertion framework for node.js and the browser that can be paired with any testing fra...
JavaScript - MIT - Updated - 1 stars - 1 forks
pgherveou/chai
BDD / TDD assertion framework for node.js and the browser that can be paired with any testing fra...
JavaScript - Updated - 1 stars
niilante/chai
BDD / TDD assertion framework for node.js and the browser that can be paired with any testing fra...
JavaScript - Updated - 1 stars
newlysoft/chai
BDD / TDD assertion framework for node.js and the browser that can be paired with any testing fra...
JavaScript - Updated - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-04-23 13:01:09 UTC

Login to resync this repository