Auto generate API.md using mocha

Author: dignifiedquire

API.md

@@ -0,0 +1,88 @@
+# TOC
+   - [IPFS Node.js API wrapper tests](#ipfs-nodejs-api-wrapper-tests)
+     - [.send](#ipfs-nodejs-api-wrapper-tests-send)
+     - [.add](#ipfs-nodejs-api-wrapper-tests-add)
+     - [.cat](#ipfs-nodejs-api-wrapper-tests-cat)
+     - [.ls](#ipfs-nodejs-api-wrapper-tests-ls)
+     - [.config](#ipfs-nodejs-api-wrapper-tests-config)
+     - [.update (currently disabled, wait for IPFS 0.4.0 release](#ipfs-nodejs-api-wrapper-tests-update-currently-disabled-wait-for-ipfs-040-release)
+     - [.version](#ipfs-nodejs-api-wrapper-tests-version)
+     - [.commands](#ipfs-nodejs-api-wrapper-tests-commands)
+     - [.mount](#ipfs-nodejs-api-wrapper-tests-mount)
+     - [.diag](#ipfs-nodejs-api-wrapper-tests-diag)
+     - [.block](#ipfs-nodejs-api-wrapper-tests-block)
+     - [.object](#ipfs-nodejs-api-wrapper-tests-object)
+     - [.swarm](#ipfs-nodejs-api-wrapper-tests-swarm)
+     - [.ping](#ipfs-nodejs-api-wrapper-tests-ping)
+     - [.id](#ipfs-nodejs-api-wrapper-tests-id)
+     - [.pin](#ipfs-nodejs-api-wrapper-tests-pin)
+     - [.log](#ipfs-nodejs-api-wrapper-tests-log)
+     - [.name](#ipfs-nodejs-api-wrapper-tests-name)
+     - [.refs](#ipfs-nodejs-api-wrapper-tests-refs)
+     - [.dht](#ipfs-nodejs-api-wrapper-tests-dht)
+<a name=""></a>
+ 
+<a name="ipfs-nodejs-api-wrapper-tests"></a>
+# IPFS Node.js API wrapper tests
+has the api object.
+
+```js
+assert(apiClients['a'])
+assert(apiClients['a'].id)
+```
+
+<a name="ipfs-nodejs-api-wrapper-tests-send"></a>
+## .send
+<a name="ipfs-nodejs-api-wrapper-tests-add"></a>
+## .add
+<a name="ipfs-nodejs-api-wrapper-tests-cat"></a>
+## .cat
+<a name="ipfs-nodejs-api-wrapper-tests-ls"></a>
+## .ls
+<a name="ipfs-nodejs-api-wrapper-tests-config"></a>
+## .config
+<a name="ipfs-nodejs-api-wrapper-tests-update-currently-disabled-wait-for-ipfs-040-release"></a>
+## .update (currently disabled, wait for IPFS 0.4.0 release
+<a name="ipfs-nodejs-api-wrapper-tests-version"></a>
+## .version
+<a name="ipfs-nodejs-api-wrapper-tests-commands"></a>
+## .commands
+<a name="ipfs-nodejs-api-wrapper-tests-diag"></a>
+## .diag
+<a name="ipfs-nodejs-api-wrapper-tests-block"></a>
+## .block
+<a name="ipfs-nodejs-api-wrapper-tests-object"></a>
+## .object
+<a name="ipfs-nodejs-api-wrapper-tests-swarm"></a>
+## .swarm
+.swarm.connect.
+
+```js
+// Done in the 'before' segment
+done()
+```
+
+<a name="ipfs-nodejs-api-wrapper-tests-ping"></a>
+## .ping
+<a name="ipfs-nodejs-api-wrapper-tests-id"></a>
+## .id
+<a name="ipfs-nodejs-api-wrapper-tests-pin"></a>
+## .pin
+<a name="ipfs-nodejs-api-wrapper-tests-log"></a>
+## .log
+<a name="ipfs-nodejs-api-wrapper-tests-name"></a>
+## .name
+<a name="ipfs-nodejs-api-wrapper-tests-refs"></a>
+## .refs
+<a name="ipfs-nodejs-api-wrapper-tests-dht"></a>
+## .dht
+returns an error when getting a non-existent key from the DHT.
+
+```js
+this.timeout(20000)
+apiClients['a'].dht.get('non-existent', {timeout: '100ms'}, function (err, value) {
+  assert(err)
+  done()
+})
+```
+

package.json

@@ -36,7 +36,7 @@
     "gulp": "^3.9.0",
     "gulp-eslint": "^1.0.0",
     "gulp-load-plugins": "^1.0.0",
-    "gulp-mocha": "^2.1.3",
+    "gulp-spawn-mocha": "^2.2.1",
     "ipfsd-ctl": "^0.6.1",
     "karma": "^0.13.11",
     "karma-browserify": "^4.4.0",

tasks/test.js

@@ -33,7 +33,16 @@ gulp.task('test:browser', function (done) {
 
 gulp.task('mocha', function () {
   return gulp.src('test/tests.js')
-    .pipe($.mocha())
+    .pipe($.spawnMocha())
+})
+
+gulp.task('docs', function () {
+  return gulp.src('test/tests.js')
+    .pipe($.spawnMocha({
+      reporter: 'markdown',
+      output: 'API.md'
+    }))
+
 })
 
 gulp.task('karma', function (done) {