@npmcli/arborist 4.3.0 → 5.0.1

package/bin/lib/options.js

@@ -1,59 +1,123 @@
-const options = module.exports = {
-  path: undefined,
-  cache: `${process.env.HOME}/.npm/_cacache`,
-  _: [],
+const nopt = require('nopt')
+const path = require('path')
+
+const has = (o, k) => Object.prototype.hasOwnProperty.call(o, k)
+
+const cleanPath = (val) => {
+  const k = Symbol('key')
+  const data = {}
+  nopt.typeDefs.path.validate(data, k, val)
+  return data[k]
 }
 
-for (const arg of process.argv.slice(2)) {
-  if (/^--add=/.test(arg)) {
-    options.add = options.add || []
-    options.add.push(arg.substr('--add='.length))
-  } else if (/^--rm=/.test(arg)) {
-    options.rm = options.rm || []
-    options.rm.push(arg.substr('--rm='.length))
-  } else if (arg === '--global') {
-    options.global = true
-  } else if (arg === '--global-style') {
-    options.globalStyle = true
-  } else if (arg === '--prefer-dedupe') {
-    options.preferDedupe = true
-  } else if (arg === '--legacy-peer-deps') {
-    options.legacyPeerDeps = true
-  } else if (arg === '--force') {
-    options.force = true
-  } else if (arg === '--update-all') {
-    options.update = options.update || {}
-    options.update.all = true
-  } else if (/^--update=/.test(arg)) {
-    options.update = options.update || {}
-    options.update.names = options.update.names || []
-    options.update.names.push(arg.substr('--update='.length))
-  } else if (/^--omit=/.test(arg)) {
-    options.omit = options.omit || []
-    options.omit.push(arg.substr('--omit='.length))
-  } else if (/^--before=/.test(arg)) {
-    options.before = new Date(arg.substr('--before='.length))
-  } else if (/^-w.+/.test(arg)) {
-    options.workspaces = options.workspaces || []
-    options.workspaces.push(arg.replace(/^-w/, ''))
-  } else if (/^--workspace=/.test(arg)) {
-    options.workspaces = options.workspaces || []
-    options.workspaces.push(arg.replace(/^--workspace=/, ''))
-  } else if (/^--[^=]+=/.test(arg)) {
-    const [key, ...v] = arg.replace(/^--/, '').split('=')
-    const val = v.join('=')
-    options[key] = val === 'false' ? false : val === 'true' ? true : val
-  } else if (/^--.+/.test(arg)) {
-    options[arg.replace(/^--/, '')] = true
-  } else if (options.path === undefined) {
-    options.path = arg
-  } else {
-    options._.push(arg)
+const parse = (...noptArgs) => {
+  const binOnlyOpts = {
+    command: String,
+    loglevel: String,
+    colors: Boolean,
+    timing: ['always', Boolean],
+    logfile: String,
+  }
+
+  const arbOpts = {
+    add: Array,
+    rm: Array,
+    omit: Array,
+    update: Array,
+    workspaces: Array,
+    global: Boolean,
+    force: Boolean,
+    'global-style': Boolean,
+    'prefer-dedupe': Boolean,
+    'legacy-peer-deps': Boolean,
+    'update-all': Boolean,
+    before: Date,
+    path: path,
+    cache: path,
+    ...binOnlyOpts,
+  }
+
+  const short = {
+    quiet: ['--loglevel', 'warn'],
+    logs: ['--logfile', 'true'],
+    w: '--workspaces',
+    g: '--global',
+    f: '--force',
+  }
+
+  const defaults = {
+    // key order is important for command and path
+    // since they shift positional args
+    // command is 1st, path is 2nd
+    command: (o) => o.argv.remain.shift(),
+    path: (o) => cleanPath(o.argv.remain.shift() || '.'),
+    colors: has(process.env, 'NO_COLOR') ? false : !!process.stderr.isTTY,
+    loglevel: 'silly',
+    timing: (o) => o.loglevel === 'silly',
+    cache: `${process.env.HOME}/.npm/_cacache`,
+  }
+
+  const derived = [
+    // making update either `all` or an array of names but not both
+    ({ updateAll: all, update: names, ...o }) => {
+      if (all || names) {
+        o.update = all != null ? { all } : { names }
+      }
+      return o
+    },
+    ({ logfile, ...o }) => {
+      // logfile is parsed as a string so if its true or set but empty
+      // then set the default logfile
+      if (logfile === 'true' || logfile === '') {
+        logfile = `arb-log-${new Date().toISOString().replace(/[.:]/g, '_')}.log`
+      }
+      // then parse it the same as nopt parses other paths
+      if (logfile) {
+        o.logfile = cleanPath(logfile)
+      }
+      return o
+    },
+  ]
+
+  const transforms = [
+    // Camelcase all top level keys
+    (o) => {
+      const entries = Object.entries(o).map(([k, v]) => [
+        k.replace(/-./g, s => s[1].toUpperCase()),
+        v,
+      ])
+      return Object.fromEntries(entries)
+    },
+    // Set defaults on unset keys
+    (o) => {
+      for (const [k, v] of Object.entries(defaults)) {
+        if (!has(o, k)) {
+          o[k] = typeof v === 'function' ? v(o) : v
+        }
+      }
+      return o
+    },
+    // Set/unset derived values
+    ...derived.map((derive) => (o) => derive(o) || o),
+    // Separate bin and arborist options
+    ({ argv: { remain: _ }, ...o }) => {
+      const bin = { _ }
+      for (const k of Object.keys(binOnlyOpts)) {
+        if (has(o, k)) {
+          bin[k] = o[k]
+          delete o[k]
+        }
+      }
+      return { bin, arb: o }
+    },
+  ]
+
+  let options = nopt(arbOpts, short, ...noptArgs)
+  for (const t of transforms) {
+    options = t(options)
   }
-}
 
-if (options.path === undefined) {
-  options.path = '.'
+  return options
 }
 
-console.error(options)
+module.exports = parse()

package/bin/lib/print-tree.js

@@ -1,5 +1,4 @@
 const { inspect } = require('util')
-const { quiet } = require('./options.js')
+const log = require('./logging.js')
 
-module.exports = quiet ? () => {}
-  : tree => console.log(inspect(tree.toJSON(), { depth: Infinity }))
+module.exports = tree => log.info(inspect(tree.toJSON(), { depth: Infinity }))

package/bin/lib/timers.js

@@ -1,31 +1,33 @@
-const timers = Object.create(null)
-const { format } = require('util')
-const options = require('./options.js')
+const { bin: options } = require('./options.js')
+const log = require('./logging.js')
+
+const timers = new Map()
+const finished = new Map()
 
 process.on('time', name => {
-  if (timers[name]) {
+  if (timers.has(name)) {
     throw new Error('conflicting timer! ' + name)
   }
-  timers[name] = process.hrtime()
+  timers.set(name, process.hrtime.bigint())
 })
 
-const dim = process.stderr.isTTY ? msg => `\x1B[2m${msg}\x1B[22m` : m => m
-const red = process.stderr.isTTY ? msg => `\x1B[31m${msg}\x1B[39m` : m => m
 process.on('timeEnd', name => {
-  if (!timers[name]) {
+  if (!timers.has(name)) {
     throw new Error('timer not started! ' + name)
   }
-  const res = process.hrtime(timers[name])
-  delete timers[name]
-  const msg = format(`${process.pid} ${name}`, res[0] * 1e3 + res[1] / 1e6)
-  if (options.timers !== false) {
-    console.error(dim(msg))
+  const elapsed = Number(process.hrtime.bigint() - timers.get(name))
+  timers.delete(name)
+  finished.set(name, elapsed)
+  if (options.timing) {
+    log.info('timeEnd', `${name} ${elapsed / 1e9}s`, log.meta({ force: options.timing === 'always' }))
   }
 })
 
 process.on('exit', () => {
-  for (const name of Object.keys(timers)) {
-    console.error(red('Dangling timer:'), name)
+  for (const name of timers.keys()) {
+    log.error('timeError', 'Dangling timer:', name)
     process.exitCode = 1
   }
 })
+
+module.exports = finished

package/bin/license.js

@@ -1,38 +1,48 @@
+const localeCompare = require('@isaacs/string-locale-compare')('en')
 const Arborist = require('../')
-const options = require('./lib/options.js')
-require('./lib/logging.js')
-require('./lib/timers.js')
+const log = require('./lib/logging.js')
 
-const a = new Arborist(options)
-const query = options._.shift()
+module.exports = (options, time) => {
+  const query = options._.shift()
+  const a = new Arborist(options)
+  return a
+    .loadVirtual()
+    .then(tree => {
+      // only load the actual tree if the virtual one doesn't have modern metadata
+      if (!tree.meta || !(tree.meta.originalLockfileVersion >= 2)) {
+        throw 'load actual'
+      } else {
+        return tree
+      }
+    }).catch((er) => {
+      log.error('loading actual tree', er)
+      return a.loadActual()
+    })
+    .then(time)
+    .then(({ result: tree }) => {
+      const output = []
+      if (!query) {
+        const set = []
+        for (const license of tree.inventory.query('license')) {
+          set.push([tree.inventory.query('license', license).size, license])
+        }
 
-a.loadVirtual().then(tree => {
-  // only load the actual tree if the virtual one doesn't have modern metadata
-  if (!tree.meta || !(tree.meta.originalLockfileVersion >= 2)) {
-    throw 'load actual'
-  } else {
-    return tree
-  }
-}).catch((er) => {
-  console.error('loading actual tree', er)
-  return a.loadActual()
-}).then(tree => {
-  if (!query) {
-    const set = []
-    for (const license of tree.inventory.query('license')) {
-      set.push([tree.inventory.query('license', license).size, license])
-    }
+        for (const [count, license] of set.sort((a, b) =>
+          a[1] && b[1] ? b[0] - a[0] || localeCompare(a[1], b[1])
+          : a[1] ? -1
+          : b[1] ? 1
+          : 0)) {
+          output.push(`${count} ${license}`)
+          log.info(count, license)
+        }
+      } else {
+        for (const node of tree.inventory.query('license', query === 'undefined' ? undefined : query)) {
+          const msg = `${node.name} ${node.location} ${node.package.description || ''}`
+          output.push(msg)
+          log.info(msg)
+        }
+      }
 
-    for (const [count, license] of set.sort((a, b) =>
-      a[1] && b[1] ? b[0] - a[0] || a[1].localeCompare(b[1], 'en')
-      : a[1] ? -1
-      : b[1] ? 1
-      : 0)) {
-      console.log(count, license)
-    }
-  } else {
-    for (const node of tree.inventory.query('license', query === 'undefined' ? undefined : query)) {
-      console.log(`${node.name} ${node.location} ${node.package.description || ''}`)
-    }
-  }
-})
+      return output.join('\n')
+    })
+}

package/bin/prune.js

@@ -1,9 +1,7 @@
 const Arborist = require('../')
 
-const options = require('./lib/options.js')
-const print = require('./lib/print-tree.js')
-require('./lib/logging.js')
-require('./lib/timers.js')
+const printTree = require('./lib/print-tree.js')
+const log = require('./lib/logging.js')
 
 const printDiff = diff => {
   const { depth } = require('treeverse')
@@ -15,13 +13,13 @@ const printDiff = diff => {
       }
       switch (d.action) {
         case 'REMOVE':
-          console.error('REMOVE', d.actual.location)
+          log.info('REMOVE', d.actual.location)
           break
         case 'ADD':
-          console.error('ADD', d.ideal.location, d.ideal.resolved)
+          log.info('ADD', d.ideal.location, d.ideal.resolved)
           break
         case 'CHANGE':
-          console.error('CHANGE', d.actual.location, {
+          log.info('CHANGE', d.actual.location, {
             from: d.actual.resolved,
             to: d.ideal.resolved,
           })
@@ -32,18 +30,19 @@ const printDiff = diff => {
   })
 }
 
-const start = process.hrtime()
-process.emit('time', 'install')
-const arb = new Arborist(options)
-arb.prune(options).then(tree => {
-  process.emit('timeEnd', 'install')
-  const end = process.hrtime(start)
-  print(tree)
-  if (options.dryRun) {
-    printDiff(arb.diff)
-  }
-  console.error(`resolved ${tree.inventory.size} deps in ${end[0] + end[1] / 1e9}s`)
-  if (tree.meta && options.save) {
-    tree.meta.save()
-  }
-}).catch(er => console.error(require('util').inspect(er, { depth: Infinity })))
+module.exports = (options, time) => {
+  const arb = new Arborist(options)
+  return arb
+    .prune(options)
+    .then(time)
+    .then(async ({ timing, result: tree }) => {
+      printTree(tree)
+      if (options.dryRun) {
+        printDiff(arb.diff)
+      }
+      if (tree.meta && options.save) {
+        await tree.meta.save()
+      }
+      return `resolved ${tree.inventory.size} deps in ${timing.seconds}`
+    })
+}

package/bin/reify.js

@@ -1,9 +1,7 @@
 const Arborist = require('../')
 
-const options = require('./lib/options.js')
-const print = require('./lib/print-tree.js')
-require('./lib/logging.js')
-require('./lib/timers.js')
+const printTree = require('./lib/print-tree.js')
+const log = require('./lib/logging.js')
 
 const printDiff = diff => {
   const { depth } = require('treeverse')
@@ -15,13 +13,13 @@ const printDiff = diff => {
       }
       switch (d.action) {
         case 'REMOVE':
-          console.error('REMOVE', d.actual.location)
+          log.info('REMOVE', d.actual.location)
           break
         case 'ADD':
-          console.error('ADD', d.ideal.location, d.ideal.resolved)
+          log.info('ADD', d.ideal.location, d.ideal.resolved)
           break
         case 'CHANGE':
-          console.error('CHANGE', d.actual.location, {
+          log.info('CHANGE', d.actual.location, {
             from: d.actual.resolved,
             to: d.ideal.resolved,
           })
@@ -32,18 +30,19 @@ const printDiff = diff => {
   })
 }
 
-const start = process.hrtime()
-process.emit('time', 'install')
-const arb = new Arborist(options)
-arb.reify(options).then(tree => {
-  process.emit('timeEnd', 'install')
-  const end = process.hrtime(start)
-  print(tree)
-  if (options.dryRun) {
-    printDiff(arb.diff)
-  }
-  console.error(`resolved ${tree.inventory.size} deps in ${end[0] + end[1] / 1e9}s`)
-  if (tree.meta && options.save) {
-    tree.meta.save()
-  }
-}).catch(er => console.error(require('util').inspect(er, { depth: Infinity })))
+module.exports = (options, time) => {
+  const arb = new Arborist(options)
+  return arb
+    .reify(options)
+    .then(time)
+    .then(async ({ timing, result: tree }) => {
+      printTree(tree)
+      if (options.dryRun) {
+        printDiff(arb.diff)
+      }
+      if (tree.meta && options.save) {
+        await tree.meta.save()
+      }
+      return `resolved ${tree.inventory.size} deps in ${timing.seconds}`
+    })
+}

package/bin/shrinkwrap.js

@@ -1,12 +1,7 @@
 const Shrinkwrap = require('../lib/shrinkwrap.js')
-const options = require('./lib/options.js')
-require('./lib/logging.js')
-require('./lib/timers.js')
 
-const { quiet } = options
-Shrinkwrap.load(options)
-  .then(s => quiet || console.log(JSON.stringify(s.commit(), 0, 2)))
-  .catch(er => {
-    console.error('shrinkwrap load failure', er)
-    process.exit(1)
-  })
+module.exports = (options, time) => Shrinkwrap
+  .load(options)
+  .then((s) => s.commit())
+  .then(time)
+  .then(({ result: s }) => JSON.stringify(s, 0, 2))

package/bin/virtual.js

@@ -1,18 +1,14 @@
 const Arborist = require('../')
 
-const print = require('./lib/print-tree.js')
-const options = require('./lib/options.js')
-require('./lib/logging.js')
-require('./lib/timers.js')
+const printTree = require('./lib/print-tree.js')
 
-const start = process.hrtime()
-new Arborist(options).loadVirtual().then(tree => {
-  const end = process.hrtime(start)
-  if (!options.quiet) {
-    print(tree)
-  }
-  if (options.save) {
-    tree.meta.save()
-  }
-  console.error(`read ${tree.inventory.size} deps in ${end[0] * 1000 + end[1] / 1e6}ms`)
-}).catch(er => console.error(er))
+module.exports = (options, time) => new Arborist(options)
+  .loadVirtual()
+  .then(time)
+  .then(async ({ timing, result: tree }) => {
+    printTree(tree)
+    if (options.save) {
+      await tree.meta.save()
+    }
+    return `read ${tree.inventory.size} deps in ${timing.ms}`
+  })

package/lib/add-rm-pkg-deps.js

@@ -1,10 +1,11 @@
 // add and remove dependency specs to/from pkg manifest
 
+const log = require('proc-log')
 const localeCompare = require('@isaacs/string-locale-compare')('en')
 
-const add = ({ pkg, add, saveBundle, saveType, log }) => {
+const add = ({ pkg, add, saveBundle, saveType }) => {
   for (const spec of add) {
-    addSingle({ pkg, spec, saveBundle, saveType, log })
+    addSingle({ pkg, spec, saveBundle, saveType })
   }
 
   return pkg
@@ -20,7 +21,7 @@ const saveTypeMap = new Map([
   ['peer', 'peerDependencies'],
 ])
 
-const addSingle = ({ pkg, spec, saveBundle, saveType, log }) => {
+const addSingle = ({ pkg, spec, saveBundle, saveType }) => {
   const { name, rawSpec } = spec
 
   // if the user does not give us a type, we infer which type(s)
@@ -34,19 +35,19 @@ const addSingle = ({ pkg, spec, saveBundle, saveType, log }) => {
   if (saveType === 'prod') {
     // a production dependency can only exist as production (rpj ensures it
     // doesn't coexist w/ optional)
-    deleteSubKey(pkg, 'devDependencies', name, 'dependencies', log)
-    deleteSubKey(pkg, 'peerDependencies', name, 'dependencies', log)
+    deleteSubKey(pkg, 'devDependencies', name, 'dependencies')
+    deleteSubKey(pkg, 'peerDependencies', name, 'dependencies')
   } else if (saveType === 'dev') {
     // a dev dependency may co-exist as peer, or optional, but not production
-    deleteSubKey(pkg, 'dependencies', name, 'devDependencies', log)
+    deleteSubKey(pkg, 'dependencies', name, 'devDependencies')
   } else if (saveType === 'optional') {
     // an optional dependency may co-exist as dev (rpj ensures it doesn't
     // coexist w/ prod)
-    deleteSubKey(pkg, 'peerDependencies', name, 'optionalDependencies', log)
+    deleteSubKey(pkg, 'peerDependencies', name, 'optionalDependencies')
   } else { // peer or peerOptional is all that's left
     // a peer dependency may coexist as dev
-    deleteSubKey(pkg, 'dependencies', name, 'peerDependencies', log)
-    deleteSubKey(pkg, 'optionalDependencies', name, 'peerDependencies', log)
+    deleteSubKey(pkg, 'dependencies', name, 'peerDependencies')
+    deleteSubKey(pkg, 'optionalDependencies', name, 'peerDependencies')
   }
 
   const depType = saveTypeMap.get(saveType)
@@ -108,9 +109,9 @@ const hasSubKey = (pkg, depType, name) => {
 }
 
 // Removes a subkey and warns about it if it's being replaced
-const deleteSubKey = (pkg, depType, name, replacedBy, log) => {
+const deleteSubKey = (pkg, depType, name, replacedBy) => {
   if (hasSubKey(pkg, depType, name)) {
-    if (replacedBy && log) {
+    if (replacedBy) {
       log.warn('idealTree', `Removing ${depType}.${name} in favor of ${replacedBy}.${name}`)
     }
     delete pkg[depType][name]