add plugin to dump parser events to the console (jsdoc#242)

Author: hegemonic

plugins/eventDumper.js

@@ -0,0 +1,56 @@
+/*global env: true */
+/**
+ * @overview Dump information about parser events to the console.
+ * @module plugins/eventDumper
+ * @author Jeff Williams <[email protected]>
+ */
+
+var _ = require('underscore');
+
+var conf = env.conf.eventDumper || {};
+
+// Dump the included parser events (defaults to all events)
+var events = conf.include || [
+    'fileBegin',
+    'beforeParse',
+    'jsdocCommentFound',
+    'symbolFound',
+    'newDoclet',
+    'fileComplete'
+];
+// Don't dump the excluded parser events
+if (conf.exclude) {
+    events = _.difference(events, conf.exclude);
+}
+
+/**
+ * Get rid of native Java crud in an event object so that JSON.stringify() works.
+ * @param {object} e The event object.
+ * @return {object} The fixed-up object.
+ */
+function cleanse(e) {
+    var result = {};
+
+    for (var prop in e) {
+        // go down an extra level for these
+        if (['code', 'doclet', 'meta'].indexOf(prop) !== -1) {
+            result[prop] = cleanse(e[prop]);
+        } else {
+            result[prop] = String(e[prop]);
+        }
+    }
+
+    return result;
+}
+
+
+exports.handlers = {};
+
+events.forEach(function(eventType) {
+    exports.handlers[eventType] = function(e) {
+        console.log( JSON.stringify({
+            type: eventType,
+            content: cleanse(e)
+        }, null, 4) );
+    };
+});

rhino_modules/jsdoc/src/parser.js

@@ -304,32 +304,6 @@ function getBasename(name) {
     return name;
 }
 
-/**
- * Dump an event to the console.
- * @private
- * @memberof module:src/parser.Parser
- * @param {object} e The event to dump.
- */
-function dumpEvent(e) {
-    for (var prop in e) {
-        // can't use hasOwnProp() on native objects, so let's just make JSHint happy
-        if (e[prop]) {
-            console.log("e." + prop + ": " + e[prop]);
-            // go one level down for e.code
-            if (prop === "code") {
-                for (prop in e.code) {
-                    // can't use hasOwnProp() on native objects, so let's just make JSHint happy
-                    if (e.code[prop]) {
-                        console.log("e.code." + prop + ": " + e.code[prop]);
-                    }
-                }
-            }
-        }
-    }
-
-    console.log("\n\n");
-}
-
 /** @private */
 function visitNode(node) {
     var e,