How can I load Homebrew's Zsh Completions?

[metebyte]

Hello,

As I mentioned on the title, Is there a way to load Homebrew's Zsh Completions located at /usr/local/share/zsh/site-functions? And Is it okay to load those completions along with ZI?

[ss-o]

[ss-o]

🧙‍‍♀️ Here is my suggestion 🧙‍‍♀️

It will also be put under full ZI control to avoid conflicts with other apps and prevents leaks and other pollution.

zi has'brew' id-as'brew-completions' wait as'completion' lucid \
   atclone='print Installing Brew completions...; mkdir -p $ZPFX/brew_stuff; \
   command cp -f $(brew --prefix)/share/zsh/site-functions/^_* $ZPFX/brew_stuff; \
zi creinstall -q $(brew --prefix)/share/zsh/site-functions' \
   atload='fpath=( ${(u)fpath[@]:#$(brew --prefix)/share/zsh/*} ); fpath+=( $ZPFX/brew_stuff )' \
   atpull="%atclone" run-atpull for \
     z-shell/null

After this, you need to call zicompinit, and it has to be called at the right time, see:
calling-compinit-with-turbo-mode

Finally, I recommend setting ZI[ZCOMPDUMP_PATH] if completions are managed by ZI. More:
customization#-customizing-paths

We can discuss the lines if needed 😵‍💫 It is important to understand how ZI works - and it's pretty easy 🤓 The SECRET KEY 🗝️ is just to get the point 🙇‍‍♂️

[ss-o]

By the way, forgot to mention that these complex functions can be written as a package.

If there would be a group of complex commands then all can be written as a meta-plugin.

The complex command above would look like this:

zi pack for brew-stuff

Additionally, packages can be written with different configurations and chosen when required:

zi pack'mac-fpath' for brew-stuff
zi pack'zi-zpfx' for brew-stuff

[metebyte]

🧙‍‍♀️ Here is my suggestion 🧙‍‍♀️

It will also be put under full ZI control to avoid conflicts with other apps and prevents leaks and other pollution.

zi has'brew' id-as'brew-completions' wait as'completion' lucid \
   atclone='print Installing Brew completions...; mkdir -p $ZPFX/brew_stuff; \
   command cp -f $(brew --prefix)/share/zsh/site-functions/^_* $ZPFX/brew_stuff; \
zi creinstall -q $(brew --prefix)/share/zsh/site-functions' \
   atload='fpath=( ${(u)fpath[@]:#$(brew --prefix)/share/zsh*} ); fpath+=( $ZPFX/brew_stuff )' \
   atpull="%atclone" run-atpull for \
     z-shell/null

After this, you need to call zicompinit, and it has to be called at the right time, see: calling-compinit-with-turbo-mode

Finally, I recommend setting ZI[ZCOMPDUMP_PATH] if completions are managed by ZI. More: customization#-customizing-paths

We can discuss the lines if needed 😵‍💫 It is important to understand how ZI works - and it's pretty easy 🤓 The SECRET KEY 🗝️ is just to get the point 🙇‍‍♂️

This is exactly what I was looking for. Thanks.

[metebyte]

By the way, forgot to mention that these complex functions can be written as a package.

If there would be a group of complex commands then all can be written as a meta-plugin.

The complex command above would look like this:

zi pack for brew-stuff

Additionally, packages can be written with different configurations and chosen when required:

zi pack'mac-fpath' for brew-stuff
zi pack'zi-zpfx' for brew-stuff

Is there a difference between this way and packaging way? I mean about performance or avoiding misconfiguration with other ZI stuff?

[ss-o]

A package is a set of instructions as it would be in .zshrc or written by you - no difference.
So you can have long and complex commands or clean and good-looking .zshrc. 😎

[metebyte]

So here's my first experience 😄

After loading completions with the method you mentioned above, I got this error with git completions.

$ git com[TAB]

turned into this

$ git comgit com
_git:.:48: no such file or directory:

[ss-o]

@metebyte,

Try zi pack for brew-completions

[metebyte]

I will 👌 Btw Is GitHub Discussions only option for communicating?

[ss-o]

https://join.slack.com/t/z-shell/shared_invite/zt-16twpopd2-p08ROUeT2aGZ5njJwysawA

[ss-o]

I will ok_hand Btw Is GitHub Discussions only option for communicating?

Which you prefer?

[metebyte]

https://join.slack.com/t/z-shell/shared_invite/zt-16twpopd2-p08ROUeT2aGZ5njJwysawA

That is what I was looking for 🙃

[j9ac9k]

Hello z-shell devs, I'm having the same issue that the author is having, the fixes suggested here haven't worked for me, with what I am sure that's because of something else that is conflicting in my .zshrc

Here are the contents of my .zshrc

# Fig pre block. Keep at the top of this file.
. "$HOME/.fig/shell/zshrc.pre.zsh"
export CLICOLOR=1

if [[ ! -f $HOME/.zi/bin/zi.zsh ]]; then
  print -P "%F{33}▓▒░ %F{160}Installing (%F{33}z-shell/zi%F{160})…%f"
  command mkdir -p "$HOME/.zi" && command chmod g-rwX "$HOME/.zi"
  command git clone -q --depth=1 --branch "main" https://github.com/z-shell/zi "$HOME/.zi/bin" && \
    print -P "%F{33}▓▒░ %F{34}Installation successful.%f%b" || \
    print -P "%F{160}▓▒░ The clone has failed.%f%b"
fi
source "$HOME/.zi/bin/zi.zsh"
autoload -Uz _zi
(( ${+_comps} )) && _comps[zi]=_zi
# examples here -> https://z.digitalclouds.dev/ecosystem/annexes
# zicompinit # <- https://z.digitalclouds.dev/docs/guides/commands

# zi has'brew' wait lucid id-as'brew-comps' as'completion' atclone'mkdir -p $ZPFX/brew_stuff; \
#   command cp -f $(brew --prefix)/share/zsh/site-functions/^_* $ZPFX/brew_stuff; \
#     zi creinstall -q $(brew --prefix)/share/zsh/site-functions' atpull'%atclone' \
#       atload'fpath=( ${(u)fpath[@]:#$ZPFX/share/zsh/*} ); fpath+=( $ZPFX/brew_stuff )' for \
#         z-shell/null

# theme
zi ice pick"async.zsh" src"pure.zsh"
zi light sindresorhus/pure

# fzf
zi ice lucid wait has'fzf'
zi light Aloxaf/fzf-tab

# Completions
zi pack for brew-completions

zi wait lucid for \
 atinit"ZI[COMPINIT_OPTS]=-C; zicompinit; zicdreplay" \
    z-shell/F-Sy-H \
 blockf \
    zsh-users/zsh-completions \
 atload"!_zsh_autosuggest_start" \
    zsh-users/zsh-autosuggestions

zi ice lucid wait as'completion' blockf has'pandoc'
zi light srijanshetty/zsh-pandoc-completion

zi ice lucid wait as'completion' blockf has'mpv'
zi snippet https://github.com/mpv-player/mpv/blob/master/etc/_mpv.zsh

# zi ice lucid wait as'completion' blockf mv'git-completion.zsh -> _git'
# zi snippet https://github.com/git/git/blob/master/contrib/completion/git-completion.zsh

zi wait lucid as'completion' blockf mv'*.zsh -> _git' for \
  felipec/git-completion

# zi wait lucid as'completion' blockf mv'*.zsh -> $ZPFX/brew_stuff/_git' \
#   atload'zstyle ':completion:*:*:git:*' script $ZPFX/brew_stuff/_git' for \
#     felipec/git-completion

zi ice lucid wait as'completion' blockf has'ffmpeg'
zi snippet https://github.com/zsh-users/zsh/blob/master/Completion/Unix/Command/_ffmpeg

zi ice lucid wait as'completion' blockf has'pip'
zi snippet "$SHELL_COMMON/zsh/completions/_pip"

zi light z-shell/z-a-bin-gem-node
zi pack for ls_colors

zi pack"bgn" git for pyenv
# pyenv virtualenv
eval "$(pyenv init --path)"
eval "$(pyenv init -)"
eval "$(pyenv virtualenv-init -)"
# Created by `pipx` on 2022-05-07 05:17:06
export PATH="$PATH:/Users/ogi/.local/bin"
export EDITOR="subl"

# Fig post block. Keep at the bottom of this file.
. "$HOME/.fig/shell/zshrc.post.zsh"

The issue is when I go to a git repo and try and use any kind of tab completion I get this kind output:

~/some/git/repo
❯ git rm doc<TAB>
_git:.:48: no such file or directory:
__git_zsh_bash_func:8: command not found: __git_aliased_command
~/some/git/repo
> 

Things do work if I remove this bit of my .zshrc

zi wait lucid for \
 atinit"ZI[COMPINIT_OPTS]=-C; zicompinit; zicdreplay" \
    z-shell/F-Sy-H \
 blockf \
    zsh-users/zsh-completions \
 atload"!_zsh_autosuggest_start" \
    zsh-users/zsh-autosuggestions

but then I lose my pretty coloring 😄

In case it helps, I'm on macOS 12.3.1, I'm using fig with iTerm2.

Thanks for making an awesome product!

EDIT: similar issue here: zdharma-continuum/zinit#124

[pskarma]

@j9ac9k,

Thanks for the detailed report. I am already splitting your .zshrc 👷‍♂️

@ss-o I'll do the magic search.

[ss-o]

This issue has been solved in a Slack Workspace:

---

ss-o 19:22
Hey 👋
you removed felipec/git-completion or git/git and left zsh/users completions?

j9ac9k 19:26
i removed both 😬

---