Skip to content

refactor git switch completion

Jacob Keller git 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest11 patches 13 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/11completion: add some simple test cases for git switch completiont/t9902-completion.sh+25 -00 replies
2/11completion: add test showing subpar git switch completiont/t9902-completion.sh+13 -00 replies
3/11completion: add test highlighting subpar git switch --track completiont/t9902-completion.sh+10 -00 replies
4/11completion: add tests showing lack of support for git switch -c/-Ct/t9902-completion.sh+63 -00 replies
5/11completion: add test showing subpar completion for git switch --orphancontrib/completion/git-completion.bash t/t9902-completion.sh+17 -110 replies
5/11completion: remove completion for git switch --orphancontrib/completion/git-completion.bash t/t9902-completion.sh+17 -10 replies
6/11completion: rename --track option of __git_complete_refscontrib/completion/git-completion.bash+15 -130 replies
7/11completion: extract function __git_dwim_remote_headscontrib/completion/git-completion.bash+21 -70 replies
8/11completion: perform DWIM logic directly in __git_complete_refscontrib/completion/git-completion.bash+18 -10 replies
9/11completion: fix completion for git switch with no optionscontrib/completion/git-completion.bash t/t9902-completion.sh+38 -270 replies
10/11completion: recognize -c/-C when completing for git switchcontrib/completion/git-completion.bash t/t9902-completion.sh+7 -150 replies
11/11completion: complete remote branches for git switch --trackcontrib/completion/git-completion.bash t/t9902-completion.sh+24 -60 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 00/11] refactor git switch completion

From: Jacob Keller <[email protected]>

completion support for git switch is subpar for a number of cases. Most notable is difference between these two completions:

$git switch <TAB>
Display all 784 possibilities? (y or n)
<list of all references and DWIM remotes>

  $git switch --track<TAB>
  jk-refactor-git-switch-completion master`

If --track is provided, tab completion becomes almost useless, because we would expect to complete remote references, but instead can only complete local branches!

This series was motivated by a desire to fix the completion for the above two cases, but I noticed several other issues on the way, including some issues understanding what the current logic did.

This series aims to improve the completion support, and comes with many additional test cases that should help highlight the buggy behavior and hopefully prevent future regressions.

The first few commits just add new test cases, most of which currently fail.

Following this is a commit to change __git_complete_refs so that it uses "--dwim" instead of "--track", since this made reading _git_checkout() and _git_switch() difficult to read. "--track" was both used as the "enable DWIM remote branch names" and also the option name for --track.

Following this are some patches to extract displaying DWIM remote branch names from __git_refs() and refactoring __git_complete_refs to take a mode argument that switches between calling __git_heads, __git_refs, and a new __git_remotes.

By doing this, it becomes easier to do things like complete DWIM remote branches in addition to just regular branches, rather than all references.

With this series applied, completion for git switch behaves more like the following examples:

$git switch <TAB>

  HEAD                                master         todo
  jk-refactor-git-switch-completion   next
  maint                               pu
  $git switch --track <TAB>
  origin/HEAD     origin/maint    origin/master   origin/next     origin/pu
  origin/todo

Jacob Keller (11):
completion: add some simple test cases for git switch completion
completion: add test showing subpar git switch completion
completion: add test highlighting subpar git switch --track completion
completion: add tests showing lack of support for git switch -c/-C
completion: remove completion for git switch --orphan
completion: rename --track option of __git_complete_refs
completion: extract function __git_dwim_remote_heads
completion: perform DWIM logic directly in __git_complete_refs
completion: fix completion for git switch with no options
completion: recognize -c/-C when completing for git switch
completion: complete remote branches for git switch --track

 contrib/completion/git-completion.bash | 146 +++++++++++++++++++------
 t/t9902-completion.sh                  | 103 +++++++++++++++++
 2 files changed, 215 insertions(+), 34 deletions(-)
Signature · 1 line
2.25.2