command-line-usage - npm Package Compare versions

Comparing version 2.0.4 to 2.0.5

es5/command-line-usage.js

@@ -13,2 +13,3 @@ 'use strict';
 var arrayify = require('array-back');
+var wrap = require('wordwrapjs');
 
@@ -61,3 +62,3 @@ module.exports = getUsage;
   if (options.title || options.description) {
-    output.add(renderSection(options.title, options.description));
+    output.add(renderSection(options.title, t.isString(options.description) ? wrap.lines(options.description, { width: 80 }) : options.description));
   }
@@ -64,0 +65,0 @@

example/simple.js

@@ -20,3 +20,3 @@ const getUsage = require('../')
   title: 'a typical app',
-  description: 'Generates something very important.',
+  description: 'Generates something very important. This is a rather long, but ultimately inconsequential description intended solely to demonstrate description appearance. ',
   footer: 'Project home: [underline]{https://github.com/me/example}'
@@ -23,0 +23,0 @@ }

lib/command-line-usage.js

@@ -8,2 +8,3 @@ 'use strict'
 const arrayify = require('array-back')
+const wrap = require('wordwrapjs')
 
@@ -55,3 +56,8 @@ /**
   if (options.title || options.description) {
-    output.add(renderSection(options.title, options.description))
+    output.add(renderSection(
+      options.title,
+      t.isString(options.description)
+        ? wrap.lines(options.description, { width: 80 })
+        : options.description
+    ))
   }
@@ -58,0 +64,0 @@

package.json

 {
   "name": "command-line-usage",
   "author": "Lloyd Brookes <[e-mail]>",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "description": "Generates command-line usage information",
@@ -28,3 +28,4 @@ "repository": "https://github.com/75lb/command-line-usage.git",
     "feature-detect-es6": "^1.2.0",
-    "typical": "^2.4.2"
+    "typical": "^2.4.2",
+    "wordwrapjs": "^1.2.0"
   },
@@ -31,0 +32,0 @@ "devDependencies": {

README.md

@@ -11,3 +11,3 @@ [![view on npm](http://img.shields.io/npm/v/command-line-usage.svg)](https://www.npmjs.org/package/command-line-usage)
 ```js
-var getUsage = require("command-line-usage");
+var getUsage = require('command-line-usage');
 var usage = getUsage(definitions, options)
@@ -14,0 +14,0 @@ ```

No alert changes

Improved metrics

Total package byte prevSize

440267

increased by0.1%

Lines of code

808

increased by0.87%

Worsened metrics

Dependency count

6

increased by20%

Dependency changes

• + Addedwordwrapjs@^1.2.0