Name: js-handler/node_modules/nodeunit/man1/nodeunit.1 
1:
.\" Generated with Ronnjs/v0.1
2:
.\" http://github.com/kapouer/ronnjs/
3:
.
4:
.TH "NODEUNIT" "1" "October 2010" "" ""
5:
.
6:
.SH "NAME"
7:
\fBnodeunit\fR \-\- simple node\.js unit testing tool
8:
.
9:
.SH "SYNOPSIS"
10:
.
11:
.nf
12:
nodeunit [options] <file\-or\-directory> [<file\-or\-directory> \.\.\.]
13:
.
14:
.fi
15:
.
16:
.SH "DESCRIPTION"
17:
Nodeunit is a simple unit testing tool based on the node\.js assert module\.
18:
.
19:
.IP "\(bu" 4
20:
Simple to use
21:
.
22:
.IP "\(bu" 4
23:
Just export the tests from a module
24:
.
25:
.IP "\(bu" 4
26:
Helps you avoid common pitfalls when testing asynchronous code
27:
.
28:
.IP "\(bu" 4
29:
Easy to add test cases with setUp and tearDown functions if you wish
30:
.
31:
.IP "\(bu" 4
32:
Allows the use of mocks and stubs
33:
.
34:
.IP "" 0
35:
.
36:
.SH "OPTIONS"
37:
  \fB\-\-config FILE\fR:
38:
.
39:
.br
40:
      Load config options from a JSON file, allows the customisation
41:
      of color schemes for the default test reporter etc\.
42:
      See bin/nodeunit\.json for current available options\.
43:
.
44:
.P
45:
  \fB\-\-reporter FILE\fR:
46:
.
47:
.br
48:
      You can set the test reporter to a custom module or on of the modules
49:
      in nodeunit/lib/reporters, when omitted, the default test runner is used\.
50:
.
51:
.P
52:
  \fB\-\-list\-reporters\fR:
53:
.
54:
.br
55:
      List available build\-in reporters\.
56:
.
57:
.P
58:
  \fB\-h\fR, \fB\-\-help\fR:
59:
.
60:
.br
61:
      Display the help and exit\.
62:
.
63:
.P
64:
  \fB\-v\fR, \fB\-\-version\fR:
65:
.
66:
.br
67:
      Output version information and exit\.
68:
.
69:
.P
70:
  \fB<file\-or\-directory>\fR:
71:
      You can run nodeunit on specific files or on all \fI*\.js\fR files inside
72:
.
73:
.br
74:
      a directory\.
75:
.
76:
.SH "AUTHORS"
77:
Written by Caolan McMahon and other nodeunit contributors\.
78:
.
79:
.br
80:
Contributors list: \fIhttp://github\.com/caolan/nodeunit/contributors\fR\|\.
81:
.
82:
.SH "REPORTING BUGS"
83:
Report nodeunit bugs to \fIhttp://github\.com/caolan/nodeunit/issues\fR\|\.
84:
.
85:
.SH "COPYRIGHT"
86:
Copyright © 2010 Caolan McMahon\.
87:
.
88:
.br
89:
Nodeunit has been released under the MIT license:
90:
.
91:
.br
92:
\fIhttp://github\.com/caolan/nodeunit/raw/master/LICENSE\fR\|\.
93:
.
94:
.SH "SEE ALSO"
95:
node(1)