zsh completions broken in yadm 3.0.0

[sidmadala]

Describe the bug

Yadm 2 completions worked very well, but when upgrading to version 3.0.0 through Homebrew, pressing tab yields the following error on the first try followed by silence on any other attempts in the shell. The completions file _yadm still exists in the proper /usr/local/share/zsh/site-functions directory.

To reproduce

Can this be reproduced with the yadm/testbed docker image: Most likely no since I use MacOS and Homebrew

Steps to reproduce the behavior:

1. Type command yadm
2. Press TAB
3. See error

Expected behavior

I'd expect the completions to show up with a description of each command.

Environment

• Operating system: [Ubuntu 18.04, yadm/testbed, etc.]
• Version yadm: yadm 3.0.0
• Version Git: git version 2.30.0

[erijo]

What version of zsh are you using?

[sidmadala]

zsh 5.7.1 (x86_64-apple-darwin19.0)

[erijo]

Can you try this to verify that it isn't something in your setup:

zsh -f
fpath=(/usr/local/share/zsh/site-functions $fpath)
autoload compinit
compinit

and then try to complete yadm commands again?

[sidmadala]

I do not get the error, but I also do not get any suggestions either. Only folder names appear for autocompletion.

[erijo]

Then the fpath is probably wrong. Does the path added contain the file _yadm?

[sidmadala]

The first item in my fpath is /usr/local/share/zsh/site-functions which contains the _yadm file.

And a slightly newer error I'm getting.

[TheLocehiliosan]

I'm not a zsh user, and I just attempted to use the completions installed via HomeBrew. I put this in my .zshrc as suggested by HomeBrew:

if type brew &>/dev/null; then
  FPATH=$(brew --prefix)/share/zsh-completions:$FPATH
  autoload -Uz compinit
  compinit -i
fi

And then started a zsh, and typed "yadm ", and I'm met with this error:

yadm _git:12: command not found: __yadm_main

and then afterwards, only get directory completions...

I'm not sure where that comes from yet, but I would guess it comes from the inherited git completions. I see this in /usr/local/share/zsh/site-functions/_git:

_git ()
{
	local _ret=1
	local cur cword prev

	cur=${words[CURRENT]}
	prev=${words[CURRENT-1]}
	let cword=CURRENT-1

	if (( $+functions[__${service}_zsh_main] )); then
		__${service}_zsh_main
	else
		emulate ksh -c __${service}_main
	fi

	let _ret && _default && _ret=0
	return _ret
}

But I'm not sure where ${service} gets defined.

[erijo]

It seems like the git completion shipped with git differs from the git completion shipped with zsh. The new yadm completion requires the latter.

If you try removing the _git symlink from the /usr/local/share/zsh/site-functions dir, does it work then (after starting a new shell)?

[sidmadala]

It works if i rename/remove the _git symlink.

[TheLocehiliosan]

I'm away at the moment, but later I'll dig into where the _git completions in home brew are coming from. I think there may still need to be some mitigation for this situation.

[erijo]

Yes, I think we should keep this issue open until a proper fix is in place.

The git completions comes from the git package according to the image above (seen in symlink).

[TheLocehiliosan]

Again, I'm away, but in my setup, there was also a second git completion. I'll look into it later for sure.

[sidmadala]

My other git completions come from a zsh plugin called zsh-useres/zsh-completions which packages most of the default tools' completions into one folder. Yadm works fine when this other completion source is the one being used instead of the default _git.

[erijo]

I've been able to reproduce this issue. I'll have a look and see if I can come up with a solution.

[erijo]

I've just posted a PR that works for me in my testing. But more testing is of course welcome.

[TheLocehiliosan]

@sidmadala I have tested @erijo's changes, and they work for me. It would be great to get further confirmation. Is it possible to copy the completions/zsh/_yadm file from the develop branch into /usr/local/share/zsh/site-functions, and then run brew reinstall git, and see if completions are working?

The brew reinstall should put the Git completions back into place if they were removed.

[sidmadala]

Works for me. Don't know why the spacing is uneven though.

Git:

Yadm:

[xenoterracide]

I didn't get an error, but completions were stalling out zsh so bad I had to kill them so I unloaded them.

1 ❯ zsh --version                                                                                       # ~
zsh 5.8 (x86_64-pc-linux-gnu)
❯ uname -a                                                                                              # ~
Linux freyja 5.10.2-2-MANJARO #1 SMP PREEMPT Tue Dec 22 08:14:42 UTC 2020 x86_64 GNU/Linux

[erijo]

@xenoterracide: is this also with the fixed completions on the develop branch?

[erijo]

@sidmadala: the mixed spacing was a consequent of how the completion was done.

All: I've now done yet another retake on the completion (see my zsh-completion branch) where I've simplified the completion and stopped using internal functions from the git completion. I've only done some simple testing so far, but it seems to work well.

Please try it and see if it works for you as well.

[sidmadala]

@erijo, looks good to me. Separating the yadm specific commands is a nice touch.

[TheLocehiliosan]

@erijo - Can you create a new PR for the updated zsh completions? (assuming the are working better)

[erijo]

@TheLocehiliosan: yes, will do. I have a few minor things to fix first.

[xenoterracide]

just an FYI I plan on testing this, just haven't gotten around to it yet. no later than this weekend though, maybe tonight. I should probably update the aur PKGBUILD to do it.