mocha
Advanced tools
Package description
Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple and fun. Mocha tests run serially, allowing for flexible and accurate reporting, while mapping uncaught exceptions to the correct test cases.
Test Organization
Organize tests in suites and sub-suites using describe() and context(), and specify test cases using it().
"use strict";\nconst assert = require('assert');\ndescribe('Array', function() {\n describe('#indexOf()', function() {\n it('should return -1 when the value is not present', function() {\n assert.equal([1, 2, 3].indexOf(4), -1);\n });\n });\n});Asynchronous Testing
Support for testing asynchronous code with ease, using callbacks, promises, or async/await.
"use strict";\nconst assert = require('assert');\ndescribe('User', function() {\n describe('#save()', function() {\n it('should save without error', function(done) {\n const user = new User('Luna');\n user.save(function(err) {\n if (err) done(err);\n else done();\n });\n });\n });\n});Hooks
Lifecycle hooks such as before(), after(), beforeEach(), and afterEach() for setting up preconditions and clean-up after tests.
"use strict";\ndescribe('Connection', function() {\n before(function() {\n // runs once before the first test in this block\n });\n\n after(function() {\n // runs once after the last test in this block\n });\n\n beforeEach(function() {\n // runs before each test in this block\n });\n\n afterEach(function() {\n // runs after each test in this block\n });\n\n // test cases\n});Jest is a delightful JavaScript Testing Framework with a focus on simplicity. It works out of the box for any React project and is often compared to Mocha for its comprehensive feature set including a built-in assertion library and mock functions.
Jasmine is a behavior-driven development framework for testing JavaScript code. It does not rely on browsers, DOM, or any JavaScript framework. Thus, it's suited for websites, Node.js projects, or anywhere that JavaScript can run. It's compared to Mocha for its clean syntax and testing capabilities.
AVA is a test runner for Node.js with a concise API, detailed error output, and process isolation that lets you develop with confidence. It is often compared to Mocha for its modern, concurrent testing features, but differs in its approach to running tests in parallel by default.
Changelog
6.0.0-0 / 2019-01-01
Documentation for this release can be found at next.mochajs.org!
Welcome @plroebuck, @craigtaub, & @markowsiak to the team!
--grep and --fgrep are now mutually exclusive; attempting to use both will cause Mocha to fail instead of simply ignoring --grep--compilers is no longer supported; attempting to use will cause Mocha to fail with a link to more information-d is no longer an alias for --debug; -d is currently ignored--watch-extensions no longer implies js; it must be explicitly added (@TheDancingCode)tap reporter emits error messages (@chrmod)before hook, subsequent before hooks and tests in nested suites are now skipped (@bannmoore)lib/template.html has moved to lib/browser/template.html (@boneskull)mocha.opts at a user-specified path (@plroebuck)Base-extending reporter without a Runner parameter will throw an exception (@craigtaub)code property (and some will have additional metadata). Some Error messages have changed. Please use the code property to check Error types instead of the message property; these descriptions will be localized in the future. (@craigtaub)These are soft-deprecated, and will emit a warning upon use. Support will be removed in (likely) the next major version of Mocha:
-gc users should use --gc-global insteadbin/options should now use the loadMochaOpts or loadOptions (preferred) functions exported by the lib/cli/options moduleRegarding the Mocha class constructor (from lib/mocha):
color: false instead of useColors: falsetimeout: false instead of enableTimeouts: falseAll of the above deprecations were introduced by #3556.
mocha.opts is now considered "legacy"; please prefer RC file or package.json over mocha.opts.
Enhancements introduced in #3556:
Mocha now supports "RC" files in JS, JSON, YAML, or package.json-based (using mocha property) format
.mocharc.js, .mocharc.json, .mocharc.yaml or .mocharc.yml are valid "rc" file names and will be automatically loaded--config /path/to/rc/file to specify an explicit path--package /path/to/package.json to specify an explicit package.json to read the mocha prop from--no-config or --no-package to completely disable loading of configuration via RC file and package.json, respectivelypackage.jsonmocha.optsNode/V8 flag support in mocha executable:
node flags as supported by the running version of node (also thanks to @demurgos)--v8- to the flag namepackage.json properties, or mocha.opts--inspect) now imply --no-timeouts--debug will automatically invoke --inspect if supported by running version of nodeSupport negation of any Mocha-specific command-line flag by prepending --no- to the flag name
Interfaces now have descriptions when listed using --interfaces flag
Mocha constructor supports all options
--extension is now an alias for --watch-extensions and affects non-watch-mode test runs as well. For example, to run only test/*.coffee (not test/*.js), you can do mocha --require coffee-script/register --extensions coffee.
#3552: tap reporter is now TAP13-capable (@plroebuck & @mollstam)
#3535: Mocha's version can now be queried programmatically via public property Mocha.prototype.version (@plroebuck)
#2529: Runner now emits a retry event when tests are retried (reporters can listen for this) (@catdad)
#2962, #3111: In-browser notification support; warn about missing prereqs when --growl supplied (@plroebuck)
--no-timeouts and --timeout 0 now does what you'd expect (@boneskull)--no-exit option (@boneskull)SIGINT (@boneskull)--forbid-only and --forbid-pending now "fail fast" when encountered on a suite (@outsideris)stdout: prefix in browser console (@Bamieh)utils.isPromise() (@fabiosantoscode)--bail would not execute "after" nor "after each" hooks (@juergba)TERM=dumb (@plroebuck).github/CONTRIBUTING.md (@markowsiak)slow option (@finfin)--watch docs (@benglass)ms userland module instead of hand-rolled solution (@gizemkeser)Readme
:coffee: Simple, flexible, fun JavaScript test framework for Node.js & The Browser :coffee:
Become a backer and show your support to our open source project.
Does your company use Mocha? Ask your manager or marketing team if your company would be interested in supporting our project. Support will allow the maintainers to dedicate more time for maintenance and new features for everyone. Also, your company's logo will show on GitHub and on our site - who doesn't want a little extra exposure? Here's the info.
You might want to know that:
You might want to help:
Finally, come chat with the maintainers on Gitter if you want to help with:
FAQs
Unknown package
The npm package mocha receives a total of 4,833,025 weekly downloads. As such, mocha popularity was classified as popular.
We found that mocha demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.