Disable caching when input is passed via 'source'. Fixes jsdoc2md/jsdoc-to-markdown#147.

Author: 75lb

lib/jsdoc-api.js index.jslib/jsdoc-api.js renamed to index.js

@@ -26,7 +26,7 @@ exports.cache = new Cache({ dir: path.join(require('os').tmpdir(), 'jsdoc-api')
  */
 function explainSync (options) {
   options = new JsdocOptions(options)
-  const ExplainSync = require('./explain-sync')
+  const ExplainSync = require('./lib/explain-sync')
   const command = new ExplainSync(options, exports.cache)
   return command.execute()
 }
@@ -41,7 +41,7 @@ function explainSync (options) {
  */
 function explain (options) {
   options = new JsdocOptions(options)
-  const Explain = require('./explain')
+  const Explain = require('./lib/explain')
   const command = new Explain(options, exports.cache)
   return command.execute()
 }
@@ -57,7 +57,7 @@ function explain (options) {
  */
 function renderSync (options) {
   options = new JsdocOptions(options)
-  const RenderSync = require('./render-sync')
+  const RenderSync = require('./lib/render-sync')
   const command = new RenderSync(options)
   return command.execute()
 }

lib/explain.js

@@ -13,8 +13,7 @@ class Explain extends JsdocCommand {
 
   getOutput (err) {
     if (err) return Promise.reject(err)
-
-    if (this.options.cache) {
+    if (this.options.cache && !this.options.source) {
       return this.readCache().catch(this._runJsdoc.bind(this))
     } else {
       return this._runJsdoc()

package.json

@@ -5,7 +5,6 @@
   "description": "A programmatic interface for jsdoc",
   "repository": "https://github.com/jsdoc2md/jsdoc-api.git",
   "license": "MIT",
-  "main": "lib/jsdoc-api",
   "keywords": [
     "jsdoc",
     "api",

test/caching.js

@@ -42,3 +42,26 @@ runner.test('caching: .explain({ files, cache: true  })', function () {
         })
     })
 })
+
+runner.test('caching: .explain({ source, cache: true  }) - Ensure correct output (#147)', function () {
+  return jsdoc.cache.clear().then(() => {
+    let one = jsdoc.explain({ source: '/**\n * Function one\n */\nfunction one () {}\n', cache: true })
+    let two = jsdoc.explain({ source: '/**\n * Function two\n */\nfunction two () {}\n', cache: true })
+    let three = jsdoc.explain({ source: '/**\n * Function three\n */\nfunction three () {}\n', cache: true })
+    Promise.all([ one, two, three ]).then(output => {
+      a.strictEqual(output[0][0].description, 'Function one')
+      a.strictEqual(output[1][0].description, 'Function two')
+      a.strictEqual(output[2][0].description, 'Function three')
+    })
+
+    /* ensure it works correctly the second time */
+    one = jsdoc.explain({ source: '/**\n * Function one\n */\nfunction one () {}\n', cache: true })
+    two = jsdoc.explain({ source: '/**\n * Function two\n */\nfunction two () {}\n', cache: true })
+    three = jsdoc.explain({ source: '/**\n * Function three\n */\nfunction three () {}\n', cache: true })
+    Promise.all([ one, two, three ]).then(output => {
+      a.strictEqual(output[0][0].description, 'Function one')
+      a.strictEqual(output[1][0].description, 'Function two')
+      a.strictEqual(output[2][0].description, 'Function three')
+    })
+  })
+})