Changed parseInput to parseFile.

Added parseFiles method.
Added test.

Author: neogeek

DOCUMENTATION.md

@@ -6,11 +6,11 @@
 ### lib/doxdox.js
 
 
-#### parseInput(input, config) 
+#### parseFile(input, config) 
 
-Parse an input file with parser.
+Parse a file with custom parser.
 
-    parseInput('src/main.js', {'parser': 'dox'}).then(files => {});
+    parseFile('src/main.js', {'parser': 'dox'}).then(files => {});
 
 
 
@@ -24,6 +24,33 @@ Parse an input file with parser.
 
 
 
+##### Returns
+
+
+- `Object`   Promise
+
+
+
+#### parseFiles(inputs, config) 
+
+Parse array of files, and then render the parsed data through the defined layout plugin.
+
+    parseFiles(['src/main.js'], {'ignore': [], 'parser': 'dox', 'layout': 'markdown'}).then(content => {});
+
+
+
+
+##### Parameters
+
+- **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.
+
+
+
+
 ##### Returns
 
 
@@ -35,7 +62,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'], {'ignore': [], 'parser': 'dox', 'layout': 'markdown'}).then(content => {});
+    parseInputs(['src/*.js'], {'ignore': [], 'parser': 'dox', 'layout': 'markdown'}).then(content => {});
 
 
 

lib/doxdox.js

@@ -6,7 +6,10 @@ const globby = require('globby');
 
 const loaders = require('./loaders');
 
-const formatPathsArrayToIgnore = require('./utils').formatPathsArrayToIgnore;
+const {
+    formatPathsArrayToIgnore,
+    setConfigDefaults
+} = require('./utils');
 
 const DEFAULT_IGNORE_PATHS = [
     '!./{node_modules,bower_components,test,tests}/**',
@@ -17,9 +20,9 @@ const DEFAULT_IGNORE_PATHS = [
 const REPLACE_FILENAME_REGEXP = new RegExp(`^(${process.cwd()}/|./)`);
 
 /**
- * Parse an input file with parser.
+ * Parse a file with custom parser.
  *
- *     parseInput('src/main.js', {'parser': 'dox'}).then(files => {});
+ *     parseFile('src/main.js', {'parser': 'dox'}).then(files => {});
  *
  * @param {String} input File to parse.
  * @param {Object} config Configuration object.
@@ -28,8 +31,8 @@ const REPLACE_FILENAME_REGEXP = new RegExp(`^(${process.cwd()}/|./)`);
  * @public
  */
 
-const parseInput = (input, config) =>
-    loaders.loadParser(config).then(parser => new Promise((resolve, reject) => {
+const parseFile = (input, config) =>
+    loaders.loadParser(setConfigDefaults(config)).then(parser => new Promise((resolve, reject) => {
 
         fs.readFile(input, 'utf8', (err, data) => {
 
@@ -50,10 +53,31 @@ const parseInput = (input, config) =>
 
     }));
 
+
+/**
+ * Parse array of files, and then render the parsed data through the defined layout plugin.
+ *
+ *     parseFiles(['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
+ * @public
+ */
+
+const parseFiles = (files, config) => loaders.loadPlugin(setConfigDefaults(config)).then(plugin =>
+    Promise.all(files.map(input => parseFile(input, config)))
+        .then(files => plugin(Object.assign({
+            files
+        }, setConfigDefaults(config)))));
+
 /**
  * Parse array of directory globs and/or files, and then render the parsed data through the defined layout plugin.
  *
- *     parseInputs(['src/main.js'], {'ignore': [], 'parser': 'dox', 'layout': 'markdown'}).then(content => {});
+ *     parseInputs(['src/*.js'], {'ignore': [], 'parser': 'dox', 'layout': 'markdown'}).then(content => {});
  *
  * @param {Array} inputs Array of directory globs and/or files.
  * @param {Object} config Configuration object.
@@ -64,17 +88,13 @@ const parseInput = (input, config) =>
  * @public
  */
 
-const parseInputs = (inputs, config) => loaders.loadPlugin(config).then(plugin =>
-        globby(inputs.concat(
-            DEFAULT_IGNORE_PATHS,
-            formatPathsArrayToIgnore(config.ignore)
-        ), {'nodir': true}).then(files =>
-            Promise.all(files.map(input => parseInput(input, config))))
-                .then(files => plugin(Object.assign({
-                    files
-                }, config))));
+const parseInputs = (inputs, config) => globby(inputs.concat(DEFAULT_IGNORE_PATHS,
+    formatPathsArrayToIgnore(setConfigDefaults(config).ignore)
+), {'nodir': true}).then(files => parseFiles(files, config));
+
 
 module.exports = {
-    parseInput,
+    parseFile,
+    parseFiles,
     parseInputs
 };

test/fixtures/doxdox.md

@@ -5,11 +5,11 @@
 ### lib/doxdox.js
 
 
-#### parseInput(input, config) 
+#### parseFile(input, config) 
 
-Parse an input file with parser.
+Parse a file with custom parser.
 
-    parseInput('src/main.js', {'parser': 'dox'}).then(files => {});
+    parseFile('src/main.js', {'parser': 'dox'}).then(files => {});
 
 
 
@@ -23,6 +23,33 @@ Parse an input file with parser.
 
 
 
+##### Returns
+
+
+- `Object`   Promise
+
+
+
+#### parseFiles(inputs, config) 
+
+Parse array of files, and then render the parsed data through the defined layout plugin.
+
+    parseFiles(['src/main.js'], {'ignore': [], 'parser': 'dox', 'layout': 'markdown'}).then(content => {});
+
+
+
+
+##### Parameters
+
+- **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.
+
+
+
+
 ##### Returns
 
 
@@ -34,7 +61,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'], {'ignore': [], 'parser': 'dox', 'layout': 'markdown'}).then(content => {});
+    parseInputs(['src/*.js'], {'ignore': [], 'parser': 'dox', 'layout': 'markdown'}).then(content => {});
 
 
 

test/specs/doxdox.js

@@ -8,14 +8,14 @@ describe('doxdox', () => {
     describe('parseInput', () => {
 
         it('parses input from file', () =>
-            doxdox.parseInput('./lib/doxdox.js', {'parser': 'dox'}));
+            doxdox.parseFile('./lib/doxdox.js', {'parser': 'dox'}));
 
     });
 
     describe('fail to parseInput on missing file', () => {
 
         it('fails to parse input from invalid file', () =>
-            doxdox.parseInput('test.js', {'parser': 'dox'}).catch(err => {
+            doxdox.parseFile('test.js', {'parser': 'dox'}).catch(err => {
 
                 if (err) {
 
@@ -27,6 +27,23 @@ describe('doxdox', () => {
 
     });
 
+    describe('parseFiles', () => {
+
+        it('parses multiple input from array', () =>
+            doxdox.parseFiles(['./lib/doxdox.js'], {
+                'description': '',
+                'ignore': [],
+                'layout': 'markdown',
+                'parser': 'dox',
+                'title': 'Untitled Project'
+            }).then(content => {
+
+                assert.equal(content, fs.readFileSync('./test/fixtures/doxdox.md', 'utf8'));
+
+            }));
+
+    });
+
     describe('parseInputs', () => {
 
         it('parses multiple input from array', () =>