Skip to content

armgit / mocha

Public Imported from GitHub
0

☕️ Classic, reliable, trusted test framework for Node.js and the browser

docs

Tj Holowaychukfb2528023bcf
diff --git a/Readme.md b/Readme.md
index 21072acb..10734822 100644
--- a/Readme.md
+++ b/Readme.md
@@ -29,6 +29,7 @@
- use any assertion library you want ([should](http://github.com/visionmedia/should.js), `assert`, etc)
- extensible reporting
- dot matrix
+ - doc generator (html)
- landing strip
- test-anything-protocol (TAP) producer
- progress bar
@@ -62,6 +63,7 @@ Options:
Reporters:
dot - dot matrix
+ doc - html documentation
json - single json object
progress - progress bar
list - spec-style listing
@@ -200,6 +202,12 @@ module.exports = {
["end",{"start":"2011-08-29T03:21:02.050Z","suites":13,"passes":11,"tests":12,"failures":1,"end":"2011-08-29T03:21:02.052Z","duration":2}]
````
+## Doc
+
+ The "doc" reporter outputs a hierarchical HTML body representation
+ of your tests, wrap it with a header, footer, some styling and you
+ have some fantastic documentation!
+
## Async tests
Testing async code with mocha is simple, invoke the `done()` callback
diff --git a/bin/mocha b/bin/mocha
index 4e53a2e0..c162ad84 100755
--- a/bin/mocha
+++ b/bin/mocha
@@ -42,6 +42,7 @@ program.on('--help', function(){
console.log(' Reporters:');
console.log('');
console.log(' dot - dot matrix');
+ console.log(' doc - html documentation');
console.log(' json - single json object');
console.log(' progress - progress bar');
console.log(' list - spec-style listing');