stefanprodan / timoni

Timoni is a package manager for Kubernetes, powered by CUE and inspired by Helm.
https://timoni.sh
Apache License 2.0
1.58k stars 70 forks source link

Fix CLI autocompletion on ZSH when installed with Homebrew #443

Closed natemccurdy closed 4 days ago

natemccurdy commented 1 week ago

Summary

Prior to this, when installing Timoni using Homebrew on a Mac with ZSH, CLI autocompletion would not work.

After this change, CLI autocompletion works after installation or reinstallation via Homebrew.

The problem is that the completion function that Homebrew wrote to /opt/homebrew/share/zsh/site-functions/ did not start with an underscore, _.

By convention, completion function names (and the files containing them) should start with an underscore followed by the name of the command they provide completions for. When ZSH's completion system is initialized (usually through the compinit function), it automatically looks for files in the fpath directories that start with an underscore.

Before this change

Autocompletion on MacOS with ZSH did not work: broken

After this change

Autocompletion on MacOS with ZSH works. To test this, I just renamed /opt/homebrew/share/zsh/site-functions/timoni to /opt/homebrew/share/zsh/site-functions/_timoni then opened a new shell. fixed