command-line-usage - npm Package Compare versions

Comparing version 5.0.5 to 6.0.0-0

index.js

@@ -1,10 +0,8 @@
-'use strict'
 /**
  * @module command-line-usage
  */
-module.exports = commandLineUsage
 
 /**
  * Generates a usage guide suitable for a command-line app.
- * @param {Section|Section[]} - One of more section objects ({@link module:command-line-usage~content} or {@link module:command-line-usage~optionList}).
+ * @param {Section|Section[]} - One or more section objects ({@link module:command-line-usage~content} or {@link module:command-line-usage~optionList}).
  * @returns {string}
@@ -91,6 +89,6 @@ * @alias module:command-line-usage
  /**
-  * A OptionList section adds a table displaying details of the available options.
+  * An OptionList section adds a table displaying the supplied option definitions.
   * @typedef module:command-line-usage~optionList
   * @property {string} [header] - The section header, always bold and underlined.
-  * @property optionList {OptionDefinition[]} - an array of [option definition](https://github.com/75lb/command-line-args/blob/master/doc/option-definition.md) objects. In addition to the regular definition properties, command-line-usage will look for:
+  * @property optionList {OptionDefinition[]} - An array of [option definition](https://github.com/75lb/command-line-args/blob/master/doc/option-definition.md) objects. In addition to the regular definition properties, command-line-usage will look for:
   *
@@ -109,11 +107,18 @@ * - `description` - a string describing the option.
   *     {
-  *       name: 'help', alias: 'h', description: 'Display this usage guide.'
+  *       name: 'help',
+  *       alias: 'h',
+  *       description: 'Display this usage guide.'
   *     },
   *     {
-  *       name: 'src', description: 'The input files to process',
-  *       multiple: true, defaultOption: true, typeLabel: '{underline file} ...'
+  *       name: 'src',
+  *       description: 'The input files to process',
+  *       multiple: true,
+  *       defaultOption: true,
+  *       typeLabel: '{underline file} ...'
   *     },
   *     {
-  *       name: 'timeout', description: 'Timeout value in ms. This description is needlessly long unless you count testing of the description column maxWidth useful.',
-  *       alias: 't', typeLabel: '{underline ms}'
+  *       name: 'timeout',
+  *       description: 'Timeout value in ms.',
+  *       alias: 't',
+  *       typeLabel: '{underline ms}'
   *     }
@@ -123,1 +128,3 @@ *   ]
   */
+
+module.exports = commandLineUsage

lib/content-section.js

@@ -1,2 +0,1 @@
-'use strict'
 const Section = require('./section')
@@ -3,0 +2,0 @@

lib/content.js

@@ -1,2 +0,1 @@
-'use strict'
 const Table = require('table-layout')
@@ -17,3 +16,3 @@ const chalkFormat = require('./chalk-format')
       /* string content */
-      if (t.isString(content)) {
+      if (typeof content === 'string') {
         const table = new Table({ column: chalkFormat(content) }, {
@@ -20,0 +19,0 @@ padding: defaultPadding,

lib/option-list.js

@@ -1,2 +0,1 @@
-'use strict'
 const Section = require('./section')
@@ -3,0 +2,0 @@ const Table = require('table-layout')

lib/section.js

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

package.json

 {
   "name": "command-line-usage",
   "author": "Lloyd Brookes <[e-mail]>",
-  "version": "5.0.5",
+  "version": "6.0.0-0",
   "description": "Generates command-line usage information",
@@ -9,3 +9,3 @@ "repository": "https://github.com/75lb/command-line-usage.git",
   "files": [
-    "lib",
+    "lib/*.js",
     "index.js"
@@ -20,18 +20,21 @@ ],
   "engines": {
-    "node": ">=4.0.0"
+    "node": ">=8.0.0"
   },
   "scripts": {
     "docs": "jsdoc2md -t jsdoc2md/README.hbs --no-gfm index.js > README.md; echo",
-    "test": "test-runner test/*.js"
+    "test": "test-runner test/*.js",
+    "cover": "nyc npm test && nyc report --reporter=text-lcov | coveralls"
   },
   "dependencies": {
-    "array-back": "^2.0.0",
-    "chalk": "^2.4.1",
-    "table-layout": "^0.4.3",
-    "typical": "^2.6.1"
+    "array-back": "^3.1.0",
+    "chalk": "^2.4.2",
+    "table-layout": "^1.0.0",
+    "typical": "^5.0.0"
   },
   "devDependencies": {
-    "jsdoc-to-markdown": "^4.0.1",
-    "test-runner": "^0.5.0"
+    "coveralls": "^3.0.4",
+    "jsdoc-to-markdown": "^5.0.0",
+    "nyc": "^14.1.1",
+    "test-runner": "^0.6.0"
   }
 }

README.md

 [![view on npm](http://img.shields.io/npm/v/command-line-usage.svg)](https://www.npmjs.org/package/command-line-usage)
 [![npm module downloads](http://img.shields.io/npm/dt/command-line-usage.svg)](https://www.npmjs.org/package/command-line-usage)
 [![Build Status](https://travis-ci.org/75lb/command-line-usage.svg?branch=master)](https://travis-ci.org/75lb/command-line-usage)
-[![Dependency Status](https://david-dm.org/75lb/command-line-usage.svg)](https://david-dm.org/75lb/command-line-usage)
+[![Dependency Status](https://badgen.net/david/dep/75lb/command-line-usage)](https://david-dm.org/75lb/command-line-usage)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)
 
 # command-line-usage
+
 A simple, data-driven module for creating a usage guide.
 
 ## Synopsis
+
 A usage guide is created by first defining an arbitrary number of sections, e.g. a description section, synopsis, option list, examples, footer etc. Each section has an optional header, some content and must be of type <code><a href="#commandlineusagecontent">content</a></code> or <code><a href="#commandlineusageoptionlist">optionList</a></code>. This section data is passed to <code><a href="#commandlineusagesections--string-">commandLineUsage()</a></code> which returns a usage guide.
@@ -124,3 +126,3 @@
 <tr>
-    <td>sections</td><td><code>Section</code> | <code>Array.&lt;Section&gt;</code></td><td><p>One of more section objects (<a href="#module_command-line-usage--commandLineUsage..content">content</a> or <a href="#module_command-line-usage--commandLineUsage..optionList">optionList</a>).</p>
+    <td>sections</td><td><code>Section</code> | <code>Array.&lt;Section&gt;</code></td><td><p>One or more section objects (<a href="#module_command-line-usage--commandLineUsage..content">content</a> or <a href="#module_command-line-usage--commandLineUsage..optionList">optionList</a>).</p>
 </td>
@@ -212,3 +214,3 @@ </tr>  </tbody>
 #### commandLineUsage~optionList
-A OptionList section adds a table displaying details of the available options.
+An OptionList section adds a table displaying the supplied option definitions.
 
@@ -229,3 +231,3 @@ **Kind**: inner typedef of [<code>commandLineUsage</code>](#exp_module_command-line-usage--commandLineUsage)
     </tr><tr>
-    <td>optionList</td><td><code>Array.&lt;OptionDefinition&gt;</code></td><td><p>an array of <a href="https://github.com/75lb/command-line-args/blob/master/doc/option-definition.md">option definition</a> objects. In addition to the regular definition properties, command-line-usage will look for:</p>
+    <td>optionList</td><td><code>Array.&lt;OptionDefinition&gt;</code></td><td><p>An array of <a href="https://github.com/75lb/command-line-args/blob/master/doc/option-definition.md">option definition</a> objects. In addition to the regular definition properties, command-line-usage will look for:</p>
 <ul>
@@ -257,11 +259,18 @@ <li><code>description</code> - a string describing the option.</li>
     {
-      name: 'help', alias: 'h', description: 'Display this usage guide.'
+      name: 'help',
+      alias: 'h',
+      description: 'Display this usage guide.'
     },
     {
-      name: 'src', description: 'The input files to process',
-      multiple: true, defaultOption: true, typeLabel: '{underline file} ...'
+      name: 'src',
+      description: 'The input files to process',
+      multiple: true,
+      defaultOption: true,
+      typeLabel: '{underline file} ...'
     },
     {
-      name: 'timeout', description: 'Timeout value in ms. This description is needlessly long unless you count testing of the description column maxWidth useful.',
-      alias: 't', typeLabel: '{underline ms}'
+      name: 'timeout',
+      description: 'Timeout value in ms.',
+      alias: 't',
+      typeLabel: '{underline ms}'
     }
@@ -274,2 +283,2 @@ ]
 
-&copy; 2015-18 Lloyd Brookes \<[e-mail]\>. Documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown).
+&copy; 2015-19 Lloyd Brookes \<[e-mail]\>. Documented by [jsdoc-to-markdown](https://github.com/75lb/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 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

Improved metrics

Lines of code

329

increased by0.61%

Number of lines in readme file

280

increased by3.32%

Worsened metrics

Total package byte prevSize

26134

decreased by-0.06%

Dev dependency count

4

increased by100%

Number of low quality alerts

2

increased by100%

Dependency changes

• + Addedarray-back@3.1.04.0.2(transitive)

• + Addedreduce-flatten@2.0.0(transitive)

• + Addedtable-layout@1.0.2(transitive)

• + Addedtypical@5.2.0(transitive)

• + Addedwordwrapjs@4.0.1(transitive)

• - Removedarray-back@2.0.0(transitive)

• - Removedlodash.padend@4.6.1(transitive)

• - Removedreduce-flatten@1.0.1(transitive)

• - Removedtable-layout@0.4.5(transitive)

• - Removedtypical@2.6.1(transitive)

• - Removedwordwrapjs@3.0.0(transitive)

• Updatedarray-back@^3.1.0

• Updatedchalk@^2.4.2

• Updatedtable-layout@^1.0.0

• Updatedtypical@^5.0.0