allows options.source also to be an array of strings

README.md

@@ -53,7 +53,7 @@ A programmatic interface for [jsdoc3](https://github.com/jsdoc3/jsdoc) with a fe
     * _inner_
         * [~JsdocOptions](#module_jsdoc-api..JsdocOptions)
             * [.files](#module_jsdoc-api..JsdocOptions.JsdocOptions+files) : <code>string</code> \| <code>Array.&lt;string&gt;</code>
-            * [.source](#module_jsdoc-api..JsdocOptions.JsdocOptions+source) : <code>string</code>
+            * [.source](#module_jsdoc-api..JsdocOptions.JsdocOptions+source) : <code>string</code> \| <code>Array.&lt;string&gt;</code>
             * [.cache](#module_jsdoc-api..JsdocOptions.JsdocOptions+cache) : <code>boolean</code>
             * [.access](#module_jsdoc-api..JsdocOptions.JsdocOptions+access) : <code>string</code>
             * [.configure](#module_jsdoc-api..JsdocOptions.JsdocOptions+configure) : <code>string</code>
@@ -123,7 +123,7 @@ The jsdoc options, common for all operations.
 
 * [~JsdocOptions](#module_jsdoc-api..JsdocOptions)
     * [.files](#module_jsdoc-api..JsdocOptions.JsdocOptions+files) : <code>string</code> \| <code>Array.&lt;string&gt;</code>
-    * [.source](#module_jsdoc-api..JsdocOptions.JsdocOptions+source) : <code>string</code>
+    * [.source](#module_jsdoc-api..JsdocOptions.JsdocOptions+source) : <code>string</code> \| <code>Array.&lt;string&gt;</code>
     * [.cache](#module_jsdoc-api..JsdocOptions.JsdocOptions+cache) : <code>boolean</code>
     * [.access](#module_jsdoc-api..JsdocOptions.JsdocOptions+access) : <code>string</code>
     * [.configure](#module_jsdoc-api..JsdocOptions.JsdocOptions+configure) : <code>string</code>
@@ -146,8 +146,8 @@ One or more filenames to process. Either this or `source` must be supplied.
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions.JsdocOptions+source"></a>
 
-#### options.source : <code>string</code>
-A string containing source code to process. Either this or `source` must be supplied.
+#### options.source : <code>string</code> \| <code>Array.&lt;string&gt;</code>
+A string or array of strings containing source code to process. Either this or `files` must be supplied.
 
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions.JsdocOptions+cache"></a>

index.js

@@ -78,8 +78,8 @@ class JsdocOptions {
     this.files = arrayify(options.files)
 
     /**
-     * A string containing source code to process. Either this or `source` must be supplied.
-     * @type {string}
+     * A string or array of strings containing source code to process. Either this or `files` must be supplied.
+     * @type {string|string[]}
      */
     this.source = options.source
 

lib/explain-sync.js

@@ -1,5 +1,6 @@
 'use strict'
 const JsdocCommand = require('./jsdoc-command')
+const FileSet = require('file-set')
 
 /**
  * @static
@@ -23,7 +24,7 @@ class ExplainSync extends JsdocCommand {
     const toSpawnArgs = require('object-to-spawn-args')
     const jsdocArgs = toSpawnArgs(this.jsdocOptions)
       .concat([ '-X' ])
-      .concat(this.options.source ? this.tempFile.path : this.inputFileSet.files)
+      .concat(this.options.source ? new FileSet(this.tempFiles.map(tempFile => tempFile.path)).files : this.inputFileSet.files)
 
     jsdocArgs.unshift(this.jsdocPath)
 

lib/explain.js

@@ -1,5 +1,6 @@
 'use strict'
 const JsdocCommand = require('./jsdoc-command')
+const FileSet = require('file-set')
 
 /**
  * @module explain
@@ -34,7 +35,7 @@ class Explain extends JsdocCommand {
       const toSpawnArgs = require('object-to-spawn-args')
       const jsdocArgs = toSpawnArgs(this.jsdocOptions)
         .concat([ '-X' ])
-        .concat(this.options.source ? this.tempFile.path : this.inputFileSet.files)
+        .concat(this.options.source ? new FileSet(this.tempFiles.map(tempFile => tempFile.path)).files : this.inputFileSet.files)
       jsdocArgs.unshift(this.jsdocPath)
 
       const spawn = require('child_process').spawn

lib/jsdoc-command.js

@@ -16,9 +16,14 @@ class JsdocCommand {
     options.files = arrayify(options.files)
 
     this.cache = cache
-    this.tempFile = null
+    this.tempFiles = null
     const TempFile = require('./temp-file')
-    if (options.source) this.tempFile = new TempFile(options.source)
+    if (options.source) {
+      // make sure `options.source` is an array
+      if (!Array.isArray(options.source)) options.source = [options.source]
+
+      this.tempFiles = options.source.map(source => new TempFile(source))
+    }
 
     const jsdocOptions = Object.assign({}, options)
     delete jsdocOptions.files
@@ -94,8 +99,8 @@ class JsdocCommand {
    * perform post-execution cleanup
    */
   postExecute () {
-    if (this.tempFile) {
-      this.tempFile.delete()
+    if (this.tempFiles) {
+      this.tempFiles.forEach(tempFile => tempFile.delete())
     }
   }
 

lib/render-sync.js

@@ -9,7 +9,7 @@ class RenderSync extends JsdocCommand {
     if (err) throw err
     const toSpawnArgs = require('object-to-spawn-args')
     const jsdocArgs = toSpawnArgs(this.jsdocOptions)
-      .concat(this.options.source ? this.tempFile.path : this.options.files)
+      .concat(this.options.source ? this.tempFiles.map(tempFile => tempFile.path) : this.options.files)
 
     jsdocArgs.unshift(this.jsdocPath)
 

test/render-sync.js

@@ -25,3 +25,33 @@ runner.test('.renderSync({ source, destination })', function () {
     fs.statSync('./tmp/renderSync/out/index.html')
   })
 })
+
+runner.test('.renderSync({ source[], destination })', function () {
+  Fixture.createTmpFolder('tmp/renderSync')
+  const sources = [
+    `import Foo from "foo"
+     /**
+      * FooPrime is some child class
+      * @class
+      * @param {Object} - an input
+      * @extends Foo
+      */
+     function FooPrime() {}
+     export default FooPrime
+  `,
+    `import Foo from "foo"
+    /**
+     * FooSecond is some other child class
+     * @class
+     * @param {Object} - an input
+     * @extends Foo
+     */
+    function FooSecond() {}
+    export default FooSecond
+  `]
+  jsdoc.renderSync({ source: sources, destination: 'tmp/renderSync/out' })
+  a.doesNotThrow(function () {
+    fs.statSync('./tmp/renderSync/out/FooPrime.html')
+    fs.statSync('./tmp/renderSync/out/FooSecond.html')
+  })
+})