Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
An easy-to-use JavaScript Unit Testing framework.
JavaScript HTML CSS
branch: master

This branch is 18 commits behind jquery:master

Failed to load latest commit information.
build
reporter
src Core: Simplify stack trace methods
test Tests: Move HTML Reporter files to test/reporter-html
.editorconfig Build: Add .editorconfig for common editor settings
.gitattributes Build: Add .gitattributes to tell git to normalize linefeeds in JS files
.gitignore Test: Updating BrowserStack config to run all test pages
.jscsrc Build: Also disable onevar equivalent for jscs
.jshintrc Build: Drop onevar rule for jshint
.mailmap Authors: Fix a bad firstname, now matches CLA name
.travis.yml
AUTHORS.txt
CONTRIBUTING.md Docs: Removed IRC channel links in CONTRIBUTING.md
Gruntfile.js Tests: Move HTML Reporter files to test/reporter-html
History.md Build: Prepare 1.17.1 release, including authors and history update
LICENSE.txt HTML Reporter: New diff using Google's Diff-Patch-Match Library
README.md Build: Update release instructions
bower.json Build: Remove bower.json from ignored files
browserstack.json Build: Include supported browsers on browserstack list
package.json Build: Update browserstack-runner devDependency

README.md

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 handled there, do that first:

  • Install git-extras and run git changelog to update History.md. Clean up the changelog, removing merge commits, whitespace cleanups or other irrelevant commits.
  • 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:

Build: Prepare @VERSION release, including authors and history update

Then run the script:

node release.js --remote=jquery/qunit

Update jquery/qunitjs.com, replacing previous versions with new ones:

  • pages/index.html
  • resources/*.html

Update GitHub releases, use the changelog from History.md.

Finally announce on Twitter @qunitjs (add highlights if possible, otherwise a 2nd tweet might do):

Released @VERSION: https://github.com/jquery/qunit/releases/tag/1.17.0
Something went wrong with that request. Please try again.