jsdoc-api - npm Package Compare versions

Comparing version 5.0.4 to 6.0.0

index.js

@@ -5,13 +5,4 @@ /**
  */
-exports.explainSync = explainSync
-exports.explain = explain
-exports.renderSync = renderSync
-
 const path = require('path')
 const Cache = require('cache-point')
-/**
- * The [cache-point](https://github.com/75lb/cache-point) instance used when `cache: true` is specified on `.explain()` or `.explainSync()`.
- * @type {external:cache-point}
- */
-exports.cache = new Cache({ dir: path.join(require('os').tmpdir(), 'jsdoc-api') })
 
@@ -170,1 +161,10 @@ /**
  */
+
+ exports.explainSync = explainSync
+ exports.explain = explain
+ exports.renderSync = renderSync
+ /**
+  * The [cache-point](https://github.com/75lb/cache-point) instance used when `cache: true` is specified on `.explain()` or `.explainSync()`.
+  * @type {external:cache-point}
+  */
+ exports.cache = new Cache({ dir: path.join(require('os').tmpdir(), 'jsdoc-api') })

lib/explain-sync.js

@@ -30,3 +30,6 @@ const JsdocCommand = require('./jsdoc-command')
     const spawnSync = require('child_process').spawnSync
-    const result = spawnSync('node', jsdocArgs, { encoding: 'utf-8' })
+    const result = spawnSync('node', jsdocArgs, {
+      encoding: 'utf-8',
+      maxBuffer: 20 * 1024 * 1024 // 20Mb
+    })
     const explainOutput = this.verifyOutput(result.status, result)
@@ -33,0 +36,0 @@ if (this.options.cache) {

package.json

 {
   "name": "jsdoc-api",
   "author": "Lloyd Brookes <[e-mail]>",
-  "version": "5.0.4",
+  "version": "6.0.0",
   "description": "A programmatic interface for jsdoc",
@@ -17,6 +17,6 @@ "repository": "https://github.com/jsdoc2md/jsdoc-api.git",
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=10"
   },
   "scripts": {
-    "test": "test-runner test/explain.js test/explain-sync.js test/render-sync.js && test-runner test/caching.js",
+    "test": "test-runner --max-file-concurrency 1 test/*.js",
     "docs": "jsdoc2md -t jsdoc2md/README.hbs index.js lib/*.js > README.md; echo",
@@ -27,18 +27,18 @@ "cover": "nyc npm test && nyc report --reporter=text-lcov | coveralls"
     "collect-json": "^1.0.8",
-    "coveralls": "^3.0.7",
-    "jsdoc-to-markdown": "^5.0.2",
-    "nyc": "^14.1.1",
-    "rimraf": "^3.0.0",
-    "test-runner": "~0.6.0"
+    "coveralls": "^3.1.0",
+    "jsdoc-to-markdown": "^5.0.3",
+    "nyc": "^15.0.1",
+    "rimraf": "^3.0.2",
+    "test-runner": "^0.8.13"
   },
   "dependencies": {
-    "array-back": "^4.0.0",
-    "cache-point": "^1.0.0",
+    "array-back": "^4.0.1",
+    "cache-point": "^2.0.0",
     "collect-all": "^1.0.3",
-    "file-set": "^2.0.1",
+    "file-set": "^4.0.1",
     "fs-then-native": "^2.0.0",
-    "jsdoc": "^3.6.3",
-    "object-to-spawn-args": "^1.1.1",
+    "jsdoc": "^3.6.4",
+    "object-to-spawn-args": "^2.0.0",
     "temp-path": "^1.0.0",
-    "walk-back": "^3.0.1"
+    "walk-back": "^4.0.0"
   },
@@ -45,0 +45,0 @@ "standard": {

README.md

@@ -1,6 +0,7 @@
-[![view on npm](http://img.shields.io/npm/v/jsdoc-api.svg)](https://www.npmjs.org/package/jsdoc-api)
-[![npm module downloads](http://img.shields.io/npm/dt/jsdoc-api.svg)](https://www.npmjs.org/package/jsdoc-api)
+[![view on npm](https://badgen.net/npm/v/jsdoc-api)](https://www.npmjs.org/package/jsdoc-api)
+[![npm module downloads](https://badgen.net/npm/dt/jsdoc-api)](https://www.npmjs.org/package/jsdoc-api)
+[![Gihub repo dependents](https://badgen.net/github/dependents-repo/jsdoc2md/jsdoc-api)](https://github.com/jsdoc2md/jsdoc-api/network/dependents?dependent_type=REPOSITORY)
+[![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)
-[![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://badgen.net/david/dep/jsdoc2md/jsdoc-api)](https://david-dm.org/jsdoc2md/jsdoc-api)
+[![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)
@@ -234,2 +235,2 @@ [![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)
 
-&copy; 2015-19 Lloyd Brookes \<[e-mail]\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).
+&copy; 2015-20 Lloyd Brookes \<[e-mail]\>. 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

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

Improved metrics

Total package byte prevSize

25432

increased by0.74%

Lines of code

401

increased by0.75%

Number of lines in readme file

236

increased by0.43%

Dependency changes

• + Addedarray-back@5.0.0(transitive)

• + Addedcache-point@2.0.0(transitive)

• + Addedfile-set@4.0.2(transitive)

• + Addedobject-to-spawn-args@2.0.1(transitive)

• + Addedwalk-back@4.0.0(transitive)

• - Removedarray-back@2.0.0(transitive)

• - Removedcache-point@1.0.0(transitive)

• - Removedfile-set@2.0.1(transitive)

• - Removedobject-to-spawn-args@1.1.1(transitive)

• - Removedwalk-back@3.0.1(transitive)

• Updatedarray-back@^4.0.1

• Updatedcache-point@^2.0.0

• Updatedfile-set@^4.0.1

• Updatedjsdoc@^3.6.4

• Updatedobject-to-spawn-args@^2.0.0

• Updatedwalk-back@^4.0.0