git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 00/11] refactor git switch completion

From
Jacob Keller <jacob.e.keller@intel.com>
Date
Apr 25, 2020, 02:20 UTC
Message-ID
<20200425022045.1089291-1-jacob.e.keller@intel.com>
From: Jacob Keller <jacob.keller@gmail.com>

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(-)
-- 
2.25.2
Next: Jacob Keller
Message 1 of 26 in “refactor git switch completion”
  1. 00/11 refactor git switch completionJacob Keller, Apr 25, 2020
  2. 01/11 completion: add some simple test cases for git switch completionJacob Keller, Apr 25, 2020
  3. 02/11 completion: add test showing subpar git switch completionJacob Keller, Apr 25, 2020
  4. 03/11 completion: add test highlighting subpar git switch --track completionJacob Keller, Apr 25, 2020
  5. 04/11 completion: add tests showing lack of support for git switch -c/-CJacob Keller, Apr 25, 2020
  6. 09/11 completion: fix completion for git switch with no optionsJacob Keller, Apr 25, 2020
  7. 11/11 completion: complete remote branches for git switch --trackJacob Keller, Apr 25, 2020
  8. 08/11 completion: perform DWIM logic directly in __git_complete_refsJacob Keller, Apr 25, 2020
  9. 10/11 completion: recognize -c/-C when completing for git switchJacob Keller, Apr 25, 2020
  10. 07/11 completion: extract function __git_dwim_remote_headsJacob Keller, Apr 25, 2020
  11. 06/11 completion: rename --track option of __git_complete_refsJacob Keller, Apr 25, 2020
  12. 05/11 completion: remove completion for git switch --orphanJacob Keller, Apr 25, 2020
  13. 05/11 completion: add test showing subpar completion for git switch --orphanJacob Keller, Apr 25, 2020
  14. Junio C HamanoApr 27, 2020
  15. Jacob KellerApr 28, 2020
  16. Jacob KellerApr 28, 2020
  17. Junio C HamanoApr 28, 2020
  18. Jacob KellerApr 28, 2020
  19. Junio C HamanoApr 28, 2020
  20. Jacob KellerApr 28, 2020
  21. Junio C HamanoApr 28, 2020
  22. Jacob KellerApr 28, 2020
  23. Junio C HamanoApr 28, 2020
  24. Jacob KellerApr 25, 2020
  25. Junio C HamanoApr 30, 2020
  26. Jacob KellerMay 1, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.