jsdoc-api - npm Package Compare versions

Comparing version 5.0.1 to 5.0.2

index.js

@@ -1,3 +0,1 @@
-'use strict'
-
 /**
@@ -4,0 +2,0 @@ * @module jsdoc-api

lib/explain-sync.js

@@ -1,2 +0,1 @@
-'use strict'
 const JsdocCommand = require('./jsdoc-command')
@@ -3,0 +2,0 @@

lib/explain.js

@@ -1,2 +0,1 @@
-'use strict'
 const JsdocCommand = require('./jsdoc-command')
@@ -13,3 +12,2 @@
 class Explain extends JsdocCommand {
-
   getOutput (err) {
@@ -54,3 +52,2 @@ if (err) return Promise.reject(err)
           }
-
         } catch (err) {
@@ -57,0 +54,0 @@ reject(err)

lib/jsdoc-command.js

@@ -1,2 +0,1 @@
-'use strict'
 const arrayify = require('array-back')
@@ -3,0 +2,0 @@ const path = require('path')

lib/render-sync.js

@@ -1,2 +0,1 @@
-'use strict'
 const JsdocCommand = require('./jsdoc-command')
@@ -3,0 +2,0 @@

lib/temp-file.js

@@ -1,2 +0,1 @@
-'use strict'
 const fs = require('fs')
@@ -3,0 +2,0 @@ const getTempPath = require('temp-path')

package.json

 {
   "name": "jsdoc-api",
   "author": "Lloyd Brookes <[e-mail]>",
-  "version": "5.0.1",
+  "version": "5.0.2",
   "description": "A programmatic interface for jsdoc",
@@ -20,12 +20,13 @@ "repository": "https://github.com/jsdoc2md/jsdoc-api.git",
   "scripts": {
-    "test": "test-runner test/*.js",
-    "docs": "jsdoc2md -t jsdoc2md/README.hbs lib/*.js > README.md; echo",
-    "cover": "istanbul cover ./node_modules/.bin/test-runner test/*.js && cat coverage/lcov.info | ./node_modules/.bin/coveralls && rm -rf coverage; echo"
+    "test": "test-runner test/explain.js test/explain-sync.js test/render-sync.js && test-runner test/caching.js",
+    "docs": "jsdoc2md -t jsdoc2md/README.hbs index.js lib/*.js > README.md; echo",
+    "cover": "nyc npm test && nyc report --reporter=text-lcov | coveralls"
   },
   "devDependencies": {
     "collect-json": "^1.0.8",
-    "coveralls": "^3.0.3",
-    "jsdoc-to-markdown": "^4.0.1",
+    "coveralls": "^3.0.4",
+    "jsdoc-to-markdown": "^5.0.0",
+    "nyc": "^14.1.1",
     "rimraf": "^2.6.3",
-    "test-runner": "~0.5.1"
+    "test-runner": "~0.6.0"
   },
@@ -38,3 +39,3 @@ "dependencies": {
     "fs-then-native": "^2.0.0",
-    "jsdoc": "^3.6.1",
+    "jsdoc": "^3.6.2",
     "object-to-spawn-args": "^1.1.1",
@@ -41,0 +42,0 @@ "temp-path": "^1.0.0",

README.md

@@ -5,3 +5,3 @@ [![view on npm](http://img.shields.io/npm/v/jsdoc-api.svg)](https://www.npmjs.org/package/jsdoc-api)
 [![Coverage Status](https://coveralls.io/repos/jsdoc2md/jsdoc-api/badge.svg?branch=master&service=github)](https://coveralls.io/github/jsdoc2md/jsdoc-api?branch=master)
-[![Dependency Status](https://david-dm.org/jsdoc2md/jsdoc-api.svg)](https://david-dm.org/jsdoc2md/jsdoc-api)
+[![Dependency Status](https://badgen.net/david/dep/jsdoc2md/jsdoc-api)](https://david-dm.org/jsdoc2md/jsdoc-api)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)
@@ -56,17 +56,17 @@ [![Join the chat at https://gitter.im/jsdoc2md/jsdoc2md](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jsdoc2md/jsdoc2md?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
         * [~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>
-            * [.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>
-            * [.destination](#module_jsdoc-api..JsdocOptions.JsdocOptions+destination) : <code>string</code>
-            * [.encoding](#module_jsdoc-api..JsdocOptions.JsdocOptions+encoding) : <code>string</code>
-            * [.private](#module_jsdoc-api..JsdocOptions.JsdocOptions+private) : <code>boolean</code>
-            * [.package](#module_jsdoc-api..JsdocOptions.JsdocOptions+package) : <code>string</code>
-            * [.pedantic](#module_jsdoc-api..JsdocOptions.JsdocOptions+pedantic) : <code>boolean</code>
-            * [.query](#module_jsdoc-api..JsdocOptions.JsdocOptions+query) : <code>string</code>
-            * [.recurse](#module_jsdoc-api..JsdocOptions.JsdocOptions+recurse) : <code>boolean</code>
-            * [.readme](#module_jsdoc-api..JsdocOptions.JsdocOptions+readme) : <code>string</code>
-            * [.template](#module_jsdoc-api..JsdocOptions.JsdocOptions+template) : <code>string</code>
-            * [.tutorials](#module_jsdoc-api..JsdocOptions.JsdocOptions+tutorials) : <code>string</code>
+            * [.files](#module_jsdoc-api..JsdocOptions+files) : <code>string</code> \| <code>Array.&lt;string&gt;</code>
+            * [.source](#module_jsdoc-api..JsdocOptions+source) : <code>string</code>
+            * [.cache](#module_jsdoc-api..JsdocOptions+cache) : <code>boolean</code>
+            * [.access](#module_jsdoc-api..JsdocOptions+access) : <code>string</code>
+            * [.configure](#module_jsdoc-api..JsdocOptions+configure) : <code>string</code>
+            * [.destination](#module_jsdoc-api..JsdocOptions+destination) : <code>string</code>
+            * [.encoding](#module_jsdoc-api..JsdocOptions+encoding) : <code>string</code>
+            * [.private](#module_jsdoc-api..JsdocOptions+private) : <code>boolean</code>
+            * [.package](#module_jsdoc-api..JsdocOptions+package) : <code>string</code>
+            * [.pedantic](#module_jsdoc-api..JsdocOptions+pedantic) : <code>boolean</code>
+            * [.query](#module_jsdoc-api..JsdocOptions+query) : <code>string</code>
+            * [.recurse](#module_jsdoc-api..JsdocOptions+recurse) : <code>boolean</code>
+            * [.readme](#module_jsdoc-api..JsdocOptions+readme) : <code>string</code>
+            * [.template](#module_jsdoc-api..JsdocOptions+template) : <code>string</code>
+            * [.tutorials](#module_jsdoc-api..JsdocOptions+tutorials) : <code>string</code>
 
@@ -127,19 +127,19 @@ <a name="module_jsdoc-api.cache"></a>
 * [~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>
-    * [.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>
-    * [.destination](#module_jsdoc-api..JsdocOptions.JsdocOptions+destination) : <code>string</code>
-    * [.encoding](#module_jsdoc-api..JsdocOptions.JsdocOptions+encoding) : <code>string</code>
-    * [.private](#module_jsdoc-api..JsdocOptions.JsdocOptions+private) : <code>boolean</code>
-    * [.package](#module_jsdoc-api..JsdocOptions.JsdocOptions+package) : <code>string</code>
-    * [.pedantic](#module_jsdoc-api..JsdocOptions.JsdocOptions+pedantic) : <code>boolean</code>
-    * [.query](#module_jsdoc-api..JsdocOptions.JsdocOptions+query) : <code>string</code>
-    * [.recurse](#module_jsdoc-api..JsdocOptions.JsdocOptions+recurse) : <code>boolean</code>
-    * [.readme](#module_jsdoc-api..JsdocOptions.JsdocOptions+readme) : <code>string</code>
-    * [.template](#module_jsdoc-api..JsdocOptions.JsdocOptions+template) : <code>string</code>
-    * [.tutorials](#module_jsdoc-api..JsdocOptions.JsdocOptions+tutorials) : <code>string</code>
+    * [.files](#module_jsdoc-api..JsdocOptions+files) : <code>string</code> \| <code>Array.&lt;string&gt;</code>
+    * [.source](#module_jsdoc-api..JsdocOptions+source) : <code>string</code>
+    * [.cache](#module_jsdoc-api..JsdocOptions+cache) : <code>boolean</code>
+    * [.access](#module_jsdoc-api..JsdocOptions+access) : <code>string</code>
+    * [.configure](#module_jsdoc-api..JsdocOptions+configure) : <code>string</code>
+    * [.destination](#module_jsdoc-api..JsdocOptions+destination) : <code>string</code>
+    * [.encoding](#module_jsdoc-api..JsdocOptions+encoding) : <code>string</code>
+    * [.private](#module_jsdoc-api..JsdocOptions+private) : <code>boolean</code>
+    * [.package](#module_jsdoc-api..JsdocOptions+package) : <code>string</code>
+    * [.pedantic](#module_jsdoc-api..JsdocOptions+pedantic) : <code>boolean</code>
+    * [.query](#module_jsdoc-api..JsdocOptions+query) : <code>string</code>
+    * [.recurse](#module_jsdoc-api..JsdocOptions+recurse) : <code>boolean</code>
+    * [.readme](#module_jsdoc-api..JsdocOptions+readme) : <code>string</code>
+    * [.template](#module_jsdoc-api..JsdocOptions+template) : <code>string</code>
+    * [.tutorials](#module_jsdoc-api..JsdocOptions+tutorials) : <code>string</code>
 
-<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+files"></a>
+<a name="module_jsdoc-api..JsdocOptions+files"></a>
 
@@ -150,3 +150,3 @@ #### options.files : <code>string</code> \| <code>Array.&lt;string&gt;</code>
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
-<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+source"></a>
+<a name="module_jsdoc-api..JsdocOptions+source"></a>
 
@@ -157,3 +157,3 @@ #### options.source : <code>string</code>
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
-<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+cache"></a>
+<a name="module_jsdoc-api..JsdocOptions+cache"></a>
 
@@ -164,3 +164,3 @@ #### options.cache : <code>boolean</code>
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
-<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+access"></a>
+<a name="module_jsdoc-api..JsdocOptions+access"></a>
 
@@ -171,3 +171,3 @@ #### options.access : <code>string</code>
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
-<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+configure"></a>
+<a name="module_jsdoc-api..JsdocOptions+configure"></a>
 
@@ -178,3 +178,3 @@ #### options.configure : <code>string</code>
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
-<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+destination"></a>
+<a name="module_jsdoc-api..JsdocOptions+destination"></a>
 
@@ -185,3 +185,3 @@ #### options.destination : <code>string</code>
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
-<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+encoding"></a>
+<a name="module_jsdoc-api..JsdocOptions+encoding"></a>
 
@@ -192,3 +192,3 @@ #### options.encoding : <code>string</code>
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
-<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+private"></a>
+<a name="module_jsdoc-api..JsdocOptions+private"></a>
 
@@ -199,3 +199,3 @@ #### options.private : <code>boolean</code>
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
-<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+package"></a>
+<a name="module_jsdoc-api..JsdocOptions+package"></a>
 
@@ -206,3 +206,3 @@ #### options.package : <code>string</code>
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
-<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+pedantic"></a>
+<a name="module_jsdoc-api..JsdocOptions+pedantic"></a>
 
@@ -213,3 +213,3 @@ #### options.pedantic : <code>boolean</code>
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
-<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+query"></a>
+<a name="module_jsdoc-api..JsdocOptions+query"></a>
 
@@ -220,3 +220,3 @@ #### options.query : <code>string</code>
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
-<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+recurse"></a>
+<a name="module_jsdoc-api..JsdocOptions+recurse"></a>
 
@@ -227,3 +227,3 @@ #### options.recurse : <code>boolean</code>
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
-<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+readme"></a>
+<a name="module_jsdoc-api..JsdocOptions+readme"></a>
 
@@ -234,3 +234,3 @@ #### options.readme : <code>string</code>
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
-<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+template"></a>
+<a name="module_jsdoc-api..JsdocOptions+template"></a>
 
@@ -241,3 +241,3 @@ #### options.template : <code>string</code>
 **Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
-<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+tutorials"></a>
+<a name="module_jsdoc-api..JsdocOptions+tutorials"></a>
 
@@ -244,0 +244,0 @@ #### options.tutorials : <code>string</code>

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of medium supply chain risk alerts

3

decreased by-25%

Worsened metrics

Total package byte prevSize

25246

decreased by-2.45%

Dev dependency count

6

increased by20%

Lines of code

398

decreased by-1.49%

Dependency changes

• Updatedjsdoc@^3.6.2