command-line-basics - npm Package Compare versions

Comparing version 0.5.3 to 0.6.0

CHANGES.md

 # CHANGES for command-line-basics
 
+## 0.6.0
+
+- Enhancement: Auto-add `content` based on `pkg.description` and
+  `Options` as `sections[1].header`.
+
 ## 0.5.3
@@ -4,0 +9,0 @@

package.json

 {
   "name": "command-line-basics",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "description": "Auto-add help and version CLI and update notification checks",
@@ -5,0 +5,0 @@ "main": "src/index.js",

README.md

@@ -59,2 +59,4 @@ # command-line-basics
     autoAddHeader: true,
+    autoAddOptionsHeader: true,
+    autoAddContent: true,
     updateNotifierOptions: {
@@ -94,6 +96,1 @@ // Options besides `pkg`
 `definitions` and `sections`. It is also used internally by `cliBasics`.
-
-## To-dos
-
-1. Could auto-add `content` based on `pkg.description` and `Options` as
-    `sections[1].header`.

src/index.js

@@ -67,6 +67,17 @@ 'use strict';
   }
-  if (options.autoAddHeader !== false && cliSections[0] &&
-      !cliSections[0].header
+  if (cliSections[0]) {
+    if (!cliSections[0].header && options.autoAddHeader !== false) {
+      cliSections[0].header = pkg.name;
+    }
+    if (!cliSections[0].content && options.autoAddContent !== false &&
+      pkg.description
+    ) {
+      cliSections[0].content = pkg.description;
+    }
+  }
+
+  if (cliSections[1] && !cliSections[1].header &&
+    options.autoAddOptionsHeader !== false
   ) {
-    cliSections[0].header = pkg.name;
+    cliSections[1].header = 'Options';
   }
@@ -73,0 +84,0 @@

No alert changes

Improved metrics

Total package byte prevSize

11781

increased by3.21%

Lines of code

149

increased by7.19%

Worsened metrics

Number of lines in readme file

95

decreased by-3.06%

No dependency changes