jsdoc-api - npm Package Compare versions

Comparing version 7.0.1 to 7.1.0

package.json

 {
   "name": "jsdoc-api",
   "author": "Lloyd Brookes <[e-mail]>",
-  "version": "7.0.1",
+  "version": "7.1.0",
   "description": "A programmatic interface for jsdoc",
-  "repository": "https://github.com/jsdoc2md/jsdoc-api.git",
+  "repository": "https://github.com/jsdoc2md/jsdoc-api",
   "license": "MIT",
@@ -17,19 +17,18 @@ "keywords": [
   "engines": {
-    "node": ">=14"
+    "node": ">=12.17"
   },
   "scripts": {
     "test": "test-runner --max-file-concurrency 1 test/*.js",
-    "docs": "jsdoc2md -t jsdoc2md/README.hbs index.js lib/*.js > README.md; echo",
-    "cover": "nyc npm test && nyc report --reporter=text-lcov | coveralls"
+    "test:ci": "npm test",
+    "docs": "jsdoc2md -t jsdoc2md/README.hbs index.js lib/*.js > README.md; echo"
   },
   "devDependencies": {
-    "collect-json": "^1.0.8",
-    "coveralls": "^3.1.0",
+    "collect-json": "^1.0.9",
+    "coveralls": "^3.1.1",
     "jsdoc-to-markdown": "^7.0.1",
-    "nyc": "^15.1.0",
     "rimraf": "^3.0.2",
-    "test-runner": "^0.8.14"
+    "test-runner": "^0.10.0"
   },
   "dependencies": {
-    "array-back": "^5.0.0",
+    "array-back": "^6.2.0",
     "cache-point": "^2.0.0",
@@ -39,6 +38,6 @@ "collect-all": "^1.0.4",
     "fs-then-native": "^2.0.0",
-    "jsdoc": "^3.6.6",
+    "jsdoc": "^3.6.7",
     "object-to-spawn-args": "^2.0.1",
     "temp-path": "^1.0.0",
-    "walk-back": "^5.0.0"
+    "walk-back": "^5.1.0"
   },
@@ -45,0 +44,0 @@ "standard": {

README.md

@@ -5,6 +5,5 @@ [![view on npm](https://badgen.net/npm/v/jsdoc-api)](https://www.npmjs.org/package/jsdoc-api)
 [![Gihub package dependents](https://badgen.net/github/dependents-pkg/jsdoc2md/jsdoc-api)](https://github.com/jsdoc2md/jsdoc-api/network/dependents?dependent_type=PACKAGE)
-[![Build Status](https://travis-ci.org/jsdoc2md/jsdoc-api.svg?branch=master)](https://travis-ci.org/jsdoc2md/jsdoc-api)
+[![Node.js CI](https://github.com/jsdoc2md/jsdoc-api/actions/workflows/node.js.yml/badge.svg)](https://github.com/jsdoc2md/jsdoc-api/actions/workflows/node.js.yml)
 [![Coverage Status](https://coveralls.io/repos/github/jsdoc2md/jsdoc-api/badge.svg)](https://coveralls.io/github/jsdoc2md/jsdoc-api)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)
-[![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)
 
@@ -78,3 +77,3 @@ # jsdoc-api
 
-**Kind**: static property of [<code>jsdoc-api</code>](#module_jsdoc-api)
+**Kind**: static property of [<code>jsdoc-api</code>](#module_jsdoc-api)  
 <a name="module_jsdoc-api.explainSync"></a>
@@ -85,8 +84,8 @@
 
-**Kind**: static method of [<code>jsdoc-api</code>](#module_jsdoc-api)
-**Prerequisite**: Requires node v0.12 or above
+**Kind**: static method of [<code>jsdoc-api</code>](#module_jsdoc-api)  
+**Prerequisite**: Requires node v0.12 or above  
 
 | Param | Type |
 | --- | --- |
-| [options] | [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions) |
+| [options] | [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions) | 
 
@@ -98,8 +97,8 @@ <a name="module_jsdoc-api.explain"></a>
 
-**Kind**: static method of [<code>jsdoc-api</code>](#module_jsdoc-api)
-**Fulfil**: <code>object[]</code> - jsdoc explain output
+**Kind**: static method of [<code>jsdoc-api</code>](#module_jsdoc-api)  
+**Fulfil**: <code>object[]</code> - jsdoc explain output  
 
 | Param | Type |
 | --- | --- |
-| [options] | [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions) |
+| [options] | [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions) | 
 
@@ -111,10 +110,10 @@ <a name="module_jsdoc-api.renderSync"></a>
 
-**Kind**: static method of [<code>jsdoc-api</code>](#module_jsdoc-api)
-**Prerequisite**: Requires node v0.12 or above
+**Kind**: static method of [<code>jsdoc-api</code>](#module_jsdoc-api)  
+**Prerequisite**: Requires node v0.12 or above  
 
 | Param | Type |
 | --- | --- |
-| [options] | [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions) |
+| [options] | [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions) | 
 
-**Example**
+**Example**  
 ```js
@@ -128,3 +127,3 @@ jsdoc.renderSync({ files: 'lib/*', destination: 'api-docs' })
 
-**Kind**: inner class of [<code>jsdoc-api</code>](#module_jsdoc-api)
+**Kind**: inner class of [<code>jsdoc-api</code>](#module_jsdoc-api)  
 
@@ -153,3 +152,3 @@ * [~JsdocOptions](#module_jsdoc-api..JsdocOptions)
 
-**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
+**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions+source"></a>
@@ -160,3 +159,3 @@
 
-**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
+**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions+cache"></a>
@@ -167,3 +166,3 @@
 
-**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
+**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions+access"></a>
@@ -174,3 +173,3 @@
 
-**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
+**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions+configure"></a>
@@ -181,3 +180,3 @@
 
-**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
+**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions+destination"></a>
@@ -188,3 +187,3 @@
 
-**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
+**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions+encoding"></a>
@@ -195,3 +194,3 @@
 
-**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
+**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions+private"></a>
@@ -202,3 +201,3 @@
 
-**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
+**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions+package"></a>
@@ -209,3 +208,3 @@
 
-**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
+**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions+pedantic"></a>
@@ -216,3 +215,3 @@
 
-**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
+**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions+query"></a>
@@ -223,3 +222,3 @@
 
-**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
+**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions+recurse"></a>
@@ -230,3 +229,3 @@
 
-**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
+**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions+readme"></a>
@@ -237,3 +236,3 @@
 
-**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
+**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions+template"></a>
@@ -244,3 +243,3 @@
 
-**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
+**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 <a name="module_jsdoc-api..JsdocOptions+tutorials"></a>
@@ -251,6 +250,8 @@
 
-**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
+**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)  
 
 * * *
 
-&copy; 2015-21 Lloyd Brookes \<[e-mail]\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).
+&copy; 2015-21 [Lloyd Brookes](https://github.com/75lb) \<[e-mail]\>.
+
+Tested by [test-runner](https://github.com/test-runner-js/test-runner). Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).

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

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

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

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

5

decreased by-16.67%

Number of lines in readme file

237

increased by0.42%

Worsened metrics

Total package byte prevSize

25293

decreased by-0.35%

Number of downloads

157177

decreased by-32.85%

Dependency changes

• + Addedarray-back@6.2.2(transitive)

• Updatedarray-back@^6.2.0

• Updatedjsdoc@^3.6.7

• Updatedwalk-back@^5.1.0