git checkout: no completion of remote branch shorthands

[carlodri]

Current Behavior

I have a freshly cloned repo and if I type git checkout <tab> I get this:

❯ | git checkout
HEAD                                fix dep
main                                Merge pull request #3 from regro-cf-autotick-bot/noarch_python_min-migration-...
origin                              Merge pull request #3 from regro-cf-autotick-bot/noarch_python_min-migration-...
origin/main                         Merge pull request #3 from regro-cf-autotick-bot/noarch_python_min-migration-...
origin/replace_wget_with_requests   fix dep

and I can only autocomplete the origin/replace_wget_with_requests branch name leading to a detached HEAD.

Expected Behavior

I would expect git checkout r<tab> to offer me replace_wget_with_requests so that git automatically sets up branch tracking with origin.

Steps To Reproduce

Using nushell + starship on windows.
Try the above git checkout command.

Version

carapace-bin 1.4.1

OS

• Darwin
• Linux
• Termux
• Windows

Shell

• Bash
• Elvish
• Fish
• Nushell
• Oil
• Powershell
• Xonsh
• Zsh

env.nu

$env.CARAPACE_BRIDGES = 'zsh,fish,bash,inshellisense' # optional
mkdir ~/.cache/carapace
carapace _carapace nushell | save --force ~/.cache/carapace/init.nu

config.nu (extract)

let carapace_completer = {|spans|
    carapace $spans.0 nushell ...$spans | from json
}

source ~/.cache/carapace/init.nu

[rsteube]

You can avoid the detached HEAD with --track.

[carlodri]

Yes, of course. But it is much more practical to implicitly use --guess option, which is the default behavior. If carapace offered me the proper completion, I would just say git checkout replace_wget_with_requests to automatically get remote tracking with a local branch with the same name.

[peytondmurray]

Hey all, I'm interested in addressing this too. It looks like git switch has the completion behavior that we want here, i.e. the completion results don't include origin/<branch name> for remote branches. So I think it would be pretty straightforward to just call the underlying action which returns remote branch names only, without the origin/ prefix. I'd be happy to make a PR, as long as folks are okay with the proposed change?

[rsteube]

Not entirely.
The ref completion is already quite overloaded and this introduces duplicates that don't provide much value in a modal completion menu. They also tend to be abiguous and as far as i can see don't support relative refs (git checkout ref~2) or file checkouts (git checkout ref file).

So I'd like to avoid adding this as default. Could have it configurable at some point though.
For now the best approach is probably to provide an action and use an alias.

[rsteube]

e.g. git-co.yaml:

# yaml-language-server: $schema=https://carapace.sh/schemas/command.json
name: git-co
run: [git, checkout]
completion:
  positional:
    - ["$carapace.tools.git.RemoteBranchNames"]

[peytondmurray]

The ref completion is already quite overloaded and this introduces duplicates that don't provide much value in a modal completion menu. They also tend to be abiguous and as far as i can see don't support relative refs (git checkout ref~2) or file checkouts (git checkout ref file).

Understandable, and thanks for providing an alternative! I think you can also do this as an overlay, too:

# ${UserConfigDir}/carapace/overlays/git.yaml
name: git
commands:
  - name: checkout
    description: Display remote refs
    completion:
      positional:
        - ["$carapace.tools.git.RemoteBranchNames"]

seems to work.