jsdoc-api - npm Package Compare versions

Comparing version 4.0.1 to 4.0.2

lib/explain.js

@@ -16,4 +16,3 @@ 'use strict'
     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))
@@ -20,0 +19,0 @@ } else {

package.json

 {
   "name": "jsdoc-api",
   "author": "Lloyd Brookes <[e-mail]>",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "description": "A programmatic interface for jsdoc",
   "repository": "https://github.com/jsdoc2md/jsdoc-api.git",
   "license": "MIT",
-  "main": "lib/jsdoc-api",
   "keywords": [
@@ -10,0 +9,0 @@ "jsdoc",

test/caching.js

@@ -45,1 +45,24 @@ 'use strict'
 })
+
+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')
+    })
+  })
+})

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

1073016

decreased by-32.62%

Number of package files

51

decreased by-5.56%

Lines of code

1513

decreased by-11.83%

No dependency changes