💯

Author: tmcw

bin/documentation.js

@@ -30,10 +30,6 @@ documentation(parsedArgs.inputs, parsedArgs.options, function (err, result) {
   });
 
   formatter(result, formatterOptions, function (err, output) {
-    if (err) {
-      throw err;
-    }
-
     if (outputLocation !== 'stdout') {
       if (parsedArgs.formatter === 'html') {
         streamArray(output).pipe(vfs.dest(outputLocation));
@@ -45,7 +41,3 @@ documentation(parsedArgs.inputs, parsedArgs.options, function (err, result) {
     }
   });
 });
-
-/*
-  .pipe(argv.g ? github() : new PassThrough({ objectMode: true }))
-*/

test/bin.js

@@ -2,10 +2,11 @@
 
 var test = require('tap').test,
   path = require('path'),
+  os = require('os'),
   exec = require('child_process').exec,
   fs = require('fs');
 
-function documentation(args, options, callback) {
+function documentation(args, options, callback, parseJSON) {
   if (!callback) {
     callback = options;
     options = {};
@@ -21,7 +22,11 @@ function documentation(args, options, callback) {
     if (err) {
       return callback(err, stdout, stderr);
     }
-    callback(err, JSON.parse(stdout), stderr);
+    if (parseJSON === false) {
+      callback(err, stdout, stderr);
+    } else {
+      callback(err, JSON.parse(stdout), stderr);
+    }
   });
 }
 
@@ -77,3 +82,63 @@ test('--shallow option', function (t) {
     t.end();
   });
 });
+
+test('bad -f option', function (t) {
+  documentation(['-f DOES-NOT-EXIST fixture/internal.input.js'], function (err, data) {
+    t.ok(err.toString().match(/Formatter not found/), 'reports bad formatter');
+    t.end();
+  });
+});
+
+test('html with no destination', function (t) {
+  documentation(['-f html fixture/internal.input.js'], function (err, data) {
+    t.ok(err.toString()
+      .match(/The HTML output mode requires a destination directory set with -o/),
+      'needs dest for html');
+    t.end();
+  });
+});
+
+test('given no files', function (t) {
+  documentation([''], function (err, data) {
+    t.ok(err.toString()
+      .match(/documentation was given no files and was not run in a module directory/),
+      'no files given');
+    t.end();
+  });
+});
+
+test('write to file', function (t) {
+
+  var dst = path.join(os.tmpdir(), (Date.now() + Math.random()).toString());
+
+  documentation(['--shallow fixture/internal.input.js -o ' + dst], {}, function (err, data) {
+    t.error(err);
+    t.equal(data, '');
+    t.ok(fs.existsSync(dst), 'created file');
+    t.end();
+  }, false);
+});
+
+test('write to html', function (t) {
+
+  var dstDir = path.join(os.tmpdir(), (Date.now() + Math.random()).toString());
+  fs.mkdirSync(dstDir);
+
+  documentation(['--shallow fixture/internal.input.js -f html -o ' + dstDir], {},
+    function (err, data) {
+      t.error(err);
+      t.equal(data, '');
+      t.ok(fs.existsSync(path.join(dstDir, 'index.html')), 'created index.html');
+      t.end();
+    }, false);
+});
+
+test('fatal error', function (t) {
+
+  documentation(['--shallow fixture/bad/syntax.input.js'], {},
+    function (err, data) {
+      t.ok(err.toString().match(/Unexpected token/), 'reports syntax error');
+      t.end();
+    }, false);
+});

test/fixture/simple.output.github.json

@@ -0,0 +1,67 @@
+[
+  {
+    "description": "This function returns the number one.",
+    "tags": [
+      {
+        "title": "returns",
+        "description": "numberone",
+        "lineNumber": 2,
+        "type": {
+          "type": "NameExpression",
+          "name": "Number"
+        }
+      }
+    ],
+    "loc": {
+      "start": {
+        "line": 1,
+        "column": 0
+      },
+      "end": {
+        "line": 4,
+        "column": 3
+      }
+    },
+    "context": {
+      "loc": {
+        "start": {
+          "line": 5,
+          "column": 0
+        },
+        "end": {
+          "line": 8,
+          "column": 2
+        }
+      },
+      "code": "module.exports = function () {\n  // this returns 1\n  return 1;\n};",
+      "path": "test/fixture/simple.input.js",
+      "github": "https://github.com/documentationjs/documentation/blob/1e4dd63875058fdb540e9cd0141606eebd3a2f65/test/fixture/simple.input.js#L5-L8"
+    },
+    "errors": [
+      "memberof reference to module not found"
+    ],
+    "returns": [
+      {
+        "title": "returns",
+        "description": "numberone",
+        "lineNumber": 2,
+        "type": {
+          "type": "NameExpression",
+          "name": "Number"
+        }
+      }
+    ],
+    "name": "exports",
+    "kind": "function",
+    "memberof": "module",
+    "scope": "static",
+    "members": {
+      "instance": [],
+      "static": []
+    },
+    "events": [],
+    "path": [
+      "exports"
+    ]
+  }
+]

test/test.js

@@ -13,6 +13,23 @@ var test = require('tap').test,
 
 var UPDATE = !!process.env.UPDATE;
 
+if (fs.existsSync(path.join(__dirname, '../.git'))) {
+  test('git option', function (t) {
+    var file = path.join(__dirname, './fixture/simple.input.js');
+    documentation([file], { github: true }, function (err, result) {
+      t.ifError(err);
+      normalize(result);
+      var outputfile = file.replace('.input.js', '.output.github.json');
+      if (UPDATE) {
+        fs.writeFileSync(outputfile, JSON.stringify(result, null, 2));
+      }
+      var expect = require(outputfile);
+      t.deepEqual(result, expect);
+      t.end();
+    });
+  });
+}
+
 test('external modules option', function (t) {
   documentation([
     path.join(__dirname, 'fixture', 'external.input.js')