Skip to contentSkip to conversation

contrib/completion: fix zsh completion regression from 59d85a2a05

PATCH Superseded David Aguilar 2 participants 4 messages Jun 1, 2021

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 contrib/completion: fix zsh completion regression from 59d85a2a05

A recent change to make git-completion.bash use $__git_cmd_idx in more places broke a number of completions on zsh because it modified __git_main but did not update __git_zsh_main.

Notably, completions for "add", "branch", "mv" and "push" were broken as a result of this change.

In addition to the undefined variable usage, "git mv <tab>" also prints the following error:

__git_count_arguments:7: bad math expression:
operand expected at `"1"'

_git_mv:[:7: unknown condition: -gt

Remove the quotes around $__git_cmd_idx in __git_count_arguments and set __git_cmd_idx=1 early in __git_zsh_main to fix the regressions from 59d85a2a05.

Add "git" to the "words" array in _git_zsh_main to guarantee that "git" is at least always in the completion list. It may not be completely correct because __git_cmd_idx is not always 1, but it is enough to fix the regression.

This was tested on zsh 5.7.1 (x86_64-apple-darwin19.0).

---
 contrib/completion/git-completion.bash | 2 +-
 contrib/completion/git-completion.zsh  | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)
contrib/completion/git-completion.bash +1 -1
index 3c5739b905..b50c5d0ea3 100644
@@ -1306,7 +1306,7 @@ __git_count_arguments ()
 	local word i c=0
 
 	# Skip "git" (first argument)
-	for ((i="$__git_cmd_idx"; i < ${#words[@]}; i++)); do
+	for ((i=$__git_cmd_idx; i < ${#words[@]}; i++)); do
 		word="${words[i]}"
 
 		case "$word" in
contrib/completion/git-completion.zsh +2 -2
index 6c56296997..6405d7ba30 100644
@@ -251,7 +251,7 @@ __git_zsh_main ()
 		done
 		;;
 	(arg)
-		local command="${words[1]}" __git_dir
+		local command="${words[1]}" __git_dir __git_cmd_idx=1
 
 		if (( $+opt_args[--bare] )); then
 			__git_dir='.'
@@ -261,7 +261,7 @@ __git_zsh_main ()
 
 		(( $+opt_args[--help] )) && command='help'
 
-		words=( ${orig_words[@]} )
+		words=( git ${orig_words[@]} )
 
 		__git_zsh_bash_func $command
 		;;
Signature · 1 line
2.32.0.rc2.1.gf67de2b3ac
#1 lore raw
Quoted 3 lines · David Aguilar

A recent change to make git-completion.bash use $__git_cmd_idx Add "git" to the "words" array in _git_zsh_main to guarantee that "git" is at least always in the completion list.

Hm, no. The current code already guarantees "git" is always at the start of the completion list. In [1] I suggested to add git *if* $words is used instead of $orig_words.

If you add "git" to $orig_words you end up with something like "git git mv", so the __git_cmd_idx is definitely not 1.

You should probably try to test yourself:

  words=( git ${words[@]} )
  echo "$words" >> /tmp/words-log.txt

The problem is that zsh's _arguments eats all the words it finds, so for example if you type:

  git mv --force <tab>

$words will be 'mv --force'.

It's better to use $words because in case there's arguments beforehand, like:

  git --git-dir=/tmp/test/.git mv --force

$words will be 'mv --force', so we can get the proper index by just adding 'git' beforehand.

But it doesn't work for arguments not in _arguments, like:

  git --foo mv --force

Which returns:

  --foo mv --force

And unfortunately upstream's version of the wrapper doesn't understand many arguments, like -c, or -C. git-completion does have all of them

It's better to just leave the code as it is and just fix the regression by adding __git_cmd_idx=1.

Quoted 1 line

I mean I kind of wrote 2 of the 3 lines you sent, can I get a Suggested-by?

contrib/completion/git-completion.zsh __git_zsh_main () · line 254

Quoted 8 lines
contrib/completion/git-completion.zsh +1 -1
@@ -251,7 +251,7 @@ __git_zsh_main ()
 		done
 		;;
 	(arg)
-		local command="${words[1]}" __git_dir
+		local command="${words[1]}" __git_dir __git_cmd_idx=1

This is needed.

contrib/completion/git-completion.zsh __git_zsh_main () · line 264

Quoted 9 lines
contrib/completion/git-completion.zsh +1 -1
 		if (( $+opt_args[--bare] )); then
 			__git_dir='.'
@@ -261,7 +261,7 @@ __git_zsh_main ()
 
 		(( $+opt_args[--help] )) && command='help'
 
-		words=( ${orig_words[@]} )
+		words=( git ${orig_words[@]} )

This is wrong. The current code is fine.

Cheers.

[1] https://lore.kernel.org/git/[email protected]/

Signature · 1 line
Felipe Contreras
#2 lore raw
Quoted 44 lines · Felipe Contreras
Quoted 3 lines · David Aguilar

A recent change to make git-completion.bash use $__git_cmd_idx Add "git" to the "words" array in _git_zsh_main to guarantee that "git" is at least always in the completion list.

Hm, no. The current code already guarantees "git" is always at the start of the completion list. In [1] I suggested to add git *if* $words is used instead of $orig_words.

If you add "git" to $orig_words you end up with something like "git git mv", so the __git_cmd_idx is definitely not 1.

You should probably try to test yourself:

  words=( git ${words[@]} )
  echo "$words" >> /tmp/words-log.txt

The problem is that zsh's _arguments eats all the words it finds, so for example if you type:

  git mv --force <tab>

$words will be 'mv --force'.

It's better to use $words because in case there's arguments beforehand, like:

  git --git-dir=/tmp/test/.git mv --force

$words will be 'mv --force', so we can get the proper index by just adding 'git' beforehand.

But it doesn't work for arguments not in _arguments, like:

  git --foo mv --force

Which returns:

  --foo mv --force

And unfortunately upstream's version of the wrapper doesn't understand many arguments, like -c, or -C. git-completion does have all of them

Quoted 7 lines

It's better to just leave the code as it is and just fix the regression by adding __git_cmd_idx=1.

Quoted 1 line

I mean I kind of wrote 2 of the 3 lines you sent, can I get a Suggested-by?

The v4 I just sent is now basically the same as v2 modulo the
Suggested-by: trailer update.

Quoted 19 lines

contrib/completion/git-completion.zsh __git_zsh_main () · line 254

Quoted 9 lines
contrib/completion/git-completion.zsh +1 -1
@@ -251,7 +251,7 @@ __git_zsh_main ()
              done
              ;;
      (arg)
-             local command="${words[1]}" __git_dir
+             local command="${words[1]}" __git_dir __git_cmd_idx=1

This is needed.

Quoted 7 lines
contrib/completion/git-completion.zsh +0 -0
              if (( $+opt_args[--bare] )); then
                      __git_dir='.'
@@ -261,7 +261,7 @@ __git_zsh_main ()
 
              (( $+opt_args[--help] )) && command='help'
 
Quoted 8 lines

contrib/completion/git-completion.zsh __git_zsh_main () · line 264

Quoted 2 lines
contrib/completion/git-completion.zsh +1 -1
-             words=( ${orig_words[@]} )
+             words=( git ${orig_words[@]} )

This is wrong. The current code is fine.

Cheers.

[1] https://lore.kernel.org/git/[email protected]/

Thanks for the detailed explanation.

Just so I'm understanding this correctly.. if this was instead..

    words=( git ${words[@]} )

(instead of orig_words like I mistakenly included in v3) would that be an improvement, no-op or would it be worse? It sounds like additional changes are needed to make it properly support options between "git" and the sub-command name, hence the patch is fine as-is in v4, correct?

Hopefully in the future it can be extended to cover eg. "git -c foo.bar -C some-dir <sub-command>" as well. Thanks for your patience.

cheers,

Signature · 1 line
David
#3 lore raw
Quoted 11 lines · David Aguilar
Quoted 8 lines · Felipe Contreras

contrib/completion/git-completion.zsh __git_zsh_main () · line 264

Quoted 6 lines
contrib/completion/git-completion.zsh +1 -1
@@ -261,7 +261,7 @@ __git_zsh_main ()
 
              (( $+opt_args[--help] )) && command='help'
 
-             words=( ${orig_words[@]} )
+             words=( git ${orig_words[@]} )

This is wrong. The current code is fine.

Quoted 8 lines

Thanks for the detailed explanation.

Just so I'm understanding this correctly.. if this was instead..

    words=( git ${words[@]} )

(instead of orig_words like I mistakenly included in v3) would that be an improvement, no-op or would it be worse?

It would be an improvement, but it's orthogonal to the regression you are trying to fix.

I would just fix the regression for v2.32, and then afterwards try to do the improvement.

I have a testing framework for the zsh completion in my git-completion project, so I would be much more confident about this change if all the tests pass. Alas I have not yet merged any v2.32.0-rc* so it's not straightforward to run the tests now.

Quoted 3 lines

It sounds like additional changes are needed to make it properly support options between "git" and the sub-command name, hence the patch is fine as-is in v4, correct?

I mean there's git options, and git command options. I don't know how many changes are needed to make all the interactions work correctly, but I wouldn't have confidence in any of them so close to a release, especially considering git.git doesn't have any zsh tests.

So yes, v4 is fine.

Quoted 2 lines

Hopefully in the future it can be extended to cover eg. "git -c foo.bar -C some-dir <sub-command>" as well. Thanks for your patience.

That will work correctly on git-completion once I merge your v4 patch (and v2.32).

Signature · 1 line
Felipe Contreras