@matheusbsbs / matheus-bagliano / commits / 7ee1af8cb8

completion: prompt: use generic colors

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> Tested-by: Joakim Petersen <joak-pet@online.no> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Felipe Contreras committed Feb 28, 2023 at 08:59 UTC 7ee1af8cb8b97385fc4e603bc024d877def5adb4

2 files changed +11 -16

contrib/completion/git-prompt.sh

+7 -12

@@ -100,9 +100,7 @@

100 #

101 # If you would like a colored hint about the current dirty state, set

102 # GIT_PS1_SHOWCOLORHINTS to a nonempty value. The colors are based on

103 -# the colored output of "git status -sb" and are available only when

104 -# using __git_ps1 for PROMPT_COMMAND or precmd in Bash,

105 -# but always available in Zsh.

103 +# the colored output of "git status -sb".

104 #

105 # If you would like __git_ps1 to do nothing in the case when the current

106 # directory is set up to be ignored by git, then set

@@ -259,12 +257,12 @@ __git_ps1_colorize_gitstring ()

257 local c_lblue='%F{blue}'

258 local c_clear='%f'

259 else

262 - # Using \[ and \] around colors is necessary to prevent

260 + # Using \001 and \002 around colors is necessary to prevent

261 # issues with command line editing/browsing/completion!

264 - local c_red='\[\e[31m\]'

265 - local c_green='\[\e[32m\]'

266 - local c_lblue='\[\e[1;34m\]'

267 - local c_clear='\[\e[0m\]'

262 + local c_red=$'\001\e[31m\002'

263 + local c_green=$'\001\e[32m\002'

264 + local c_lblue=$'\001\e[1;34m\002'

265 + local c_clear=$'\001\e[0m\002'

266 fi

267 local bad_color=$c_red

268 local ok_color=$c_green

@@ -574,11 +572,8 @@ __git_ps1 ()

572 b="\${__git_ps1_branch_name}"

573 fi

574

577 - # NO color option unless in PROMPT_COMMAND mode or it's Zsh

575 if [ -n "${GIT_PS1_SHOWCOLORHINTS-}" ]; then

579 - if [ $pcmode = yes ] || [ -n "${ZSH_VERSION-}" ]; then

580 - __git_ps1_colorize_gitstring

581 - fi

576 + __git_ps1_colorize_gitstring

577 fi

578

579 local f="$h$w$i$s$u$p"

t/t9903-bash-prompt.sh

+4 -4

@@ -13,10 +13,10 @@ export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME

13 . "$GIT_BUILD_DIR/contrib/completion/git-prompt.sh"

15 actual="$TRASH_DIRECTORY/actual"

16 -c_red='\\[\\e[31m\\]'

17 -c_green='\\[\\e[32m\\]'

18 -c_lblue='\\[\\e[1;34m\\]'

19 -c_clear='\\[\\e[0m\\]'

16 +c_red='\001\e[31m\002'

17 +c_green='\001\e[32m\002'

18 +c_lblue='\001\e[1;34m\002'

19 +c_clear='\001\e[0m\002'

21 test_expect_success 'setup for prompt tests' '

22 git init otherrepo &&