fix: make usage and completion static functions

Author: lukekarrys

lib/base-command.js

@@ -2,17 +2,65 @@
 
 const { relative } = require('path')
 
-const ConfigDefinitions = require('./utils/config/definitions.js')
+const definitions = require('./utils/config/definitions.js')
 const getWorkspaces = require('./workspaces/get-workspaces.js')
-
-const cmdAliases = require('./utils/cmd-list').aliases
+const { aliases: cmdAliases } = require('./utils/cmd-list')
 
 class BaseCommand {
   static workspaces = false
   static ignoreImplicitWorkspace = true
 
+  // these are all overridden by individual commands
+  static name = null
+  static description = null
+  static params = null
+
+  // this is a static so that we can read from it without instantiating a command
+  // which would require loading the config
+  static get describeUsage () {
+    const wrapWidth = 80
+    const { description, usage = [''], name, params } = this
+
+    const fullUsage = [
+      `${description}`,
+      '',
+      'Usage:',
+      ...usage.map(u => `npm ${name} ${u}`.trim()),
+    ]
+
+    if (params) {
+      let results = ''
+      let line = ''
+      for (const param of params) {
+        const paramUsage = `[${definitions[param].usage}]`
+        if (line.length + paramUsage.length > wrapWidth) {
+          results = [results, line].filter(Boolean).join('\n')
+          line = ''
+        }
+        line = [line, paramUsage].filter(Boolean).join(' ')
+      }
+      fullUsage.push('')
+      fullUsage.push('Options:')
+      fullUsage.push([results, line].filter(Boolean).join('\n'))
+    }
+
+    const aliases = Object.entries(cmdAliases).reduce((p, [k, v]) => {
+      return p.concat(v === name ? k : [])
+    }, [])
+
+    if (aliases.length) {
+      const plural = aliases.length === 1 ? '' : 'es'
+      fullUsage.push('')
+      fullUsage.push(`alias${plural}: ${aliases.join(', ')}`)
+    }
+
+    fullUsage.push('')
+    fullUsage.push(`Run "npm help ${name}" for more info`)
+
+    return fullUsage.join('\n')
+  }
+
   constructor (npm) {
-    this.wrapWidth = 80
     this.npm = npm
 
     const { config } = this.npm
@@ -39,59 +87,7 @@ class BaseCommand {
   }
 
   get usage () {
-    const usage = [
-      `${this.description}`,
-      '',
-      'Usage:',
-    ]
-
-    if (!this.constructor.usage) {
-      usage.push(`npm ${this.name}`)
-    } else {
-      usage.push(...this.constructor.usage.map(u => `npm ${this.name} ${u}`))
-    }
-
-    if (this.params) {
-      usage.push('')
-      usage.push('Options:')
-      usage.push(this.wrappedParams)
-    }
-
-    const aliases = Object.keys(cmdAliases).reduce((p, c) => {
-      if (cmdAliases[c] === this.name) {
-        p.push(c)
-      }
-      return p
-    }, [])
-
-    if (aliases.length === 1) {
-      usage.push('')
-      usage.push(`alias: ${aliases.join(', ')}`)
-    } else if (aliases.length > 1) {
-      usage.push('')
-      usage.push(`aliases: ${aliases.join(', ')}`)
-    }
-
-    usage.push('')
-    usage.push(`Run "npm help ${this.name}" for more info`)
-
-    return usage.join('\n')
-  }
-
-  get wrappedParams () {
-    let results = ''
-    let line = ''
-
-    for (const param of this.params) {
-      const usage = `[${ConfigDefinitions[param].usage}]`
-      if (line.length && line.length + usage.length > this.wrapWidth) {
-        results = [results, line].filter(Boolean).join('\n')
-        line = ''
-      }
-      line = [line, usage].filter(Boolean).join(' ')
-    }
-    results = [results, line].filter(Boolean).join('\n')
-    return results
+    return this.constructor.describeUsage
   }
 
   usageError (prefix = '') {

lib/cli.js

@@ -81,7 +81,7 @@ module.exports = async process => {
 
     cmd = npm.argv.shift()
     if (!cmd) {
-      npm.output(await npm.usage)
+      npm.output(npm.usage)
       process.exitCode = 1
       return exitHandler()
     }
@@ -91,7 +91,7 @@ module.exports = async process => {
   } catch (err) {
     if (err.code === 'EUNKNOWNCOMMAND') {
       const didYouMean = require('./utils/did-you-mean.js')
-      const suggestions = await didYouMean(npm, npm.localPrefix, cmd)
+      const suggestions = await didYouMean(npm.localPrefix, cmd)
       npm.output(`Unknown command: "${cmd}"${suggestions}\n`)
       npm.output('To see a list of supported npm commands, run:\n  npm help')
       process.exitCode = 1

lib/commands/access.js

@@ -47,7 +47,7 @@ class Access extends BaseCommand {
     'revoke <scope:team> [<package>]',
   ]
 
-  async completion (opts) {
+  static async completion (opts) {
     const argv = opts.conf.argv.remain
     if (argv.length === 2) {
       return commands

lib/commands/audit.js

@@ -412,7 +412,7 @@ class Audit extends ArboristWorkspaceCmd {
 
   static usage = ['[fix|signatures]']
 
-  async completion (opts) {
+  static async completion (opts) {
     const argv = opts.conf.argv.remain
 
     if (argv.length === 2) {

lib/commands/cache.js

@@ -73,7 +73,7 @@ class Cache extends BaseCommand {
     'verify',
   ]
 
-  async completion (opts) {
+  static async completion (opts) {
     const argv = opts.conf.argv.remain
     if (argv.length === 2) {
       return ['add', 'clean', 'verify', 'ls']

lib/commands/completion.js

@@ -33,8 +33,9 @@ const fs = require('fs/promises')
 const nopt = require('nopt')
 const { resolve } = require('path')
 
+const Npm = require('../npm.js')
 const { definitions, shorthands } = require('../utils/config/index.js')
-const { commands, aliases } = require('../utils/cmd-list.js')
+const { commands, aliases, deref } = require('../utils/cmd-list.js')
 const configNames = Object.keys(definitions)
 const shorthandNames = Object.keys(shorthands)
 const allConfs = configNames.concat(shorthandNames)
@@ -48,7 +49,7 @@ class Completion extends BaseCommand {
   static name = 'completion'
 
   // completion for the completion command
-  async completion (opts) {
+  static async completion (opts) {
     if (opts.w > 2) {
       return
     }
@@ -156,10 +157,14 @@ class Completion extends BaseCommand {
     // at this point, if words[1] is some kind of npm command,
     // then complete on it.
     // otherwise, do nothing
-    const impl = await this.npm.cmd(cmd)
-    if (impl.completion) {
-      const comps = await impl.completion(opts)
-      return this.wrap(opts, comps)
+    try {
+      const { completion } = Npm.cmd(cmd)
+      if (completion) {
+        const comps = await completion(opts, this.npm)
+        return this.wrap(opts, comps)
+      }
+    } catch {
+      // it wasnt a valid command, so do nothing
     }
   }
 
@@ -267,7 +272,7 @@ const cmdCompl = (opts, npm) => {
     return matches
   }
 
-  const derefs = new Set([...matches.map(c => npm.deref(c))])
+  const derefs = new Set([...matches.map(c => deref(c))])
   if (derefs.size === 1) {
     return [...derefs]
   }

lib/commands/config.js

@@ -74,7 +74,7 @@ class Config extends BaseCommand {
 
   static skipConfigValidation = true
 
-  async completion (opts) {
+  static async completion (opts) {
     const argv = opts.conf.argv.remain
     if (argv[1] !== 'config') {
       argv.unshift('config')

lib/commands/deprecate.js

@@ -17,13 +17,13 @@ class Deprecate extends BaseCommand {
 
   static ignoreImplicitWorkspace = false
 
-  async completion (opts) {
+  static async completion (opts, npm) {
     if (opts.conf.argv.remain.length > 1) {
       return []
     }
 
-    const username = await getIdentity(this.npm, this.npm.flatOptions)
-    const packages = await libaccess.getPackages(username, this.npm.flatOptions)
+    const username = await getIdentity(npm, npm.flatOptions)
+    const packages = await libaccess.getPackages(username, npm.flatOptions)
     return Object.keys(packages)
       .filter((name) =>
         packages[name] === 'write' &&

lib/commands/dist-tag.js

@@ -20,7 +20,7 @@ class DistTag extends BaseCommand {
   static workspaces = true
   static ignoreImplicitWorkspace = false
 
-  async completion (opts) {
+  static async completion (opts) {
     const argv = opts.conf.argv.remain
     if (argv.length === 2) {
       return ['add', 'rm', 'ls']

lib/commands/edit.js

@@ -38,8 +38,8 @@ class Edit extends BaseCommand {
 
   // TODO
   /* istanbul ignore next */
-  async completion (opts) {
-    return completion(this.npm, opts)
+  static async completion (opts, npm) {
+    return completion(npm, opts)
   }
 
   async exec (args) {