jsdoc-to-markdown - npm Package Compare versions

Comparing version 1.3.6 to 1.3.7

bin/cli.js

@@ -5,2 +5,3 @@ #!/usr/bin/env node
 var commandLineArgs = require('command-line-args')
+var commandLineUsage = require('command-line-usage')
 var jsdoc2md = require('../')
@@ -30,7 +31,6 @@ var domain = require('domain')
 
-var cli = commandLineArgs(cliData.definitions)
-var usage = cli.getUsage(cliData.usage)
+var usage = commandLineUsage(cliData.usage)
 
 try {
-  var argv = cli.parse()
+  var argv = commandLineArgs(cliData.definitions)
 } catch (err) {
@@ -37,0 +37,0 @@ halt(err)

lib/cli-data.js

@@ -36,8 +36,40 @@ 'use strict'
 
-module.exports = {
-  definitions: definitions,
-  usage: {
-    title: 'jsdoc-to-markdown',
-    description: 'Markdown API Documentation generator.',
-    footer: [
+var usageSections = [
+  {
+    header: 'jsdoc-to-markdown',
+    content: 'Markdown API Documentation generator.'
+  },
+  {
+    header: 'Synopsis',
+    content: [
+      '$ jsdoc2md [options] [bold]{--src} [underline]{file} ...',
+      '$ jsdoc2md [bold]{--help}',
+      '$ jsdoc2md [bold]{--config}',
+      '$ jsdoc2md [bold]{--stats} [underline]{file} ...',
+      '$ jsdoc2md [bold]{--json} [underline]{file} ...'
+    ]
+  },
+  {
+    header: 'General options',
+    optionList: definitions,
+    group: 'jsdoc2md'
+  },
+  {
+    header: 'jsdoc-parse options',
+    content: 'These options affect how the javascript source is parsed.'
+  },
+  {
+    optionList: definitions,
+    group: 'jsdocParse',
+  },
+  {
+    header: 'dmd options',
+    content: 'These options affect how the markdown output looks.'
+  },
+  {
+    optionList: definitions,
+    group: 'dmd'
+  },
+  {
+    content: [
       {
@@ -53,25 +85,7 @@ one: 'Project repositories:',
       }
-    ],
-    synopsis: [
-      '$ jsdoc2md [options] [bold]{--src} [underline]{file} ...',
-      '$ jsdoc2md [bold]{--help}',
-      '$ jsdoc2md [bold]{--config}',
-      '$ jsdoc2md [bold]{--stats} [underline]{file} ...',
-      '$ jsdoc2md [bold]{--json} [underline]{file} ...'
-    ],
-    groups: {
-      jsdoc2md: {
-        title: 'jsdoc2md',
-        description: 'General options.'
-      },
-      jsdocParse: {
-        title: 'jsdoc-parse',
-        description: 'These options affect how the javascript source is parsed.'
-      },
-      dmd: {
-        title: 'dmd',
-        description: 'These options affect how the markdown output looks.'
-      }
-    }
+    ]
   }
-}
+]
+
+exports.definitions = definitions
+exports.usage = usageSections

package.json

 {
   "name": "jsdoc-to-markdown",
   "author": "Lloyd Brookes",
-  "version": "1.3.6",
+  "version": "1.3.7",
   "description": "jsdoc-annotated source in, markdown API docs out.",
@@ -33,5 +33,6 @@ "repository": "https://github.com/jsdoc2md/jsdoc-to-markdown",
     "ansi-escape-sequences": "^2.2.2",
-    "command-line-args": "^2.1.6",
+    "command-line-args": "^3.0.0",
+    "command-line-usage": "^3.0.1",
     "config-master": "^2.0.2",
-    "dmd": "^1.3.11",
+    "dmd": "^1.4.1",
     "jsdoc-parse": "^1.2.7",
@@ -38,0 +39,0 @@ "object-tools": "^2.0.6",

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

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

28759

increased by287.07%

Number of package files

6

increased by20%

Lines of code

193

increased by7.22%

Number of medium quality alerts

0

decreased by-100%

Number of lines in readme file

434

increased byInfinity%

Worsened metrics

Dependency count

8

increased by14.29%

Dependency changes

• + Addedcommand-line-usage@^3.0.1

• Updatedcommand-line-args@^3.0.0

• Updateddmd@^1.4.1