Fix and test behavior around requiring JSON files. Fixes #68

Author: tmcw

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.2.0
+
+* Transforms in package.json `browserify.transform` fields are now applied to
+  source code so that babel, etc can be supported.
+
 ## 1.1.0
 
 * Add `external` option that allows the user to whitelist specific external

index.js

@@ -7,6 +7,7 @@ var mdeps = require('module-deps'),
   sort = require('./streams/sort'),
   normalize = require('./streams/normalize.js'),
   filterAccess = require('./streams/filter_access.js'),
+  filterJS = require('./streams/filter_js'),
   parse = require('./streams/parse'),
   inferName = require('./streams/infer_name'),
   inferKind = require('./streams/infer_kind'),
@@ -57,6 +58,7 @@ module.exports = function (indexes, options) {
   }
 
   return md
+    .pipe(deferErrors(filterJS()))
     .pipe(deferErrors(parse()))
     .pipe(deferErrors(inferName()))
     .pipe(sort())

streams/filter_js.js

@@ -0,0 +1,20 @@
+'use strict';
+
+var through = require('through');
+
+/**
+ * Node & browserify support requiring JSON files. JSON files can't be documented
+ * with JSDoc or parsed with espree, so we filter them out before
+ * they reach documentation's machinery.
+ *
+ * @name access
+ * @public
+ * @return {stream.Transform}
+ */
+module.exports = function () {
+  return through(function (data) {
+    if (!data.file.match(/\.json$/)) {
+      this.push(data);
+    }
+  });
+};

test/fixture/require-json.input.js

@@ -0,0 +1 @@
+var data = require('./require-json.json');

test/fixture/require-json.json

@@ -0,0 +1 @@
+{}

test/fixture/require-json.output.custom.md

@@ -0,0 +1 @@
+[]