[PATCH v2 7/9] completion: improve handling of --track in switch/checkout
- From
Jacob Keller <jacob.e.keller@intel.com>
- Date
- May 27, 2020, 11:38 UTC
- Message-ID
- <20200527113831.3294409-8-jacob.e.keller@intel.com>
- In-Reply-To
- <20200527113831.3294409-1-jacob.e.keller@intel.com>
From: Jacob Keller <jacob.keller@gmail.com>
Current completion for the --track option of git switch and git checkout is sub par. In addition to the DWIM logic of a bare branch name, --track has DWIM logic to convert specified remote/branch names into a local branch tracking that remote. For example
$git switch --track origin/master
This will create a local branch name master, that tracks the master branch of the origin remote.
In fact, git switch --track on its own will not accept other forms of references. These must instead be specified manually via the -c/-C/-b/-B options.
Introduce __git_remote_heads() and the "remote-heads" mode for __git_complete_refs. Use this when the --track option is provided while completing in _git_switch and _git_checkout. Just as in the --detach case, we never enable DWIM mode for --track, because it doesn't make sense.
It should be noted that completion support is still a bit sub par when it comes to handling -c/-C and --orphan. This will be resolved in a future change.
Signed-off-by: Jacob Keller <jacob.keller@gmail.com> --- contrib/completion/git-completion.bash | 24 +++++++++++++++++-- t/t9902-completion.sh | 32 ++++++++++++++++++++++++++ 2 files changed, 54 insertions(+), 2 deletions(-)
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash index 38b5a5a0d874..4cdf09987725 100644 --- a/contrib/completion/git-completion.bash +++ b/contrib/completion/git-completion.bash @@ -624,6 +624,19 @@ __git_heads () "refs/heads/$cur_*" "refs/heads/$cur_*/**" } +# Lists branches from remote repositories. +# 1: A prefix to be added to each listed branch (optional). +# 2: List only branches matching this word (optional; list all branches if +# unset or empty). +# 3: A suffix to be appended to each listed branch (optional). +__git_remote_heads () +{ + local pfx="${1-}" cur_="${2-}" sfx="${3-}" + + __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \ + "refs/remotes/$cur_*" "refs/remotes/$cur_*/**" +} + # Lists tags from the local repository. # Accepts the same positional parameters as __git_heads() above. __git_tags () @@ -783,8 +796,9 @@ __git_refs () # --sfx=<suffix>: A suffix to be appended to each ref instead of the default # space. # --mode=<mode>: What set of refs to complete, one of 'refs' (the default) to -# complete all refs, 'heads' to complete only branches. Note -# that --remote is only compatible with --mode=refs. +# complete all refs, 'heads' to complete only branches, or +# 'remote-heads' to complete only remote branches. Note that +# --remote is only compatible with --mode=refs. __git_complete_refs () { local remote dwim pfx cur_="$cur" sfx=" " mode="refs" @@ -810,6 +824,8 @@ __git_complete_refs () __gitcomp_direct "$(__git_refs "$remote" "" "$pfx" "$cur_" "$sfx")" ;; heads) __gitcomp_direct "$(__git_heads "$pfx" "$cur_" "$sfx")" ;; + remote-heads) + __gitcomp_direct "$(__git_remote_heads "$pfx" "$cur_" "$sfx")" ;; *) return 1 ;; esac @@ -1492,6 +1508,8 @@ _git_checkout () if [ -n "$(__git_find_on_cmdline "-d --detach")" ]; then __git_complete_refs --mode="refs" + elif [ -n "$(__git_find_on_cmdline "--track")" ]; then + __git_complete_refs --mode="remote-heads" else __git_complete_refs $dwim_opt --mode="refs" fi @@ -2347,6 +2365,8 @@ _git_switch () if [ -n "$(__git_find_on_cmdline "-d --detach")" ]; then __git_complete_refs --mode="refs" + elif [ -n "$(__git_find_on_cmdline "--track")" ]; then + __git_complete_refs --mode="remote-heads" else __git_complete_refs $dwim_opt --mode="heads" fi diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh index 5b1868e43632..b09eb498d175 100755 --- a/t/t9902-completion.sh +++ b/t/t9902-completion.sh @@ -1404,6 +1404,38 @@ test_expect_success 'git checkout - with -d, complete only references' ' EOF ' +test_expect_success 'git switch - with --track, complete only remote branches' ' + test_completion "git switch --track " <<-\EOF + other/branch-in-other Z + other/master-in-other Z + EOF +' + +test_expect_success 'git checkout - with --track, complete only remote branches' ' + test_completion "git checkout --track " <<-\EOF + other/branch-in-other Z + other/master-in-other Z + EOF +' + +test_expect_success 'git switch - with --no-track, complete only local branch names' ' + test_completion "git switch --no-track " <<-\EOF + master Z + matching-branch Z + EOF +' + +test_expect_success 'git checkout - with --no-track, complete only local references' ' + test_completion "git checkout --no-track " <<-\EOF + HEAD Z + master Z + matching-branch Z + matching-tag Z + other/branch-in-other Z + other/master-in-other Z + EOF +' + test_expect_success 'teardown after ref completion' ' git branch -d matching-branch && git tag -d matching-tag &&
-- 2.25.2