Use walk where appropriate

Author: jfirebaugh

bin/documentation.js

@@ -8,6 +8,7 @@ var documentation = require('../'),
   streamArray = require('stream-array'),
   fs = require('fs'),
   vfs = require('vinyl-fs'),
+  walk = require('../lib/walk'),
   formatError = require('../lib/format_error'),
   args = require('../lib/args.js');
 
@@ -16,18 +17,18 @@ var parsedArgs = args(process.argv.slice(2)),
   outputLocation = parsedArgs.output,
   formatter = documentation.formats[parsedArgs.formatter];
 
-documentation(parsedArgs.inputs, parsedArgs.options, function (err, result) {
+documentation(parsedArgs.inputs, parsedArgs.options, function (err, comments) {
   if (err) {
     throw err;
   }
 
-  result.forEach(function (comment) {
+  walk(comments, function (comment) {
     comment.errors.forEach(function (error) {
       console.error(formatError(comment, error));
     });
   });
 
-  formatter(result, formatterOptions, function (err, output) {
+  formatter(comments, formatterOptions, function (err, output) {
     if (outputLocation !== 'stdout') {
       if (parsedArgs.formatter === 'html') {
         streamArray(output).pipe(vfs.dest(outputLocation));

lib/output/json.js

@@ -1,5 +1,7 @@
 'use strict';
 
+var walk = require('../walk');
+
 /**
  * Formats documentation as a JSON string.
  *
@@ -14,7 +16,7 @@ module.exports = function (comments, opts, callback) {
   opts = opts || {};
 
   if (!opts.preserveErrors) {
-    comments.forEach(function (comment) {
+    walk(comments, function (comment) {
       delete comment.errors;
     });
   }

lib/walk.js

@@ -4,14 +4,16 @@
  *
  * @param {Array<Object>} comments an array of nested comments
  * @param {Function} fn a walker function
- * @returns {undefined} calls fn
+ * @returns {Array<Object>} comments
  */
 function walk(comments, fn) {
-  return comments.map(function (comment) {
-    comment.members.instance = walk(comment.members.instance, fn);
-    comment.members.static = walk(comment.members.static, fn);
-    return fn(comment);
+  comments.forEach(function (comment) {
+    for (var scope in comment.members) {
+      walk(comment.members[scope], fn);
+    }
+    fn(comment);
   });
+  return comments;
 }
 
 module.exports = walk;

test/normalize.js

@@ -1,13 +1,10 @@
-function normalize(comments) {
-  comments.forEach(function (comment) {
+var walk = require('../lib/walk');
+
+module.exports = function (comments) {
+  return walk(comments, function (comment) {
     delete comment.context.file;
     if (comment.context.github) {
       comment.context.github = '[github]';
     }
-    normalize(comment.members.instance);
-    normalize(comment.members.static);
   });
-  return comments;
 }
-
-module.exports = normalize;