Add autocompletion generation for more shells

[falzm]

This change adds shell autocompletion support for Fish, PowerShell &
Zsh.

[shortcut-integration]

This pull request has been linked to Clubhouse Story #30750: Aditional shell completion for exo cli.

[zyegfryed]

Can't wait to test it with my zsh shell!

[retrack]

I cannot get it to work properly and get the below on zsh: (-> is tab)

acr@mbp13ar-3 zsh % exo li-> _arguments:comparguments:325: invalid option definition: (-C --config)-C[Specify an alternate config file [env EXOSCALE_CONFIG]]:

did you manage to get is work ?

[falzm]

@retrack indeed Zsh seems to require completion files to begin with an underscore.

[falzm]

@zyegfryed can you confirm it works with your zsh shell?

[retrack]

@zyegfryed can you confirm it works with your zsh shell?

@falzm can you remind me how to run a local release with goreleaser? maybe using the output of that will help. I tested doing make build and make completions and then moving the file around. But there might be more to it and I am not a zsh user, good old bash and a mile long .bash_profile ...

[zyegfryed]

@zyegfryed can you confirm it works with your zsh shell?

@falzm can you remind me how to run a local release with goreleaser? maybe using the output of that will help. I tested doing make build and make completions and then moving the file around. But there might be more to it and I am not a zsh user, good old bash and a mile long .bash_profile ...

I'm doing the same and having the exact some behavior as you. I also remove the .zcompdump files on my home directory (rm .zcompdump*), but still the same issue with wrong argument...
Will continue to try to make it work and will keep you update don my progress.

[falzm]

Same, not a zsh user so I'm not sure what I'm doing wrong here...

@retrack you can run goreleaser build --snapshot --rm-dist at the root of the source tree.

[zyegfryed]

@falzm @retrack OK, I understand what's the issue: in our commands description we sometime refer to a way to define an option via an environment variable, for example, the config option. To do so, we surround the environment variable with brackets in the description – i.e. [env EXOSCALE_CONFIG], which breaks the _autocomplete function.
A quick fix would be to use parentheses instead. Doable?

[zyegfryed]

^^ an alternate solution will be to escape the bracket from the description. But I guess we'll need to modify the underlying library (cobra) to do so, wouldn't we?

Edit: already mentionned in cobra project as Issue spf13/cobra#989 (mentioning a closed PR spf13/cobra#899)

^^ bumping cobra to v1.1.0 should fix the issue since a revamped auto-completion for zsh was rolled out in that release.

[falzm]

^^ bumping cobra to v1.1.0 should fix the issue since a revamped auto-completion for zsh was rolled out in that release.

@zyegfryed cool, good thing that I have an on-going branch where I've upgraded Cobra to the latest version then. Thank you for looking into this!

[falzm]

@zyegfryed I've updated the branch, can I ask you for a new test?

[zyegfryed]

@zyegfryed I've updated the branch, can I ask you for a new test?

Sure. Test coming...

[zyegfryed]

So, completion works as expected for the first level commands/options, but fails when going deeper:

~ ❯ exo v<TAB>                                                                                                                                                                                                                                                                                                                                                    
version  -- Print the version of exo
vm       -- Compute instances management

~ ❯ exo --c<TAB>
~ ❯ exo --config

but, this will fail:

~ ❯ exo vm cre
_arguments:comparguments:325: invalid option definition: (-C --config)-C[Specify an alternate config file [env EXOSCALE_CONFIG]]:

[zyegfryed]

^^ forget my previous comment, I forgot to delete the completion history or made another mistake while trying it, and after cleaning and re-installing it works as expected! GG! 🎉