Consolidate similar tests, bump coverage.

Author: tmcw

bin/documentation.js

@@ -53,11 +53,11 @@ function onFormatted(parsedArgs, err, output) {
   }
 }
 
-if (parsedArgs.watch) {
-  var watcher = chokidar.watch(parsedArgs.inputs);
-  watcher.on('all', debounce(generator, 300));
-} else if (parsedArgs.command === 'lint') {
+if (parsedArgs.command === 'lint') {
   documentation.lint(parsedArgs.inputs, parsedArgs.options, function (err, lintOutput) {
+    if (err) {
+      throw err;
+    }
     if (lintOutput) {
       console.log(lintOutput);
       process.exit(1);
@@ -67,6 +67,10 @@ if (parsedArgs.watch) {
   });
 } else {
   generator();
+  if (parsedArgs.watch) {
+    var watcher = chokidar.watch(parsedArgs.inputs);
+    watcher.on('all', debounce(generator, 300));
+  }
 }
 
 function updateWatcher() {

index.js

@@ -125,8 +125,9 @@ module.exports = function (indexes, options, callback) {
 };
 
 /**
- * Generate JavaScript documentation as a list of parsed JSDoc
- * comments, given a root file as a path.
+ * Lint files for non-standard or incorrect documentation
+ * information, returning a potentially-empty string
+ * of lint information intended for human-readable output.
  *
  * @param {Array<string>|string} indexes files to process
  * @param {Object} options options
@@ -157,27 +158,23 @@ module.exports.lint = function lint(indexes, options, callback) {
     if (error) {
       return callback(error);
     }
-    try {
-      callback(null,
-        formatLint(hierarchy(
-          inputs
-            .filter(filterJS)
-            .reduce(function (memo, file) {
-              return memo.concat(parseFn(file));
-            }, [])
-            .map(pipeline(
-              lintComments,
-              inferName(),
-              inferKind(),
-              inferParams(),
-              inferProperties(),
-              inferReturn(),
-              inferMembership(),
-              nest))
-            .filter(Boolean))));
-    } catch (e) {
-      callback(e);
-    }
+    callback(null,
+      formatLint(hierarchy(
+        inputs
+          .filter(filterJS)
+          .reduce(function (memo, file) {
+            return memo.concat(parseFn(file));
+          }, [])
+          .map(pipeline(
+            lintComments,
+            inferName(),
+            inferKind(),
+            inferParams(),
+            inferProperties(),
+            inferReturn(),
+            inferMembership(),
+            nest))
+          .filter(Boolean))));
   });
 };
 

test/bin.js

@@ -87,12 +87,25 @@ test('--shallow option', function (t) {
   });
 }, options);
 
-test('bad -f option', function (t) {
-  documentation(['build -f DOES-NOT-EXIST fixture/internal.input.js'], function (err) {
-    t.ok(err, 'returns error');
-    t.end();
-  });
-}, options);
+test('invalid arguments', function (group) {
+  group.test('bad -f option', function (t) {
+    documentation(['build -f DOES-NOT-EXIST fixture/internal.input.js'], function (err) {
+      t.ok(err, 'returns error');
+      t.end();
+    });
+  }, options);
+
+  group.test('html with no destination', function (t) {
+    documentation(['build -f html fixture/internal.input.js'], function (err) {
+      t.ok(err.toString()
+        .match(/The HTML output mode requires a destination directory set with -o/),
+        'needs dest for html');
+      t.end();
+    });
+  }, options);
+
+  group.end();
+});
 
 test('--version', function (t) {
   documentation(['--version'], {}, function (err, output) {
@@ -101,35 +114,38 @@ test('--version', function (t) {
   }, false);
 }, options);
 
-test('html with no destination', function (t) {
-  documentation(['build -f html fixture/internal.input.js'], function (err) {
-    t.ok(err.toString()
-      .match(/The HTML output mode requires a destination directory set with -o/),
-      'needs dest for html');
-    t.end();
-  });
-}, options);
+test('lint command', function (group) {
 
-test('--lint option', function (t) {
-  documentation(['lint fixture/lint/lint.input.js'], function (err, data) {
-    var output = path.join(__dirname, 'fixture/lint/lint.output.js');
-    data = data.toString().split('\n').slice(2).join('\n');
-    if (process.env.UPDATE) {
-      fs.writeFileSync(output, data);
-    }
-    t.equal(err.code, 1);
-    t.equal(data, fs.readFileSync(output, 'utf8'), 'outputs lint');
-    t.end();
-  });
-}, options);
+  group.test('generates lint output', function (t) {
+    documentation(['lint fixture/lint/lint.input.js'], function (err, data) {
+      var output = path.join(__dirname, 'fixture/lint/lint.output.js');
+      data = data.toString().split('\n').slice(2).join('\n');
+      if (process.env.UPDATE) {
+        fs.writeFileSync(output, data);
+      }
+      t.equal(err.code, 1);
+      t.equal(data, fs.readFileSync(output, 'utf8'), 'outputs lint');
+      t.end();
+    });
+  }, options);
 
-test('--lint option on good file', function (t) {
-  documentation(['lint fixture/simple.input.js'], {}, function (err, data) {
-    t.equal(err, null);
-    t.equal(data, '', 'no output');
-    t.end();
-  }, false);
-}, options);
+  group.test('generates no output on a good file', function (t) {
+    documentation(['lint fixture/simple.input.js'], {}, function (err, data) {
+      t.equal(err, null);
+      t.equal(data, '', 'no output');
+      t.end();
+    }, false);
+  }, options);
+
+  group.test('exposes syntax error on a bad file', function (t) {
+    documentation(['lint fixture/bad/syntax.input.js'], {}, function (err, data) {
+      t.ok(err.code > 0, 'exits with a > 0 exit code');
+      t.end();
+    }, false);
+  }, options);
+
+  group.end();
+});
 
 test('given no files', function (t) {
   documentation(['build'], function (err) {

test/fixture/es6-import.output.custom.md

@@ -17,6 +17,12 @@ Is it empty
 
 This method says hello
 
+# es6.input
+
+This function returns the number one.
+
+Returns **Number** numberone
+
 # foo
 
 This is an async method