Specialcharactersnotescapedforzshcompletionscript

Rust Version

rustc 1.38.0 (625451e37 2019-09-23)

Affected Version of clap

clap 2.33.0

Expected Behavior Summary

Generated Zsh completions correctly complete

even in the presence of characters that have a special meaning for the shell

Actual Behavior Summary

For example, when some string in

contains

(a pipe) the generated completion script fails with

when pressing tab for that argument.
That was the problem I ran into. I then tested some other special characters.

A sample of the characters I found to have problems:
-

breaks completion script

-

splits completion value into two
-

makes whole value not show up in completions
-

makes whole value not show up in completions
-

breaks completion script

-

breaks completion script

-

interpreted as https://www.gnu.org/software/bash/manual/html_node/Special-Parameters.html when followed by some other chars
-

makes whole value not show up in completions

There are more special characters, that need to be escaped. The reproduction from the repo tests against all non control ascii characters and some dollar-something strings.

Steps to Reproduce the issue

• Clone reproduction repo
  

  1	git clone https://github.com/succcubbus/clap-zsh-completions-repro

  
  


• 
  

  1	cd clap-zsh-completions-repro

  
  


• 
  

  1	cargo run --release > _clap-zsh-completions-repro

  
  


• Copy
  

  1	_clap-zsh-completions-repro

  somewhere into the

  1

  $fpath

  of the zsh (e.g.

  1	/usr/local/share/zsh/site-functions

  )



• 
  

  1	cargo install --path .

  
  


• 
  

  1	rehash; compinit

  (so the zsh picks up the new binary and completions)



• Type
  

  1	clap-zsh-completions-repro

  and try to complete the argument

Sample Code or Link to Sample Code

https://github.com/succcubbus/clap-zsh-completions-repro

Debug output

https://pastebin.com/KU4yd6FR

该提问来源于开源项目：clap-rs/clap