fix: clean up usage output

Removed usage lib, rolled logic into base-command.js Cleaned up usage output to be less redundant
npm · Mar 24, 2022 · 38a97e6 · 38a97e6
1 parent 53c2f43
commit 38a97e6
Show file tree

Hide file tree

Showing 18 changed files with 127 additions and 401 deletions.
diff --git a/lib/base-command.js b/lib/base-command.js
@@ -2,10 +2,11 @@
 
 const { relative } = require('path')
 
-const usageUtil = require('./utils/usage.js')
 const ConfigDefinitions = require('./utils/config/definitions.js')
 const getWorkspaces = require('./workspaces/get-workspaces.js')
 
+const cmdAliases = require('./utils/cmd-list').aliases
+
 class BaseCommand {
   constructor (npm) {
     this.wrapWidth = 80
@@ -25,28 +26,43 @@ class BaseCommand {
   }
 
   get usage () {
-    let usage = [
-      `npm ${this.constructor.name}\n`,
-      `${this.constructor.description}\n`,
-      `Usage:\n`,
-    ].join('\n')
+    const usage = [
+      `${this.constructor.description}`,
+      '',
+      'Usage:',
+    ]
 
     if (!this.constructor.usage) {
-      usage = `${usage}npm ${this.constructor.name}`
+      usage.push(`npm ${this.constructor.name}`)
     } else {
-      usage = `${usage}${this.constructor.usage
-        .map(u => `npm ${this.constructor.name} ${u}`)
-        .join('\n')}`
+      usage.push(...this.constructor.usage.map(u => `npm ${this.constructor.name} ${u}`))
     }
 
     if (this.constructor.params) {
-      usage = `${usage}\n\nOptions:\n${this.wrappedParams}`
+      usage.push('')
+      usage.push('Options:')
+      usage.push(this.wrappedParams)
     }
 
-    // Mostly this just appends aliases, this could be more clear
-    usage = usageUtil(this.constructor.name, usage)
-    usage = `${usage}\n\nRun "npm help ${this.constructor.name}" for more info`
-    return usage
+    const aliases = Object.keys(cmdAliases).reduce((p, c) => {
+      if (cmdAliases[c] === this.constructor.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.constructor.name}" for more info`)
+
+    return usage.join('\n')
   }
 
   get wrappedParams () {
@@ -69,7 +85,7 @@ class BaseCommand {
     if (prefix) {
       prefix += '\n\n'
     }
-    return Object.assign(new Error(`\nUsage: ${prefix}${this.usage}`), {
+    return Object.assign(new Error(`\n${prefix}${this.usage}`), {
       code: 'EUSAGE',
     })
   }

diff --git a/lib/utils/usage.js b/lib/utils/usage.js
diff --git a/scripts/config-doc-command.js b/scripts/config-doc-command.js
@@ -1,5 +1,5 @@
 const { definitions } = require('../lib/utils/config/index.js')
-const usageFn = require('../lib/utils/usage.js')
+const cmdAliases = require('../lib/utils/cmd-list').aliases
 const { writeFileSync, readFileSync } = require('fs')
 const { resolve } = require('path')
 
@@ -52,9 +52,19 @@ const describeUsage = ({ usage }) => {
         synopsis.push(usage.map(usageInfo => `${baseCommand} ${usageInfo}`).join('\n'))
       }
 
-      const aliases = usageFn(commandName, '').trim()
-      if (aliases) {
-        synopsis.push(`\n${aliases}`)
+      const aliases = Object.keys(cmdAliases).reduce((p, c) => {
+        if (cmdAliases[c] === commandName) {
+          p.push(c)
+        }
+        return p
+      }, [])
+
+      if (aliases.length === 1) {
+        synopsis.push('')
+        synopsis.push(`alias: ${aliases[0]}`)
+      } else if (aliases.length > 1) {
+        synopsis.push('')
+        synopsis.push(`aliases: ${aliases.join(', ')}`)
       }
     }
   } else {