JSDB.io is now JavaScripting.com

JavaScripting

The definitive source of the best
JavaScript libraries, frameworks, and plugins.


  • ×

    An easy-to-use JavaScript Unit Testing framework.
    Filed under 

    • 🔾82%Overall
    • 3,020
    • 2.4 days
    • 🕩587
    • 👥15

    Build Status Coverage Status

    QUnit - A JavaScript Unit Testing Framework.

    QUnit is a powerful, easy-to-use, JavaScript unit testing framework. It's used by the jQuery project to test its code and plugins but is capable of testing any generic JavaScript code (and even capable of testing JavaScript code on the server-side).

    QUnit is especially useful for regression testing: Whenever a bug is reported, write a test that asserts the existence of that particular bug. Then fix it and commit both. Every time you work on the code again, run the tests. If the bug comes up again - a regression - you'll spot it immediately and know how to fix it, because you know what code you just changed.

    Having good unit test coverage makes safe refactoring easy and cheap. You can run the tests after each small refactoring step and always know what change broke something.

    QUnit is similar to other unit testing frameworks like JUnit, but makes use of the features JavaScript provides and helps with testing code in the browser, e.g. with its stop/start facilities for testing asynchronous code.

    If you are interested in helping developing QUnit, you are in the right place. For related discussions, visit the QUnit and Testing forum.

    Development

    To submit patches, fork the repository, create a branch for the change. Then implement the change, run grunt to lint and test it, then commit, push and create a pull request.

    Include some background for the change in the commit message and Fixes #nnn, referring to the issue number you're addressing.

    To run grunt, you need Node.js, which includes npm, then npm install -g grunt-cli. That gives you a global grunt binary. For additional grunt tasks, also run npm install.

    Releases

    Use jquery-release. The following aren't yet handled there:

    • Install git-extras and run git changelog to update History.md. Clean up the changelog, removing merge commits or whitespace cleanups.
    • Run grunt authors and add any new authors to AUTHORS.txt
    • Update the version property in package.json to have the right -pre version. Not necessary for patch releases.

    Commit these, then run the script.

    Update web sites, replacing previous versions with new ones:

    • jquery/qunitjs.com pages/index.html and resources/*.html

    Finally announce on Twitter @qunitjs

    Released @VERSION: https://github.com/jquery/qunit/tree/@VERSION
    Changelog: https://github.com/jquery/qunit/blob/@VERSION/History.md
    Show All