feat: Add 'helpLabel' flag option (#49)

This feature adds a new flag option (helpLabel) which takes the place of the flag label when displaying flag usage.
oclif · Apr 29, 2019 · 769ec91 · 769ec91
1 parent dc641a0
commit 769ec91
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/src/flags.ts b/src/flags.ts
@@ -8,6 +8,7 @@ export type IFlagBase<T, I> = {
   name: string
   char?: AlphabetLowercase | AlphabetUppercase
   description?: string
+  helpLabel?: string
   hidden?: boolean
   required?: boolean
   dependsOn?: string[],

diff --git a/src/help.ts b/src/help.ts
@@ -11,8 +11,13 @@ const m = Deps()
 export interface FlagUsageOptions { displayRequired?: boolean }
 export function flagUsage(flag: IFlag<any>, options: FlagUsageOptions = {}): [string, string | undefined] {
   const label = []
-  if (flag.char) label.push(`-${flag.char}`)
-  if (flag.name) label.push(` --${flag.name}`)
+
+  if (flag.helpLabel) {
+    label.push(flag.helpLabel)
+  } else {
+    if (flag.char) label.push(`-${flag.char}`)
+    if (flag.name) label.push(` --${flag.name}`)
+  }
 
   const usage = flag.type === 'option' ? ` ${flag.name.toUpperCase()}` : ''
 

diff --git a/test/help.test.ts b/test/help.test.ts
@@ -13,10 +13,14 @@ describe('flagUsage', () => {
       flags.string({name: 'baz', description: 'baz'}),
       flags.string({name: 'bar', char: 'b', description: 'bar'}),
       flags.string({name: 'foo', char: 'f', description: 'desc'}),
+      flags.string({name: 'foo', char: 'f', helpLabel: '-f'}),
+      flags.boolean({char: 'g', description: 'goo'}),
     ]
     expect(flagUsages(f)).to.deep.equal([
       [' -b, --bar BAR', 'bar'],
       [' -f, --foo FOO', 'desc'],
+      [' -f FOO', undefined],
+      [' -g', 'goo'],
       [' --bak BAK', undefined],
       [' --baz BAZ', 'baz'],
     ])