jsdoc-to-markdown - npm Package Compare versions

Comparing version 4.0.1 to 5.0.0-node12.1

bin/cli.js

 #!/usr/bin/env node
-'use strict'
 const tool = require('command-line-tool')
@@ -4,0 +3,0 @@ const version = require('../package').version

docs/API.md

@@ -149,2 +149,1 @@ <a name="module_jsdoc-to-markdown"></a>
 
-

lib/cli-data.js

@@ -1,3 +0,1 @@
-'use strict'
-
 /* generation options */
@@ -4,0 +2,0 @@ let jsdocDefinitions = [

lib/dmd-options.js

@@ -1,3 +0,1 @@
-'use strict'
-
 /**
@@ -4,0 +2,0 @@ * @typicalname options

lib/jsdoc-options.js

@@ -1,3 +0,1 @@
-'use strict'
-
 class JsdocOptions {
@@ -4,0 +2,0 @@ constructor (options) {

package.json

 {
   "name": "jsdoc-to-markdown",
   "author": "Lloyd Brookes",
-  "version": "4.0.1",
+  "version": "5.0.0-node12.1",
   "description": "Generates markdown API documentation from jsdoc annotated source code",
   "repository": "https://github.com/jsdoc2md/jsdoc-to-markdown",
-  "main": "lib/jsdoc-to-markdown.js",
   "bin": {
@@ -12,3 +11,3 @@ "jsdoc2md": "bin/cli.js"
   "engines": {
-    "node": ">=4.0.0"
+    "node": ">=8.0.0"
   },
@@ -18,3 +17,3 @@ "license": "MIT",
     "test": "test-runner test/*.js",
-    "docs": "node bin/cli.js lib/*.js --heading-depth 1 --template jsdoc2md/API.hbs > docs/API.md; echo ",
+    "docs": "node bin/cli.js --heading-depth 1 index.js > docs/API.md",
     "cover": "istanbul cover ./node_modules/.bin/test-runner test/*.js && cat coverage/lcov.info | ./node_modules/.bin/coveralls && rm -rf coverage; echo"
@@ -32,13 +31,13 @@ },
   "dependencies": {
-    "array-back": "^2.0.0",
+    "array-back": "^3.1.0",
     "command-line-tool": "^0.8.0",
     "config-master": "^3.1.0",
-    "dmd": "^3.0.10",
-    "jsdoc-api": "^4.0.1",
+    "dmd": "^3.0.13",
+    "jsdoc-api": "^5.0.1",
     "jsdoc-parse": "^3.0.1",
-    "walk-back": "^3.0.0"
+    "walk-back": "^3.0.1"
   },
   "devDependencies": {
-    "coveralls": "^3.0.0",
-    "test-runner": "^0.5.0"
+    "coveralls": "^3.0.3",
+    "test-runner": "^0.6.0"
   },
@@ -45,0 +44,0 @@ "standard": {

README.md

@@ -60,2 +60,2 @@ [![view on npm](http://img.shields.io/npm/v/jsdoc-to-markdown.svg)](https://www.npmjs.org/package/jsdoc-to-markdown)
 
-&copy; 2014-18 Lloyd Brookes <[e-mail]>.
+&copy; 2014-19 Lloyd Brookes <[e-mail]>.

test/async.js

@@ -1,10 +0,9 @@
-'use strict'
-const TestRunner = require('test-runner')
+const Tom = require('test-runner').Tom
 const jsdoc2md = require('../')
 const a = require('assert')
 
-const runner = new TestRunner()
 const inputFile = 'test/fixture/ignore.js'
+const tom = module.exports = new Tom('async')
 
-runner.test('.render({ files })', function () {
+tom.test('.render({ files })', function () {
   return jsdoc2md.render({ files: inputFile })
@@ -14,3 +13,3 @@ .then(result => a.ok(/a visible global/.test(result)))
 
-runner.test('.render({ data })', function () {
+tom.test('.render({ data })', function () {
   const data = [
@@ -49,3 +48,3 @@ {
 
-runner.test('.render({ files, heading-depth: 4 })', function () {
+tom.test('.render({ files, heading-depth: 4 })', function () {
   return jsdoc2md.render({ files: inputFile, 'heading-depth': 4 })
@@ -55,3 +54,3 @@ .then(result => a.ok(/#### visible/.test(result)))
 
-runner.test('.render({ files, param-list-format: list })', function () {
+tom.test('.render({ files, param-list-format: list })', function () {
   const inputFile = 'test/fixture/params.js'
@@ -62,3 +61,3 @@ return jsdoc2md.render({ files: inputFile, 'param-list-format': 'list' })
 
-runner.test('.getTemplateData({ files })', function () {
+tom.test('.getTemplateData({ files })', function () {
   return jsdoc2md.getTemplateData({ files: inputFile })
@@ -68,3 +67,3 @@ .then(result => a.ok(result[0].id))
 
-runner.test('.getJsdocData({ files })', function () {
+tom.test('.getJsdocData({ files })', function () {
   return jsdoc2md.getJsdocData({ files: inputFile })
@@ -74,3 +73,3 @@ .then(result => a.ok(result[0].longname))
 
-runner.test('.render({ files, noCache })', function () {
+tom.test('.render({ files, noCache })', function () {
   return jsdoc2md.render({ files: inputFile, noCache: true })
@@ -80,3 +79,3 @@ .then(result => a.ok(/a visible global/.test(result)))
 
-runner.test('.render({ data, noCache })', function () {
+tom.test('.render({ data, noCache })', function () {
   const data = [
@@ -115,3 +114,3 @@ {
 
-runner.test('.render({ files, heading-depth: 4, noCache })', function () {
+tom.test('.render({ files, heading-depth: 4, noCache })', function () {
   return jsdoc2md.render({ files: inputFile, 'heading-depth': 4, noCache: true })
@@ -121,3 +120,3 @@ .then(result => a.ok(/#### visible/.test(result)))
 
-runner.test('.render({ files, param-list-format: list, noCache })', function () {
+tom.test('.render({ files, param-list-format: list, noCache })', function () {
   const inputFile = 'test/fixture/params.js'
@@ -128,3 +127,3 @@ return jsdoc2md.render({ files: inputFile, 'param-list-format': 'list', noCache: true })
 
-runner.test('.getTemplateData({ files, noCache })', function () {
+tom.test('.getTemplateData({ files, noCache })', function () {
   return jsdoc2md.getTemplateData({ files: inputFile, noCache: true })
@@ -134,3 +133,3 @@ .then(result => a.ok(result[0].id))
 
-runner.test('.getJsdocData({ files, noCache })', function () {
+tom.test('.getJsdocData({ files, noCache })', function () {
   return jsdoc2md.getJsdocData({ files: inputFile, noCache: true })
@@ -140,3 +139,3 @@ .then(result => a.ok(result[0].longname))
 
-runner.test('.getNamepaths()', function () {
+tom.test('.getNamepaths()', function () {
   return jsdoc2md.getNamepaths({ files: 'test/fixture/ignore.js' })
@@ -151,9 +150,9 @@ .then(namepaths => {
 
-runner.test('.clear()', function () {
+tom.test('.clear()', function () {
   return jsdoc2md.clear()
 })
 
-runner.test('.render({ files, send })', function () {
+tom.test('.render({ files, send })', function () {
   return jsdoc2md.render({ files: inputFile, send: true })
     .then(result => a.ok(/a visible global/.test(result)))
 })

test/cli.js

@@ -1,3 +0,2 @@
-'use strict'
-const TestRunner = require('test-runner')
+const Tom = require('test-runner').Tom
 const fs = require('fs')
@@ -7,3 +6,3 @@ const spawn = require('child_process').spawn
 
-const runner = new TestRunner()
+const tom = module.exports = new Tom('cli')
 const inputPath = 'test/fixture/ignore.js'
@@ -17,3 +16,3 @@
 
-runner.test('cli: json option', function () {
+tom.test('cli: json option', function () {
   const outputFile = fs.openSync('tmp-test/ignore.json', 'w')
@@ -20,0 +19,0 @@ return new Promise((resolve, reject) => {

test/sync.js

@@ -1,10 +0,9 @@
-'use strict'
-const TestRunner = require('test-runner')
+const Tom = require('test-runner').Tom
 const jsdoc2md = require('../')
 const a = require('assert')
 
-const runner = new TestRunner()
+const tom = module.exports = new Tom('sync')
 const inputFile = 'test/fixture/ignore.js'
 
-runner.test('.renderSync({ files })', function () {
+tom.test('.renderSync({ files })', function () {
   const result = jsdoc2md.renderSync({ files: inputFile, cache: false })
@@ -14,3 +13,3 @@ a.ok(/a visible global/.test(result))
 
-runner.test('.renderSync({ data })', function () {
+tom.test('.renderSync({ data })', function () {
   const data = [
@@ -49,3 +48,3 @@ {
 
-runner.test('.renderSync({ files, heading-depth: 4 })', function () {
+tom.test('.renderSync({ files, heading-depth: 4 })', function () {
   const result = jsdoc2md.renderSync({ files: inputFile, cache: false, 'heading-depth': 4 })
@@ -55,3 +54,3 @@ a.ok(/#### visible/.test(result))
 
-runner.test('.renderSync({ files }, { param-list-format: list })', function () {
+tom.test('.renderSync({ files }, { param-list-format: list })', function () {
   const inputFile = 'test/fixture/params.js'
@@ -62,3 +61,3 @@ const result = jsdoc2md.renderSync({ files: inputFile, cache: false, 'param-list-format': 'list' })
 
-runner.test('.getTemplateDataSync({ files })', function () {
+tom.test('.getTemplateDataSync({ files })', function () {
   const result = jsdoc2md.getTemplateDataSync({ files: inputFile, cache: false })
@@ -68,5 +67,5 @@ a.ok(result[0].id)
 
-runner.test('.getJsdocDataSync({ files })', function () {
+tom.test('.getJsdocDataSync({ files })', function () {
   const result = jsdoc2md.getJsdocDataSync({ files: inputFile, cache: false })
   a.ok(result[0].longname)
 })

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 v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

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

39604

decreased by-0.69%

Number of package files

16

decreased by-5.88%

Lines of code

731

decreased by-1.08%

Number of low quality alerts

2

increased by100%

Dependency changes

• + Added@babel/helper-string-parser@7.24.8(transitive)

• + Added@babel/helper-validator-identifier@7.24.7(transitive)

• + Added@babel/parser@7.25.6(transitive)

• + Added@babel/types@7.25.6(transitive)

• + Added@types/linkify-it@5.0.0(transitive)

• + Added@types/markdown-it@12.2.3(transitive)

• + Added@types/mdurl@2.0.0(transitive)

• + Addedargparse@2.0.1(transitive)

• + Addedarray-back@4.0.2(transitive)

• + Addedbluebird@3.7.2(transitive)

• + Addedcache-point@1.0.0(transitive)

• + Addedcatharsis@0.9.0(transitive)

• + Addedentities@2.1.0(transitive)

• + Addedescape-string-regexp@2.0.0(transitive)

• + Addedjs2xmlparser@4.0.2(transitive)

• + Addedjsdoc@3.6.11(transitive)

• + Addedjsdoc-api@5.0.4(transitive)

• + Addedklaw@3.0.0(transitive)

• + Addedlinkify-it@3.0.3(transitive)

• + Addedmarkdown-it@12.3.2(transitive)

• + Addedmarkdown-it-anchor@8.6.7(transitive)

• + Addedmarked@4.3.0(transitive)

• + Addedmdurl@1.0.1(transitive)

• + Addedmkdirp@1.0.4(transitive)

• + Addedstrip-json-comments@3.1.1(transitive)

• + Addedto-fast-properties@2.0.0(transitive)

• + Addeduc.micro@1.0.6(transitive)

• + Addedunderscore@1.13.7(transitive)

• + Addedxmlcreate@2.0.4(transitive)

• - Removedbabylon@7.0.0-beta.19(transitive)

• - Removedbluebird@3.5.5(transitive)

• - Removedcatharsis@0.8.11(transitive)

• - Removedescape-string-regexp@1.0.5(transitive)

• - Removedjs2xmlparser@3.0.0(transitive)

• - Removedjsdoc@3.5.5(transitive)

• - Removedjsdoc-api@4.0.3(transitive)

• - Removedklaw@2.0.0(transitive)

• - Removedmkdirp@0.5.6(transitive)

• - Removedstrip-json-comments@2.0.1(transitive)

• - Removedunderscore@1.8.3(transitive)

• - Removedxmlcreate@1.0.2(transitive)

• Updatedarray-back@^3.1.0

• Updateddmd@^3.0.13

• Updatedjsdoc-api@^5.0.1

• Updatedwalk-back@^3.0.1