fix: show argument options in help (#26)

oclif · Jun 6, 2018 · 0c8d1bf · 0c8d1bf
1 parent 52150c0
commit 0c8d1bf
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/src/command.ts b/src/command.ts
@@ -96,6 +96,7 @@ export default class CommandHelp {
       const name = a.name.toUpperCase()
       let description = a.description || ''
       if (a.default) description = `[default: ${a.default}] ${description}`
+      if (a.options) description = `(${a.options.join('|')}) ${description}`
       return [name, description ? dim(description) : undefined]
     }), {stripAnsi: this.opts.stripAnsi, maxWidth: this.opts.maxWidth - 2})
     return [

diff --git a/test/command.test.ts b/test/command.test.ts
@@ -173,6 +173,19 @@ OPTIONS
   --flag2=flag2  [default: .] flag2 desc
   --flag3=flag3  flag3 desc`))
 
+  test
+  .commandHelp(class extends Command {
+    static id = 'apps:create'
+    static args = [
+      {name: 'arg1', description: 'Show the options', options: ['option1', 'option2']}
+    ]
+  })
+  .it('outputs with possible options', ctx => expect(ctx.commandHelp).to.equal(`USAGE
+  $ oclif apps:create [ARG1]
+
+ARGUMENTS
+  ARG1  (option1|option2) Show the options`))
+
   // class AppsCreate3 extends Command {
   //   static id = 'apps:create'
   //   static flags = {