@magic/cli 0.0.31 → 0.0.35

package/README.md

@@ -50,8 +50,9 @@ ecmascript modules only. no commonjs support.
 ### <a name="dependencies"></a>dependencies:
 * [@magic/log](https://github.com/magic/log): console.log wrapper with loglevels
 * [@magic/types](https://github.com/magic/types): type checking library
+* [@magic/types](https://github.com/magic/cases): case checking library (CamelCase, snake_case, kebab-case)
 
-@magic/log and @magic/types have no dependencies.
+@magic/log, @magic/cases and @magic/types have no dependencies.
 
 ### <a name="install"></a>install
 be in a node ecmascript module project.
@@ -431,5 +432,23 @@ update dependencies
 * bump required node version to 14.15.4
 * update dependencies
 
-##### 0.0.32 - unreleased
+##### 0.0.32
+update dependencies
+
+##### 0.0.33
+update dependencies
+
+##### 0.0.34
+update dependencies
+
+##### 0.0.35
+* parse now can get an opts object as third argument to overwrite child_process.exec options
+* help.argToHelp now errors if the first argument is not an array, before errors only got triggered by falsy arg.
+* exec now uses @magic/error for errors.
+* exec does not trim() the result.
+* findLongestString sorts by length and then alphabetically
+* export execFile
+* update dependencies
+
+##### 0.0.36 - unreleased
 ...

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magic/cli",
-  "version": "0.0.31",
+  "version": "0.0.35",
   "homepage": "https://magic.github.io/cli",
   "description": "declarative command line interfaces with aliasing, commands and environment sanitization",
   "scripts": {
@@ -13,6 +13,7 @@
     "calls": "calls"
   },
   "main": "src/index.mjs",
+  "type": "module",
   "files": [
     "src"
   ],
@@ -31,19 +32,21 @@
     "declarative"
   ],
   "dependencies": {
-    "@magic/cases": "0.0.4",
-    "@magic/log": "0.1.8",
-    "@magic/types": "0.1.14"
+    "@magic/cases": "0.0.5",
+    "@magic/deep": "0.1.8",
+    "@magic/error": "0.0.10",
+    "@magic/log": "0.1.10",
+    "@magic/types": "0.1.16"
   },
   "devDependencies": {
     "@magic-modules/git-badges": "0.0.11",
     "@magic-modules/light-switch": "0.0.10",
     "@magic-modules/no-spy": "0.0.6",
-    "@magic-modules/pre": "0.0.10",
-    "@magic-themes/docs": "0.0.12",
-    "@magic/core": "0.0.101",
-    "@magic/format": "0.0.20",
-    "@magic/test": "0.1.59"
+    "@magic-modules/pre": "0.0.11",
+    "@magic-themes/docs": "0.0.14",
+    "@magic/core": "0.0.133",
+    "@magic/format": "0.0.34",
+    "@magic/test": "0.2.0"
   },
   "author": "Wizards & Witches",
   "license": "AGPL-3.0",

package/src/exec.mjs

@@ -1,24 +1,24 @@
 import child_process from 'child_process'
 
+import error from '@magic/error'
+
 const libName = '@magic/cli.exec'
 
 export const exec = (cmd, options = {}) =>
   new Promise((resolve, reject) => {
     child_process.exec(cmd, options, (err, stdout, stderr) => {
       if (err) {
-        const e = new Error(`${libName}: ${cmd} error: ${err.message}`)
-        e.name = 'E_EXEC_ERR'
+        const e = error(err, 'E_EXEC_ERR')
         reject(e)
         return
       }
 
       if (stderr) {
-        const e = new Error(`${libName}: ${cmd} error: ${stderr}`)
-        e.name = 'E_EXEC_STDERR'
+        const e = error(new Error(`${libName}: ${cmd} error: ${stderr}`), 'E_EXEC_STDERR')
         reject(e)
         return
       }
 
-      resolve(stdout.trim())
+      resolve(stdout)
     })
   })

package/src/execFile.mjs

@@ -0,0 +1,28 @@
+import child_process from 'child_process'
+
+import error from '@magic/error'
+
+const libName = '@magic/cli.execFile'
+
+export const execFile = (p, args = [], opts = {}) =>
+  new Promise((resolve, reject) => {
+    child_process.execFile(
+      p,
+      args.filter(a => a),
+      opts,
+      (err, stdout, stderr) => {
+        if (err) {
+          const e = error(err, 'E_EXECFILE_ERR')
+          reject(err)
+          return
+        }
+        if (stderr) {
+          const e = error(new Error(`${libName}: ${cmd} error: ${stderr}`), 'E_EXECFILE_STDERR')
+          reject(e)
+          return
+        }
+
+        resolve(stdout)
+      },
+    )
+  })

package/src/help/argToHelp.mjs

@@ -1,9 +1,19 @@
 import is from '@magic/types'
 import log from '@magic/log'
+import error from '@magic/error'
 
 import { findLongestString } from './findLongestString.mjs'
 
+const lib = '@magic/cli.help.argToHelp'
+
 export const argToHelp = (arr, help = {}, defaults = {}) => {
+  if (!is.array(arr)) {
+    throw error(
+      `${lib} expects the first argument to be a non-empty array, received: ${arr}`,
+      'E_MISSING_ARGUMENT',
+    )
+  }
+
   const longest = findLongestString(arr)
 
   return arr
@@ -19,6 +29,7 @@ export const argToHelp = (arr, help = {}, defaults = {}) => {
       let res = log.paint('yellow', name)
 
       const dist = longest.length - name.length
+
       const placeholder = Array(dist + 1).join(' ')
 
       res += placeholder

package/src/help/findLongestString.mjs

@@ -1,20 +1,15 @@
-import is from '@magic/types'
+import deep from '@magic/deep'
 
 export const findLongestString = arr => {
-  const longest = arr.sort((a, b) => {
-    if (is.array(a)) {
-      a = findLongestString(a)
-    }
-    if (is.array(b)) {
-      b = findLongestString(b)
-    }
+  arr = deep.flatten(arr)
 
-    return a.length > b.length ? -1 : 1
-  })[0]
+  const sorted = arr.sort((a, b) => {
+    if (a.length !== b.length) {
+      return b.length - a.length
+    }
 
-  if (is.array(longest)) {
-    return longest[0]
-  }
+    return a > b ? 1 : -1
+  })
 
-  return longest
+  return sorted[0]
 }

package/src/help/index.mjs

@@ -6,8 +6,6 @@ import { argToHelp } from './argToHelp.mjs'
 
 export const maybeHelp = args => {
   const { parsed } = args
-  const hasArgs = Object.values(parsed).some(a => Object.entries(a).length)
-  const flags = ['help', 'h', '-h', '--h', '--help']
   const hasCommands = args.commands && Object.entries(args.commands).length > 0
   const showCommandHelp = hasCommands && Object.keys(parsed.commands).length === 0
 
@@ -27,7 +25,7 @@ export const maybeHelp = args => {
   const envHelp = envToHelp(env, help.env)
 
   const name = help.name || '@magic/cli wrapped cli.'
-  const header = typeof help === 'string' ? help : help.text
+  const header = is.string(help) ? help : help.text
 
   const helpArray = [
     log.paint('green', name),

package/src/index.mjs

@@ -5,6 +5,7 @@ import { maybeHelp } from './help/index.mjs'
 import { parse } from './parse/index.mjs'
 
 import { exec as execute } from './exec.mjs'
+import { execFile as executeFile } from './execFile.mjs'
 import { spawn as spawner } from './spawn.mjs'
 import { prompt as promptUser } from './prompt.mjs'
 
@@ -39,4 +40,7 @@ cli.exec = execute
 export const prompt = promptUser
 cli.prompt = promptUser
 
+export const execFile = executeFile
+cli.execFile = executeFile
+
 export default cli

package/src/parse/argv.mjs

@@ -19,6 +19,7 @@ export const parseArgv = ({
     }
 
     if (arg.startsWith('-')) {
+      // this is a key
       let argvArg
       options.forEach(option => {
         if (is.array(option)) {
@@ -37,6 +38,7 @@ export const parseArgv = ({
         }
       }
     } else {
+      // this is a value
       if (lastArg) {
         argv[lastArg].push(arg)
       }
@@ -62,14 +64,14 @@ export const parseArgv = ({
   }
 
   let argvPrepend = []
-  if (!Array.isArray(prepend)) {
+  if (!is.array(prepend)) {
     argvPrepend.push(prepend)
   } else if (prepend.length) {
     Object.entries(prepend).forEach(([k, v]) => {
       argv[k] = v
 
       argvPrepend.push(k)
-      if (!Array.isArray(v)) {
+      if (!is.array(v)) {
         argvPrepend.push(v)
       } else {
         argvPrepend = [...argvPrepend, ...v]
@@ -78,7 +80,7 @@ export const parseArgv = ({
   }
 
   let argvAppend = []
-  if (!Array.isArray(append)) {
+  if (!is.array(append)) {
     argvAppend.push(append)
   } else if (append.length) {
     Object.entries(append)

package/src/parse/clean.mjs

@@ -1,20 +1,27 @@
 import is from '@magic/types'
 import cases from '@magic/cases'
 
-export const clean = (cli, props) => {
+export const clean = (cli, props = {}) => {
   if (is.empty(props.single)) {
     return cli
   }
 
   props.single.map(s => {
-    if (cli.argv[s] && is.array(cli.argv[s])) {
-      cli.argv[s] = cli.argv[s].join(' ')
-    }
-
     const c = cases.camel(s)
+    const def = props.default && (props.default[s] || props.default[c])
+
+    const a = cli.argv[s]
+
+    if (!is.empty(a)) {
+      const str = is.array(a) ? a.join(' ') : a
 
-    if (cli.args[c] && is.array(cli.args[c])) {
-      cli.args[c] = cli.args[c].join(' ')
+      if (str) {
+        cli.argv[s] = str
+        cli.args[c] = str
+      }
+    } else if (def) {
+      cli.argv[s] = def
+      cli.args[c] = def
     }
   })
 

package/src/parse/commands.mjs

@@ -1,43 +1,54 @@
-export const parseCommands = ({ commands = [], pure = false }) => {
+import log from '@magic/log'
+import is from '@magic/types'
+
+export const parseCommands = (props = {}) => {
+  const { commands = [], pure = false } = props
   const { argv } = process
   const runAll = argv.includes('all')
 
-  const cmds = {}
-  commands.map((tasks = []) => {
-    let key
-    let idx = -1
-    if (typeof tasks === 'string') {
-      if (argv.includes(tasks)) {
-        idx = argv.indexOf(tasks)
-        key = tasks
-      } else if (runAll) {
-        key = tasks
-      }
-    } else {
-      if (!Array.isArray(tasks)) {
-        tasks = [tasks]
-      }
+  const cmds = Object.fromEntries(
+    commands
+      .map((tasks = []) => {
+        let key
+        let idx = -1
 
-      if (runAll) {
-        key = tasks[0]
-      } else {
-        const idxArray = tasks.filter(task => argv.includes(task)).map(task => argv.indexOf(task))
+        if (is.string(tasks)) {
+          if (argv.includes(tasks)) {
+            idx = argv.indexOf(tasks)
+            key = tasks
+          } else if (runAll) {
+            key = tasks
+          }
+        } else if (is.array(tasks)) {
+          if (runAll) {
+            key = tasks[0]
+          } else {
+            const idxArray = tasks
+              .filter(task => argv.includes(task))
+              .map(task => argv.indexOf(task))
 
-        idx = idxArray[0]
-        key = tasks[0]
-      }
-    }
+            idx = idxArray[0]
+            key = tasks[0]
+          }
+        } else {
+          log.error(
+            'E_UNEXPECTED_TASK',
+            `@magic/cli: got unexpected task type: ${typeof tasks}, can handle strings or arrays`,
+          )
+        }
 
-    if (idx > -1) {
-      cmds[key] = true
+        if (idx > -1) {
+          if (!pure) {
+            argv[idx] = key
+          }
 
-      if (!pure) {
-        argv[idx] = key
-      }
-    } else if (runAll) {
-      cmds[key] = true
-    }
-  })
+          return [key, true]
+        } else if (runAll) {
+          return [key, true]
+        }
+      })
+      .filter(a => a),
+  )
 
   return cmds
 }

package/src/parse/env.mjs

@@ -1,10 +1,12 @@
+import is from '@magic/types'
+
 export const parseEnv = ({ env = [], pure = false }) => {
   const environment = []
 
   // set env depending on env switches
   env
     .filter(([argv]) => {
-      if (!Array.isArray(argv)) {
+      if (!is.array(argv)) {
         argv = [argv]
       }
       return argv.some(a => process.argv.includes(a))

package/src/parse/required.mjs

@@ -1,7 +1,10 @@
 import is from '@magic/types'
 
-export const parseRequired = ({ props, parsed }) => {
-  const { options, required } = props
+export const parseRequired = (args = {}) => {
+  const {
+    parsed,
+    props: { required },
+  } = args
 
   if (is.empty(required)) {
     return []

package/src/spawn.mjs

@@ -1,10 +1,11 @@
 import child_process from 'child_process'
 
-export const spawn = (cmd, args = []) => {
+export const spawn = (cmd, args = [], opt = {}) => {
   const opts = {
     cwd: process.cwd(),
     env: process.env,
     stdio: 'inherit',
+    ...opt,
   }
 
   return child_process.spawn(cmd, args, opts)