npmpackage.info

Gathering detailed insights and metrics for chai

chai

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

5.1.2

8,146

MIT

JavaScript

16.39 kB

1,922,386,738 5.5

Installations

npm install chai

Pull Requests

Open

6

Total

651

Closed

170

Merged

475

Issues

Open

98

Total

960

Closed

862

Releases

v5.1.2

Published on 23 Oct 2024

v4.5.0

Published on 25 Jul 2024

v5.1.1

Published on 09 May 2024

v5.1.0

Published on 12 Feb 2024

v5.0.3

Published on 25 Jan 2024

v5.0.2

Published on 25 Jan 2024

View all 51 releases

Developer

chaijs

Developer Guide

BETA

Module System

ESM

Min. Node Version

>=12

Typescript Support

No

Node Version

22.10.0

NPM Version

10.9.0 Statistics

8,146 Stars

1,606 Commits

698 Forks

134 Watching

2 Branches

163 Contributors

Updated on 28 Nov 2024

Bundle Size

63.91 kB

Minified

16.39 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (99.97%)

TypeScript (0.03%)

Total Downloads

Cumulative downloads

Total Downloads

1,922,386,738

Last day

-9.8%

3,205,694

Compared to previous day

Last week

3.9%

19,342,939

Compared to previous week

Last month

25.1%

75,454,113

Compared to previous month

Last year

59%

592,963,194

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

assertion-error check-error deep-eql loupe pathval

Dev Dependencies

@rollup/plugin-commonjs @web/dev-server-rollup @web/test-runner @web/test-runner-playwright esbuild eslint eslint-plugin-jsdoc mocha

Versions

chai

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

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 --save-dev 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:

1<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:

1import { assert } from 'chai';  // Using Assert style
2import { expect } from 'chai';  // Using Expect style
3import { should } from 'chai';  // Using Should style

Register the chai testing style globally

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

Import assertion styles as local variables

1import { assert } from 'chai';  // Using Assert style
2import { expect } from 'chai';  // Using Expect style
3import { should } from 'chai';  // Using Should style
4should();  // Modifies `Object.prototype`
5
6import { expect, use } from 'chai';  // Creates local variables `expect` and `use`; useful for plugin use

Usage with Mocha

1mocha spec.js --require chai/register-assert.js  # Using Assert style
2mocha spec.js --require chai/register-expect.js  # Using Expect style
3mocha spec.js --require chai/register-should.js  # Using Should style

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

chaijs / chai-docs: The chaijs.com website source code.
chaijs / assertion-error: Custom Error constructor thrown upon an assertion failing.
chaijs / deep-eql: Improved deep equality testing for Node.js and the browser.
chaijs / check-error: Error comparison and information related utility for Node.js and the browser.
chaijs / loupe: Inspect utility for Node.js and browsers.
chaijs / pathval: Object value retrieval given a string path.

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.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

7

Maintained

Determines if the project is "actively maintained".

6

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

5.5

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More