aboutsummaryrefslogtreecommitdiffstats
path: root/docs/config/processors/debug-dump.js
diff options
context:
space:
mode:
Diffstat (limited to 'docs/config/processors/debug-dump.js')
-rw-r--r--docs/config/processors/debug-dump.js26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/config/processors/debug-dump.js b/docs/config/processors/debug-dump.js
new file mode 100644
index 00000000..644091a3
--- /dev/null
+++ b/docs/config/processors/debug-dump.js
@@ -0,0 +1,26 @@
+var writer = require('dgeni/lib/utils/doc-writer');
+var log = require('winston');
+var util = require("util");
+
+var filter, outputPath, depth;
+
+module.exports = {
+ name: 'debug-dump',
+ runBefore: ['write-files'],
+ description: 'This processor dumps docs that match a filter to a file',
+ init: function(config, injectables) {
+ filter = config.get('processing.debug-dump.filter');
+ outputPath = config.get('processing.debug-dump.outputPath');
+ depth = config.get('processing.debug-dump.depth', 2);
+ },
+ process: function(docs) {
+ if ( filter && outputPath ) {
+ log.info('Dumping docs:', filter, outputPath);
+ var filteredDocs = filter(docs);
+ var dumpedDocs = util.inspect(filteredDocs, depth);
+ return writer.writeFile(outputPath, dumpedDocs).then(function() {
+ return docs;
+ });
+ }
+ }
+}; \ No newline at end of file