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

[PATCH 09/51] completion: prompt: use generic colors

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
Aug 30, 2022, 09:30 UTC
Message-ID
<20220830093138.1581538-10-felipe.contreras@gmail.com>
In-Reply-To
<20220830093138.1581538-1-felipe.contreras@gmail.com>

When the prompt command mode was introduced in 1bfc51ac81 (Allow __git_ps1 to be used in PROMPT_COMMAND, 2012-10-10) the assumption was that it was necessary in order to properly add colors to PS1 in bash, but this wasn't true.

It's true that the \[ \] markers add the information needed to properly calculate the width of the prompt, and they have to be added directly to PS1, a function returning them doesn't work.

But that is because bash coverts the \[ \] markers in PS1 to \001 \002, which is what readline ultimately needs in order to calculate the width.

We don't need bash to do this conversion, we can use \001 \002 ourselves, and then the prompt command mode is not necessary to display colors.

This is what functions returning colors are supposed to do [1].
[1] http://mywiki.wooledge.org/BashFAQ/053
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 contrib/completion/git-prompt.sh | 19 +++++++------------
 t/t9903-bash-prompt.sh           |  8 ++++----
 2 files changed, 11 insertions(+), 16 deletions(-)
diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh
index 1435548e00..01bd807657 100644
--- a/contrib/completion/git-prompt.sh
+++ b/contrib/completion/git-prompt.sh
@@ -96,9 +96,7 @@
 #
 # If you would like a colored hint about the current dirty state, set
 # GIT_PS1_SHOWCOLORHINTS to a nonempty value. The colors are based on
-# the colored output of "git status -sb" and are available only when
-# using __git_ps1 for PROMPT_COMMAND or precmd in Bash,
-# but always available in Zsh.
+# the colored output of "git status -sb".
 #
 # If you would like __git_ps1 to do nothing in the case when the current
 # directory is set up to be ignored by git, then set
@@ -255,12 +253,12 @@ __git_ps1_colorize_gitstring ()
 		local c_lblue='%F{blue}'
 		local c_clear='%f'
 	else
-		# Using \[ and \] around colors is necessary to prevent
+		# Using \001 and \002 around colors is necessary to prevent
 		# issues with command line editing/browsing/completion!
-		local c_red='\[\e[31m\]'
-		local c_green='\[\e[32m\]'
-		local c_lblue='\[\e[1;34m\]'
-		local c_clear='\[\e[0m\]'
+		local c_red=$'\001\e[31m\002'
+		local c_green=$'\001\e[32m\002'
+		local c_lblue=$'\001\e[1;34m\002'
+		local c_clear=$'\001\e[0m\002'
 	fi
 	local bad_color=$c_red
 	local ok_color=$c_green
@@ -564,11 +562,8 @@ __git_ps1 ()
 		b="\${__git_ps1_branch_name}"
 	fi
 
-	# NO color option unless in PROMPT_COMMAND mode or it's Zsh
 	if [ -n "${GIT_PS1_SHOWCOLORHINTS-}" ]; then
-		if [ $pcmode = yes ] || [ -n "${ZSH_VERSION-}" ]; then
-			__git_ps1_colorize_gitstring
-		fi
+		__git_ps1_colorize_gitstring
 	fi
 
 	local f="$h$w$i$s$u$p"
diff --git a/t/t9903-bash-prompt.sh b/t/t9903-bash-prompt.sh
index c94c351e23..fb396ff3a7 100755
--- a/t/t9903-bash-prompt.sh
+++ b/t/t9903-bash-prompt.sh
@@ -13,10 +13,10 @@ export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
 . "$GIT_BUILD_DIR/contrib/completion/git-prompt.sh"
 
 actual="$TRASH_DIRECTORY/actual"
-c_red='\\[\\e[31m\\]'
-c_green='\\[\\e[32m\\]'
-c_lblue='\\[\\e[1;34m\\]'
-c_clear='\\[\\e[0m\\]'
+c_red='\001\e[31m\002'
+c_green='\001\e[32m\002'
+c_lblue='\001\e[1;34m\002'
+c_clear='\001\e[0m\002'
 
 unset GIT_PS1_SHOWDIRTYSTATE
 unset GIT_PS1_SHOWSTASHSTATE

-- 
2.37.2.351.g9bf691b78c.dirty
Previous: Felipe ContrerasNext: Felipe Contreras
Message 7 of 52 in “completion: revamp”
  1. 00/51 completion: revampFelipe Contreras, Aug 30, 2022
  2. 01/51 test: completion add test for __git_cmd_idxFelipe Contreras, Aug 30, 2022
  3. 03/51 completion: fix __git_cmd_idx regression for zshFelipe Contreras, Aug 30, 2022
  4. 02/51 test: add zsh completion testsFelipe Contreras, Aug 30, 2022
  5. 04/51 completion: bash: trivial cleanupFelipe Contreras, Aug 30, 2022
  6. 05/51 completion: zsh: add higher-priority locationFelipe Contreras, Aug 30, 2022
  7. 09/51 completion: prompt: use generic colorsFelipe Contreras, Aug 30, 2022
  8. 07/51 zsh: simplify realpath dirname idiomFelipe Contreras, Aug 30, 2022
  9. 10/51 completion: fix for suboptions with valueFelipe Contreras, Aug 30, 2022
  10. 06/51 zsh: resolve symlink of scriptFelipe Contreras, Aug 30, 2022
  11. 08/51 test: reset environment variablesFelipe Contreras, Aug 30, 2022
  12. 11/51 completion: zsh: trivial improvementFelipe Contreras, Aug 30, 2022
  13. 12/51 completion: bash: do not modify COMP_WORDBREAKSFelipe Contreras, Aug 30, 2022
  14. 13/51 test: completion: fix currently typed wordsFelipe Contreras, Aug 30, 2022
  15. 14/51 test: completion: switch __gitcomp_nl prefix testFelipe Contreras, Aug 30, 2022
  16. 15/51 test: completion: add run_func() helperFelipe Contreras, Aug 30, 2022
  17. 16/51 completion: bash: remove non-append functionalityFelipe Contreras, Aug 30, 2022
  18. 17/51 completion: bash: get rid of _append() functionsFelipe Contreras, Aug 30, 2022
  19. 18/51 completion: bash: get rid of any non-append codeFelipe Contreras, Aug 30, 2022
  20. 19/51 completion: zsh: fix options with argumentsFelipe Contreras, Aug 30, 2022
  21. 20/51 completion: zsh: expand --git-dir file argumentFelipe Contreras, Aug 30, 2022
  22. 21/51 completion: zsh: add support for general -C optsFelipe Contreras, Aug 30, 2022
  23. 23/51 completion: zsh: add support for general -c optsFelipe Contreras, Aug 30, 2022
  24. 24/51 completion: zsh: fix extra space on foo=Felipe Contreras, Aug 30, 2022
  25. 22/51 completion: zsh: fix for undefined completionsFelipe Contreras, Aug 30, 2022
  26. 28/51 completion: simplify equal suffix checkFelipe Contreras, Aug 30, 2022
  27. 30/51 completion: simplify __gitcompFelipe Contreras, Aug 30, 2022
  28. 32/51 completion: improve __gitcomp suffix codeFelipe Contreras, Aug 30, 2022
  29. 33/51 test: completion: add missing testFelipe Contreras, Aug 30, 2022
  30. 25/51 completion: zsh: add excluded optionsFelipe Contreras, Aug 30, 2022
  31. 27/51 completion: factor out check in __gitcompFelipe Contreras, Aug 30, 2022
  32. 26/51 completion: zsh: always set compsetFelipe Contreras, Aug 30, 2022
  33. 29/51 completion: refactor __gitcompFelipe Contreras, Aug 30, 2022
  34. 31/51 completion: bash: change suffix check in __gitcompFelipe Contreras, Aug 30, 2022
  35. 36/51 completion: add __gitcomp_optsFelipe Contreras, Aug 30, 2022
  36. 37/51 completion: bash: cleanup __gitcomp* invocationsFelipe Contreras, Aug 30, 2022
  37. 34/51 completion: bash: simplify config_variable_nameFelipe Contreras, Aug 30, 2022
  38. 35/51 completion: bash: improve __gitcomp descriptionFelipe Contreras, Aug 30, 2022
  39. 38/51 completion: bash: shuffle __gitcomp functionsFelipe Contreras, Aug 30, 2022
  40. 39/51 completion: zsh: simplify __gitcomp_directFelipe Contreras, Aug 30, 2022
  41. 42/51 completion: zsh: add elements individually in __gitcomp_optsFelipe Contreras, Aug 30, 2022
  42. 43/51 completion: zsh: add __gitcompadd helperFelipe Contreras, Aug 30, 2022
  43. 40/51 completion: zsh: shuffle __gitcomp* functionsFelipe Contreras, Aug 30, 2022
  44. 45/51 completion: bash: simplify _get_comp_words_by_ref()Felipe Contreras, Aug 30, 2022
  45. 41/51 completion: zsh: fix direct quotingFelipe Contreras, Aug 30, 2022
  46. 44/51 completion: zsh: add correct removable suffixFelipe Contreras, Aug 30, 2022
  47. 48/51 completion: bash: trivial cleanupFelipe Contreras, Aug 30, 2022
  48. 47/51 completion: bash: cleanup _get_comp_words_by_ref()Felipe Contreras, Aug 30, 2022
  49. 46/51 completion: bash: refactor _get_comp_words_by_ref()Felipe Contreras, Aug 30, 2022
  50. 49/51 completion: bash: rename _get_comp_words_by_ref()Felipe Contreras, Aug 30, 2022
  51. 50/51 zsh: remove versionFelipe Contreras, Aug 30, 2022
  52. 51/51 completion: bash: trivial grammar fixFelipe Contreras, Aug 30, 2022

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.