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

[PATCH v3 1/3] completion: add 'symbolic-ref'

From
Roland Hieber <rhi@pengutronix.de>
Date
Apr 25, 2024, 10:18 UTC
Message-ID
<20240425101845.708554-1-rhi@pengutronix.de>

Even 'symbolic-ref' is only completed when GIT_COMPLETION_SHOW_ALL_COMMANDS=1 is set, it currently defaults to completing file names, which is not very helpful. Add a simple completion function which completes options and refs.

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
PATCH v3:
 - make use of __gitcomp_builtin instead of hard-coded options, and add
   a test for it (thanks to Patrick Steinhardt)
 - add empty line between test cases (thanks to Patrick Steinhardt)
PATCH v2: https://lore.kernel.org/git/20240424215019.268208-1-rhi@pengutronix.de
 - no changes
PATCH v1: https://lore.kernel.org/git/20240424210549.256256-1-rhi@pengutronix.de/
---
 contrib/completion/git-completion.bash | 11 +++++++++++
 t/t9902-completion.sh                  | 23 +++++++++++++++++++++++
 2 files changed, 34 insertions(+)
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index 75193ded4bde..4d63fb6eeaf7 100644
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -3581,6 +3581,17 @@ _git_svn ()
 	fi
 }
 
+_git_symbolic_ref () {
+	case "$cur" in
+	--*)
+		__gitcomp_builtin symbolic-ref
+		return
+		;;
+	esac
+
+	__git_complete_refs
+}
+
 _git_tag ()
 {
 	local i c="$__git_cmd_idx" f=0
diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh
index 569cf2310434..963f865f27ed 100755
--- a/t/t9902-completion.sh
+++ b/t/t9902-completion.sh
@@ -2518,6 +2518,29 @@ test_expect_success 'complete tree filename with metacharacters' '
 	EOF
 '
 
+test_expect_success 'symbolic-ref completes builtin options' '
+	test_completion "git symbolic-ref --d" <<-\EOF
+	--delete Z
+	EOF
+'
+
+test_expect_success 'symbolic-ref completes short ref names' '
+	test_completion "git symbolic-ref foo m" <<-\EOF
+	main Z
+	mybranch Z
+	mytag Z
+	EOF
+'
+
+test_expect_success 'symbolic-ref completes full ref names' '
+	test_completion "git symbolic-ref foo refs/" <<-\EOF
+	refs/heads/main Z
+	refs/heads/mybranch Z
+	refs/tags/mytag Z
+	refs/tags/A Z
+	EOF
+'
+
 test_expect_success PERL 'send-email' '
 	test_completion "git send-email --cov" <<-\EOF &&
 	--cover-from-description=Z
-- 
2.39.2
Next: Roland Hieber
Message 1 of 10 in “completion: add 'symbolic-ref'”
  1. 1/3 completion: add 'symbolic-ref'Roland Hieber, Apr 25, 2024
  2. 2/3 completion: improve docs for using __git_completeRoland Hieber, Apr 25, 2024
  3. 3/3 completion: add docs on how to add subcommand completionsRoland Hieber, Apr 25, 2024
  4. Kristoffer HaugsbakkApr 25, 2024
  5. Justin ToblerApr 25, 2024
  6. Junio C HamanoApr 25, 2024
  7. Justin ToblerApr 25, 2024
  8. Junio C HamanoApr 25, 2024
  9. Junio C HamanoApr 25, 2024
  10. Patrick SteinhardtApr 26, 2024

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.