fix: indicate whether an argument is optional in the help command (#1453) (#1482)

* fix: indicate whether an argument is optional in the help command (#1453)

* test: update help unit tests

---------

Co-authored-by: Matthew Yarmolinsky <yarmolinskymatthew@gmail.com>

Author: mdonnalley

src/help/command.ts

@@ -59,7 +59,8 @@ export class CommandHelp extends HelpFormatter {
 
     return args.map((a) => {
       // Add ellipsis to indicate that the argument takes multiple values if strict is false
-      const name = this.command.strict === false ? `${a.name.toUpperCase()}...` : a.name.toUpperCase()
+      let name = this.command.strict === false ? `${a.name.toUpperCase()}...` : a.name.toUpperCase()
+      name = a.required ? `${name}` : `[${name}]`
       let description = a.description || ''
       if (a.default)
         description = `${colorize(this.config?.theme?.flagDefaultValue, `[default: ${a.default}]`)} ${description}`

test/help/format-command-with-options.test.ts

@@ -46,7 +46,7 @@ multiline help`,
     <value>] [-l <value>]
 
 ARGUMENTS
-  APP_NAME  app to use
+  [APP_NAME]  app to use
 
 OPTIONS
   -f, --foo=foo        foobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoo
@@ -95,7 +95,7 @@ ALIASES
     <value>]
 
 ARGUMENTS
-  APP_NAME
+  [APP_NAME]
       app to useapp to useapp to useapp to useapp to useapp to useapp to useapp to
       useapp to useapp to useapp to useapp to useapp to useapp to useapp to useapp
       to useapp to useapp to useapp to useapp to useapp to useapp to useapp to
@@ -144,7 +144,7 @@ ALIASES
     <value>]
 
 ARGUMENTS
-  APP_NAME
+  [APP_NAME]
       app to useapp to useapp to useapp to useapp to useapp to useapp to useapp to
       useapp to useapp to useapp to useapp to useapp to useapp to useapp to useapp
       to useapp to useapp to useapp to useapp to useapp to useapp to useapp to
@@ -198,7 +198,7 @@ ALIASES
   $ oclif apps:create [APP_NAME] [--force]
 
 ARGUMENTS
-  APP_NAME  app to use
+  [APP_NAME]  app to use
 
 OPTIONS
   --force  forces
@@ -269,9 +269,9 @@ OPTIONS
     <value>] [--flag3 <value>]
 
 ARGUMENTS
-  ARG1  [default: .]
-  ARG2  [default: .] arg2 desc
-  ARG3  arg3 desc
+  [ARG1]  [default: .]
+  [ARG2]  [default: .] arg2 desc
+  [ARG3]  arg3 desc
 
 OPTIONS
   --flag1=flag1  [default: .]
@@ -312,7 +312,7 @@ OPTIONS
   $ oclif apps:create [ARG1]
 
 ARGUMENTS
-  ARG1  (option1|option2) Show the options`)
+  [ARG1]  (option1|option2) Show the options`)
     })
   })
 

test/help/format-command.test.ts

@@ -48,7 +48,7 @@ multiline help`,
     [-r <value>] [-l <value>]
 
 ARGUMENTS
-  APP_NAME  app to use
+  [APP_NAME]  app to use
 
 FLAGS
   -f, --foo=<value>     foobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfo
@@ -131,7 +131,7 @@ DESCRIPTION
     [-r <value>]
 
 ARGUMENTS
-  APP_NAME
+  [APP_NAME]
       app to useapp to useapp to useapp to useapp to useapp to useapp to useapp to
       useapp to useapp to useapp to useapp to useapp to useapp to useapp to useapp
       to useapp to useapp to useapp to useapp to useapp to useapp to useapp to
@@ -188,7 +188,7 @@ ALIASES
     [-r <value>]
 
 ARGUMENTS
-  APP_NAME
+  [APP_NAME]
       app to useapp to useapp to useapp to useapp to useapp to useapp to useapp to
       useapp to useapp to useapp to useapp to useapp to useapp to useapp to useapp
       to useapp to useapp to useapp to useapp to useapp to useapp to useapp to
@@ -285,7 +285,7 @@ DESCRIPTION
   $ oclif apps:create [APP_NAME] [--json] [--force]
 
 ARGUMENTS
-  APP_NAME  app to use
+  [APP_NAME]  app to use
 
 FLAGS
   --force  forces
@@ -474,9 +474,9 @@ FLAGS
     <value>] [--flag3 <value>]
 
 ARGUMENTS
-  ARG1  [default: .]
-  ARG2  [default: .] arg2 desc
-  ARG3  arg3 desc
+  [ARG1]  [default: .]
+  [ARG2]  [default: .] arg2 desc
+  [ARG3]  arg3 desc
 
 FLAGS
   --flag1=<value>  [default: .]
@@ -606,7 +606,7 @@ FLAG DESCRIPTIONS
   $ oclif apps:create [ARG1]
 
 ARGUMENTS
-  ARG1  (option1|option2) Show the options`)
+  [ARG1]  (option1|option2) Show the options`)
     })
 
     it('should output arg with ... if static is false', async () => {
@@ -625,7 +625,7 @@ ARGUMENTS
   $ oclif apps:create [ARG1...]
 
 ARGUMENTS
-  ARG1...  Show the options`)
+  [ARG1...]  Show the options`)
     })
   })