check-installed 2.1.1 → 2.2.0

package/README.md

@@ -75,32 +75,32 @@ They are typed to accept the entire `options` object, but only use options they
   - `string`: `--option-name=value`
 - Options for `checkEngines` and `checkModules` are the same as CLI options but `camelCased`
 
-### `--help`
+#### `--help`
 Show help (skips check)
 
 *Type: `boolean`, Default: `false`*
 
-### `--skip-engines`
+#### `--skip-engines`
 Skip checking engines
 
 *Type: `boolean`, Default: `false`*
 
-### `--skip-modules`
+#### `--skip-modules`
 Skip checking node modules
 
 *Type: `boolean`, Default: `false`*
 
-### `--show-success`
+#### `--show-success`
 Show success message on successful checks
 
 *Type: `boolean`, Default: `false`*
 
-### `--show-engines`
+#### `--show-engines`
 Show installed engines on successful check
 
 *Type: `boolean`, Default: `false`*
 
-### `--show-modules`
+#### `--show-modules`
 Show installed node modules on successful check
 
 *Type: `boolean`, Default: `false`*

package/lib/checkEngines.js

@@ -73,6 +73,10 @@ async function checkEngines (json = {}, options) {
       console.log(`${name}: ${installed} (${version})`)
     }
   }
+
+  if (showSuccess || showEngines) {
+    console.log('')
+  }
 }
 
 module.exports = {

package/lib/checkModules.js

@@ -80,6 +80,10 @@ async function checkModules (json = {}, options) {
       console.log(`${name}: ${installed} (${aliased}${version})`)
     }
   }
+
+  if (showSuccess || showModules) {
+    console.log('')
+  }
 }
 
 module.exports = {

package/lib/cli.js

@@ -1,45 +1,9 @@
 const { resolve } = require('path')
-const { HELP, OPTIONS } = require('./constants')
+const { HELP } = require('./constants')
+const { getOptions } = require('./getOptions')
 const { checkEngines } = require('./checkEngines')
 const { checkModules } = require('./checkModules')
 
-/**
- * Get options from CLI arguments
- * @param {string[]} args - CLI arguments
- * @returns {typeof OPTIONS} - Options for the CLI with defaults
- */
-function getOptions (args) {
-  const options = {}
-
-  for (const arg of args) {
-    if (arg.startsWith('--')) {
-      const [key, value] = arg.slice(2).split('=')
-      const keyCamelCase = key.replace(/-([a-z])/g, (_, c) => c.toUpperCase())
-      const option = OPTIONS[keyCamelCase]
-
-      // Only set if the option is defined in `OPTIONS`
-      if (option !== undefined) {
-        let newValue
-
-        // If boolean, `true` only if no value or value is "true"
-        // Otherwise, only if value provided
-        if (typeof option === 'boolean') {
-          newValue = value == null ? true : value === 'true'
-        } else if (value != null) {
-          newValue = value
-        }
-
-        // Set only if valid and not already default
-        if (newValue !== undefined && newValue !== option) {
-          options[keyCamelCase] = newValue
-        }
-      }
-    }
-  }
-
-  return options
-}
-
 /**
  * check-installed CLI entry point
  * @param {string[]} argv - CLI arguments

package/lib/getOptions.js

@@ -0,0 +1,42 @@
+const { OPTIONS } = require('./constants')
+
+/**
+ * Get check-installed options from CLI arguments
+ * @param {string[]} args - CLI arguments
+ * @returns {typeof OPTIONS} - Options for the CLI with defaults
+ */
+function getOptions (args = []) {
+  const options = {}
+
+  for (const arg of args) {
+    if (arg.startsWith('--')) {
+      const [key, value] = arg.slice(2).split('=')
+      const keyCamelCase = key.replace(/-([a-z])/g, (_, c) => c.toUpperCase())
+      const option = OPTIONS[keyCamelCase]
+
+      // Only set if the option is defined in `OPTIONS`
+      if (option !== undefined) {
+        let newValue
+
+        // If boolean, `true` only if no value or value is "true"
+        // Otherwise, only if value provided
+        if (typeof option === 'boolean') {
+          newValue = value == null ? true : value === 'true'
+        } else if (value != null) {
+          newValue = value
+        }
+
+        // Set only if valid and not already default
+        if (newValue !== undefined && newValue !== option) {
+          options[keyCamelCase] = newValue
+        }
+      }
+    }
+  }
+
+  return options
+}
+
+module.exports = {
+  getOptions
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "check-installed",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "Minimal Node package to check that dependencies are installed ✅",
   "author": "Phillip Lanclos <check-installed@flippidippi.com>",
   "license": "Unlicense",
@@ -32,7 +32,7 @@
     "npm": ">=6"
   },
   "scripts": {
-    "check": "./bin/check-installed",
+    "check": "./bin/check-installed --show-engines",
     "lint": "standard",
     "lint:fix": "npm run lint -- --fix",
     "test": "npm run check && jest",