Support tab auto-completion?

[catanzaromj]

Hello! Thank you for writing a really nice package. It seems like exactly the type of thing I've been looking for.

Is it possible to implement tab autocompletion for the commands that are available to the developer? I'm not sure how much work this would be, but I think it would really improve the user experience of spin. I'm aware of how to do this directly in bash for things like Makefiles, but for the reasons listed in your README, I'm looking to move away from that workflow. Thanks for any help you can provide.

Edit: It seems like this might not be as involved as I originally thought, at least using the click shell completion: https://click.palletsprojects.com/en/stable/shell-completion/

[stefanv]

I had no idea how to do this, so thanks for doing the research!

The recommendation in the click docs works for me in ZSH:

eval "$(_SPIN_COMPLETE=zsh_source spin)"

So, perhaps we just add some examples to our README?

[stefanv]

(One "bug" here is that the commands are not listed in the same order as they appear; the docs go into the weeds on how to work around such issues, but IMO it's not worth it.)

[catanzaromj]

I couldn't get the eval version you used to work on bash. Instead I did the second route of saving the completion script to a file and executing that in my ~/.bashrc. It worked great!

What does your version of the command look like with multiple repositories on the same computer, each using spin?

[stefanv]

Just double checking, but the bash version didn't work for you?

eval "$(_SPIN_COMPLETE=bash_source spin)"

[stefanv]

What does your version of the command look like with multiple repositories on the same computer, each using spin?

I use zsh, and the above command, and then auto-completion magically works in all my repos 🤷‍♂

[catanzaromj]

Just double checking, but the bash version didn't work for you?

When I enter eval "$(_SPIN_COMPLETE=bash_source spin)" at the terminal, autocomplete works for that session. When I add it to ~/.bashrc, my terminal opens with

Could not load configuration from one of: .spin.toml, spin.toml, pyproject.toml

The second bit they recommend works great for me (with modifications):

Save the script somewhere.

_SPIN_COMPLETE=bash_source spin > ~/.spin-complete.bash

Source the file in ~/.bashrc.

. ~/.spin-complete.bash

and this works in all my repos as well. (I thought I checked in two separate repos but either I forgot or maybe I didn't restart the shell.)

[stefanv]

That method works for me as well; so, happy to add that to the README, if you want.

[catanzaromj]

I think that would be helpful for others. Thanks against for a great package!

[stefanv]

See #273