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

[PATCH] completion: Handle '!f() { ... }; f' aliases

From
Steffen Prohaska <prohaska@zib.de>
Date
Jun 7, 2014, 14:10 UTC
Message-ID
<1402150221-25548-1-git-send-email-prohaska@zib.de>

'!f() { ... }; f' is a recommended pattern to declare more complex aliases (see git wiki [1]). This commit teaches the completion to handle them.

When determining which completion to use for an alias, the opening brace is now ignored in order to continue the search for a git command inside the function body. For example, the alias '!f() { git commit ... }' now triggers commit completion. Previously, the search stopped on '{', and the completion tried it to determine how to complete, which obviously was useless.

Furthermore, the null command ':' is now skipped, so that it can be used as a workaround to declare the desired completion style. For example, the alias '!f() { : git commit ; if ... ' now triggers commit completion.

[1] https://git.wiki.kernel.org/index.php/Aliases
Signed-off-by: Steffen Prohaska <prohaska@zib.de>
---
 contrib/completion/git-completion.bash |  7 +++++++
 t/t9902-completion.sh                  | 20 ++++++++++++++++++++
 2 files changed, 27 insertions(+)
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index 2c59a76..aecb975 100644
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -21,6 +21,11 @@
 #        source ~/.git-completion.sh
 #    3) Consider changing your PS1 to also show the current branch,
 #       see git-prompt.sh for details.
+#
+# If you use complex aliases of form '!f() { ... }; f', you can use the null
+# command ':' as the first command in the function body to declare the desired
+# completion style.  For example '!f() { : git commit ; ... }; f' will
+# tell the completion to use commit completion.
 
 case "$COMP_WORDBREAKS" in
 *:*) : great ;;
@@ -781,6 +786,8 @@ __git_aliased_command ()
 		-*)	: option ;;
 		*=*)	: setting env ;;
 		git)	: git itself ;;
+		{)	: skip start of shell helper function ;;
+		:)	: skip null command ;;
 		*)
 			echo "$word"
 			return
diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh
index 2d4beb5..ea48681 100755
--- a/t/t9902-completion.sh
+++ b/t/t9902-completion.sh
@@ -550,6 +550,26 @@ test_expect_success 'complete files' '
 	test_completion "git add mom" "momified"
 '
 
+test_expect_success 'completion uses <cmd> completion for alias !f() { VAR=val git <cmd> ... }' '
+	git config alias.co "!f() { VAR=val git checkout ... ; } f" &&
+	test_completion "git co m" <<-\EOF &&
+	master Z
+	mybranch Z
+	mytag Z
+	EOF
+	git config --unset alias.co
+'
+
+test_expect_success 'completion used <cmd> completion for alias !f() { : git <cmd> ; ... }' '
+	git config alias.co "!f() { : git checkout ; if ... } f" &&
+	test_completion "git co m" <<-\EOF &&
+	master Z
+	mybranch Z
+	mytag Z
+	EOF
+	git config --unset alias.co
+'
+
 test_expect_failure 'complete with tilde expansion' '
 	git init tmp && cd tmp &&
 	test_when_finished "cd .. && rm -rf tmp" &&
-- 
2.0.0.244.g4e8e734
Next: Eric Sunshine
Message 1 of 6 in “completion: Handle '!f() { ... }; f' aliases”
  1. completion: Handle '!f() { ... }; f' aliasesSteffen Prohaska, Jun 7, 2014
  2. Eric SunshineJun 8, 2014
  3. completion: Handle '!f() { ... }; f' aliasesSteffen Prohaska, Jun 9, 2014
  4. Junio C HamanoJun 10, 2014
  5. Steffen ProhaskaJun 12, 2014
  6. completion: Handle '!f() { ... }; f' and "!sh -c '...'" aliasesSteffen Prohaska, Jun 12, 2014

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.