fix: include all subcommands on main command help (#9099)

Author: wraithgar

docs/lib/index.js

@@ -94,7 +94,7 @@ const getCommandByDoc = (docFile, docExt, commandLoader = defaultCommandLoader)
     name,
     workspaces,
     definitions: name === 'npx' ? {} : resolvedDefs,
-    usage: usage.map(u => `${usagePrefix} ${u}`.trim()).join('\n'),
+    usage: usage?.map(u => `${usagePrefix} ${u}`.trim()).join('\n'),
   }
 }
 

lib/base-cmd.js

@@ -43,10 +43,15 @@ class BaseCommand {
       `${description}`,
       '',
       'Usage:',
-      ...usage.map(u => `npm ${fullCommandName} ${u}`.trim()),
     ]
+    if (usage) {
+      fullUsage.push(...usage.map(u => `npm ${fullCommandName} ${u}`.trim()))
+    }
 
     if (this.subcommands) {
+      for (const sub in this.subcommands) {
+        fullUsage.push(`npm ${fullCommandName} ${sub} ${this.subcommands[sub].usage}`)
+      }
       fullUsage.push('')
       fullUsage.push('Subcommands:')
       const subcommandEntries = Object.entries(this.subcommands)

lib/commands/trust/index.js

@@ -3,6 +3,7 @@ const BaseCommand = require('../../base-cmd.js')
 class Trust extends BaseCommand {
   static description = 'Create a trusted relationship between a package and a OIDC provider'
   static name = 'trust'
+  static usage = null
 
   static subcommands = {
     github: require('./github.js'),

tap-snapshots/test/lib/commands/install.js.test.cjs

@@ -134,7 +134,7 @@ silly logfile done cleaning log files
 verbose stack Error: The developer of this package has specified the following through devEngines
 verbose stack Invalid devEngines.runtime
 verbose stack Invalid name "nondescript" does not match "node" for "runtime"
-verbose stack     at Install.checkDevEngines ({CWD}/lib/base-cmd.js:242:27)
+verbose stack     at Install.checkDevEngines ({CWD}/lib/base-cmd.js:247:27)
 verbose stack     at MockNpm.execCommandClass ({CWD}/lib/npm.js:292:7)
 verbose stack     at MockNpm.exec ({CWD}/lib/npm.js:193:9)
 error code EBADDEVENGINES
@@ -199,7 +199,7 @@ warn EBADDEVENGINES }
 verbose stack Error: The developer of this package has specified the following through devEngines
 verbose stack Invalid devEngines.runtime
 verbose stack Invalid name "nondescript" does not match "node" for "runtime"
-verbose stack     at Install.checkDevEngines ({CWD}/lib/base-cmd.js:242:27)
+verbose stack     at Install.checkDevEngines ({CWD}/lib/base-cmd.js:247:27)
 verbose stack     at MockNpm.execCommandClass ({CWD}/lib/npm.js:292:7)
 verbose stack     at MockNpm.exec ({CWD}/lib/npm.js:193:9)
 error code EBADDEVENGINES
@@ -225,7 +225,7 @@ silly logfile done cleaning log files
 verbose stack Error: The developer of this package has specified the following through devEngines
 verbose stack Invalid devEngines.runtime
 verbose stack Invalid name "nondescript" does not match "node" for "runtime"
-verbose stack     at Install.checkDevEngines ({CWD}/lib/base-cmd.js:242:27)
+verbose stack     at Install.checkDevEngines ({CWD}/lib/base-cmd.js:247:27)
 verbose stack     at MockNpm.execCommandClass ({CWD}/lib/npm.js:292:7)
 verbose stack     at MockNpm.exec ({CWD}/lib/npm.js:193:9)
 error code EBADDEVENGINES

tap-snapshots/test/lib/docs.js.test.cjs

@@ -5782,7 +5782,11 @@ exports[`test/lib/docs.js TAP usage trust > must match snapshot 1`] = `
 Create a trusted relationship between a package and a OIDC provider
 
 Usage:
-npm trust
+npm trust github [package] --file [--repo|--repository] [--env|--environment] [-y|--yes]
+npm trust gitlab [package] --file [--project|--repo|--repository] [--env|--environment] [-y|--yes]
+npm trust circleci [package] --org-id <uuid> --project-id <uuid> --pipeline-definition-id <uuid> --vcs-origin <origin> [--context-id <uuid>...] [-y|--yes]
+npm trust list [package]
+npm trust revoke [package] --id=<trust-id>
 
 Subcommands:
   github
@@ -5805,7 +5809,7 @@ Run "npm trust <subcommand> --help" for more info on a subcommand.
 Run "npm help trust" for more info
 
 \`\`\`bash
-npm trust
+
 \`\`\`
 
 Note: This command is unaware of workspaces.

test/lib/base-cmd.js

@@ -221,6 +221,7 @@ t.test('getUsage() with no params and no definitions', async t => {
   class TestCommand extends BaseCommand {
     static name = 'test-command'
     static description = 'Test command description'
+    static usage = ['']
   }
 
   const usage = TestCommand.describeUsage