fix: support options/sub-commands in zsh completion

trevorlinton · bcoe · commit 0a96394f3b31 · 2019-02-17T19:36:23.000-08:00
diff --git a/completion.zsh.hbs b/completion.zsh.hbs
@@ -9,7 +9,7 @@ _{{app_name}}_yargs_completions()
 {
   local reply
   local si=$IFS
-  IFS=$'\n' reply=($(COMP_CWORD="$((CURRENT-1))" COMP_LINE="$BUFFER" COMP_POINT="$CURSOR" {{app_path}} --get-yargs-completions "$\{words[@]\}"))
+  IFS=$'\n' reply=($(COMP_CWORD="$((CURRENT-1))" COMP_LINE="$BUFFER" COMP_POINT="$CURSOR" {{app_path}} --get-yargs-completions "${words[@]}"))
   IFS=$si
   _describe 'values' reply
 }
diff --git a/lib/completion.js b/lib/completion.js
@@ -17,6 +17,7 @@ module.exports = function completion (yargs, usage, command) {
     const current = args.length ? args[args.length - 1] : ''
     const argv = yargs.parse(args, true)
     const aliases = yargs.parsed.aliases
+    const parentCommands = yargs.getContext().commands
 
     // a custom completion function can be provided
     // to completion().
@@ -55,7 +56,7 @@ module.exports = function completion (yargs, usage, command) {
       }
     }
 
-    if (!current.match(/^-/)) {
+    if (!current.match(/^-/) && parentCommands[parentCommands.length - 1] !== current) {
       usage.getCommands().forEach((usageCommand) => {
         const commandName = command.parseCommand(usageCommand[0]).cmd
         if (args.indexOf(commandName) === -1) {
@@ -69,7 +70,7 @@ module.exports = function completion (yargs, usage, command) {
       })
     }
 
-    if (current.match(/^-/)) {
+    if (current.match(/^-/) || (current === '' && completions.length === 0)) {
       const descs = usage.getDescriptions()
       Object.keys(yargs.getOptions().key).forEach((key) => {
         // If the key and its aliases aren't in 'args', add the key to 'completions'
@@ -80,7 +81,7 @@ module.exports = function completion (yargs, usage, command) {
             completions.push(`--${key}`)
           } else {
             const desc = descs[key] || ''
-            completions.push(`--${key.replace(/:/g, '\\:')}:${desc}`)
+            completions.push(`--${key.replace(/:/g, '\\:')}:${desc.replace('__yargsString__:', '')}`)
           }
         }
       })
diff --git a/test/completion.js b/test/completion.js
@@ -181,7 +181,7 @@ describe('Completion', () => {
 
       r.logs.should.have.length(2)
       r.logs.should.include('--bar:bar option')
-      r.logs.should.include('--help:__yargsString__:Show help')
+      r.logs.should.include('--help:Show help')
     })
 
     it('completes options for the correct command', () => {
@@ -460,4 +460,21 @@ describe('Completion', () => {
     r.errors.length.should.equal(0)
     r.logs.should.include('--foo:bar')
   })
+  it('when using subcommands ensure early bailout if full command is typed (zsh)', () => {
+    process.env.SHELL = '/bin/zsh'
+    const r = checkUsage(() => {
+      try {
+        return yargs(['./completion', '--get-yargs-completions', 'dream'])
+          .commandDir('./fixtures/cmddir', { 'recurse': true })
+          .demand(1)
+          .strict()
+          .completion()
+          .argv
+      } catch (e) {
+        console.log(e.message)
+      }
+    })
+    r.errors.length.should.equal(0)
+    r.logs.should.include('of-memory:Dream about a specific memory')
+  })
 })

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ _{{app_name}}_yargs_completions()`
`9`	`9`	`{`
`10`	`10`	`local reply`
`11`	`11`	`local si=$IFS`
`12`		`- IFS=$'\n' reply=($(COMP_CWORD="$((CURRENT-1))" COMP_LINE="$BUFFER" COMP_POINT="$CURSOR" {{app_path}} --get-yargs-completions "$\{words[@]\}"))`
	`12`	`+ IFS=$'\n' reply=($(COMP_CWORD="$((CURRENT-1))" COMP_LINE="$BUFFER" COMP_POINT="$CURSOR" {{app_path}} --get-yargs-completions "${words[@]}"))`
`13`	`13`	`IFS=$si`
`14`	`14`	`_describe 'values' reply`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ module.exports = function completion (yargs, usage, command) {`
`17`	`17`	`const current = args.length ? args[args.length - 1] : ''`
`18`	`18`	`const argv = yargs.parse(args, true)`
`19`	`19`	`const aliases = yargs.parsed.aliases`
	`20`	`+ const parentCommands = yargs.getContext().commands`
`20`	`21`
`21`	`22`	`// a custom completion function can be provided`
`22`	`23`	`// to completion().`
`@@ -55,7 +56,7 @@ module.exports = function completion (yargs, usage, command) {`
`55`	`56`	`}`
`56`	`57`	`}`
`57`	`58`
`58`		`- if (!current.match(/^-/)) {`
	`59`	`+ if (!current.match(/^-/) && parentCommands[parentCommands.length - 1] !== current) {`
`59`	`60`	`usage.getCommands().forEach((usageCommand) => {`
`60`	`61`	`const commandName = command.parseCommand(usageCommand[0]).cmd`
`61`	`62`	`if (args.indexOf(commandName) === -1) {`
`@@ -69,7 +70,7 @@ module.exports = function completion (yargs, usage, command) {`
`69`	`70`	`})`
`70`	`71`	`}`
`71`	`72`
`72`		`- if (current.match(/^-/)) {`
	`73`	`+ if (current.match(/^-/) \|\| (current === '' && completions.length === 0)) {`
`73`	`74`	`const descs = usage.getDescriptions()`
`74`	`75`	`Object.keys(yargs.getOptions().key).forEach((key) => {`
`75`	`76`	`// If the key and its aliases aren't in 'args', add the key to 'completions'`
`@@ -80,7 +81,7 @@ module.exports = function completion (yargs, usage, command) {`
`80`	`81`	completions.push(`--${key}`)
`81`	`82`	`} else {`
`82`	`83`	`const desc = descs[key] \|\| ''`
`83`		- completions.push(`--${key.replace(/:/g, '\\:')}:${desc}`)
	`84`	+ completions.push(`--${key.replace(/:/g, '\\:')}:${desc.replace('__yargsString__:', '')}`)
`84`	`85`	`}`
`85`	`86`	`}`
`86`	`87`	`})`