libs/js/jquery-mobile-1.2.0/node_modules/grunt/node_modules/nodeunit/doc/nodeunit.md

   1 nodeunit(1) -- simple node.js unit testing tool
   2 ===============================================
   3
   4 ## SYNOPSIS
   5
   6     nodeunit [options] <file-or-directory> [<file-or-directory> ...]
   7
   8 ## DESCRIPTION
   9
  10 Nodeunit is a simple unit testing tool based on the node.js assert module.
  11
  12 * Simple to use
  13 * Just export the tests from a module
  14 * Helps you avoid common pitfalls when testing asynchronous code
  15 * Easy to add test cases with setUp and tearDown functions if you wish
  16 * Allows the use of mocks and stubs
  17
  18 ## OPTIONS
  19
  20   __--config FILE__:
  21       Load config options from a JSON file, allows the customisation
  22       of color schemes for the default test reporter etc.
  23       See bin/nodeunit.json for current available options.
  24
  25   __--reporter FILE__:
  26       You can set the test reporter to a custom module or on of the modules
  27       in nodeunit/lib/reporters, when omitted, the default test runner is used.
  28
  29   __--list-reporters__:
  30       List available build-in reporters.
  31
  32   __-h__, __--help__:
  33       Display the help and exit.
  34
  35   __-v__, __--version__:
  36       Output version information and exit.
  37
  38   __<file-or-directory>__:
  39       You can run nodeunit on specific files or on all *\*.js* files inside
  40       a directory.
  41
  42 ## AUTHORS
  43
  44 Written by Caolan McMahon and other nodeunit contributors.
  45 Contributors list: <http://github.com/caolan/nodeunit/contributors>.
  46
  47 ## REPORTING BUGS
  48
  49 Report nodeunit bugs to <http://github.com/caolan/nodeunit/issues>.
  50
  51 ## COPYRIGHT
  52
  53 Copyright © 2010 Caolan McMahon.
  54 Nodeunit has been released under the MIT license:
  55 <http://github.com/caolan/nodeunit/raw/master/LICENSE>.
  56
  57 ## SEE ALSO
  58
  59 node(1)
  60