Added setConfigDefaults method.

Added tests.

Author: neogeek

DOCUMENTATION.md

@@ -35,7 +35,7 @@ Parse an input file with parser.
 
 Parse array of directory globs and/or files, and then render the parsed data through the defined layout plugin.
 
-    parseInputs(['src/main.js'], {'parser': 'dox', 'layout': 'markdown'}).then(content => {});
+    parseInputs(['src/main.js'], {'ignore': [], 'parser': 'dox', 'layout': 'markdown'}).then(content => {});
 
 
 
@@ -44,6 +44,7 @@ Parse array of directory globs and/or files, and then render the parsed data thr
 
 - **inputs** `Array`   Array of directory globs and/or files.
 - **config** `Object`   Configuration object.
+- **config.ignore** `String`   Array of paths to ignore.
 - **config.parser** `String`   String representing the parser to be used.
 - **config.layout** `String`   String representing the layout plugin to be used.
 
@@ -187,5 +188,28 @@ Format an array of directories and/or files to be ignored by globby by adding a
 
 
 
+#### setConfigDefaults(config) 
+
+Sets default configuration values.
+
+    console.log(setConfigDefaults({}));
+
+
+
+
+##### Parameters
+
+- **config** `Object`   Custom configuration object.
+
+
+
+
+##### Returns
+
+
+- `Object`   Modified configuration object.
+
+
+
 
 *Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*

lib/doxdox.js

@@ -53,10 +53,11 @@ const parseInput = (input, config) =>
 /**
  * Parse array of directory globs and/or files, and then render the parsed data through the defined layout plugin.
  *
- *     parseInputs(['src/main.js'], {'parser': 'dox', 'layout': 'markdown'}).then(content => {});
+ *     parseInputs(['src/main.js'], {'ignore': [], 'parser': 'dox', 'layout': 'markdown'}).then(content => {});
  *
  * @param {Array} inputs Array of directory globs and/or files.
  * @param {Object} config Configuration object.
+ * @param {String} config.ignore Array of paths to ignore.
  * @param {String} config.parser String representing the parser to be used.
  * @param {String} config.layout String representing the layout plugin to be used.
  * @return {Object} Promise

lib/utils.js

@@ -3,6 +3,10 @@
 const fs = require('fs');
 const path = require('path');
 
+const DEFAULT_CONFIG_IGNORE_PATHS = [];
+const DEFAULT_CONFIG_PARSER = 'dox';
+const DEFAULT_CONFIG_PLUGIN = 'markdown';
+
 /**
  * Finds package.json file from either the directory the script was called from or a supplied path.
  *
@@ -60,7 +64,24 @@ const findPackageFileInPath = input => {
 const formatPathsArrayToIgnore = paths =>
     paths.map(path => `!${path.replace(/^!/, '')}`);
 
+/**
+ * Sets default configuration values.
+ *
+ *     console.log(setConfigDefaults({}));
+ *
+ * @param {Object} config Custom configuration object.
+ * @return {Object} Modified configuration object.
+ * @public
+ */
+
+const setConfigDefaults = config => Object.assign({}, {
+    'ignore': DEFAULT_CONFIG_IGNORE_PATHS,
+    'parser': DEFAULT_CONFIG_PARSER,
+    'plugin': DEFAULT_CONFIG_PLUGIN
+}, config);
+
 module.exports = {
     findPackageFileInPath,
-    formatPathsArrayToIgnore
+    formatPathsArrayToIgnore,
+    setConfigDefaults
 };

test/fixtures/doxdox.md

@@ -34,7 +34,7 @@ Parse an input file with parser.
 
 Parse array of directory globs and/or files, and then render the parsed data through the defined layout plugin.
 
-    parseInputs(['src/main.js'], {'parser': 'dox', 'layout': 'markdown'}).then(content => {});
+    parseInputs(['src/main.js'], {'ignore': [], 'parser': 'dox', 'layout': 'markdown'}).then(content => {});
 
 
 
@@ -43,6 +43,7 @@ Parse array of directory globs and/or files, and then render the parsed data thr
 
 - **inputs** `Array`   Array of directory globs and/or files.
 - **config** `Object`   Configuration object.
+- **config.ignore** `String`   Array of paths to ignore.
 - **config.parser** `String`   String representing the parser to be used.
 - **config.layout** `String`   String representing the layout plugin to be used.
 

test/specs/utils.js

@@ -54,4 +54,40 @@ describe('doxdox utils', () => {
 
     });
 
+    describe('setConfigDefaults', () => {
+
+        it('set defaults on empty object', () => {
+
+            assert.deepEqual(utils.setConfigDefaults({}), {
+                'ignore': [],
+                'parser': 'dox',
+                'plugin': 'markdown'
+            });
+
+        });
+
+        it('set defaults with no object', () => {
+
+            assert.deepEqual(utils.setConfigDefaults(), {
+                'ignore': [],
+                'parser': 'dox',
+                'plugin': 'markdown'
+            });
+
+        });
+
+        it('set defaults on object with custom values', () => {
+
+            assert.deepEqual(utils.setConfigDefaults({
+                'plugin': 'bootstrap'
+            }), {
+                'ignore': [],
+                'parser': 'dox',
+                'plugin': 'bootstrap'
+            });
+
+        });
+
+    });
+
 });