broken bash prompt wrap line

Question

I'm customizing my bash prompt on OsX to include git branch plus some marks of the branch state. This breaks line wrap.

I know that I have to add \[ and \] to prevent this issue, but doing so in the functions does display \[ and \] litteraly.

What can I do to escape such sequences in those functions?

Disclaimer: those are my first attempts in bash scripting.

function parse_git_dirty {
  # TODO make git status response a variable
  # [branch+] : working dir has staged changes
  if [[ $(git status 2> /dev/null | grep "to be committed") ]]
  then S=$S"$(tput setaf 2)+$(tput sgr0)"
  fi
  # [branch+] : working dir has unstaged changes
  if [[ $(git status 2> /dev/null | grep "not staged for commit") ]]
  then S=$S"$(tput setaf 1)+$(tput sgr0)"
  fi
  # [branch+] : working dir has untracked files
  if [[ $(git status 2> /dev/null | grep "tracked files") ]]
  then S=$S"$(tput setaf 1)+$(tput sgr0)"
  fi
  # [branch<] : local branch is behind origin
  if [[ $(git status 2> /dev/null | grep "Your branch is behind") ]]
  then S=$S"$(tput setaf 5)<$(tput sgr0)"
  fi
  # [branch>] : local branch is ahead origin
  if [[ $(git status 2> /dev/null | grep "branch is ahead of") ]]
  then S=$S"$(tput setaf 5)>$(tput sgr0)"
  fi
  # [branch<>] : branches have diverged
  if [[ $(git status 2> /dev/null | grep "have diverged") ]]
  then S=$S"$(tput setaf 5)<>$(tput sgr0)"
  fi
  echo $S
}
function parse_git_branch {
  git branch --no-color 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/\1/'
}
function show_git_branch {
  if [[ $(parse_git_branch) ]]
  then echo "$(tput setaf 2)($(tput sgr0)$(parse_git_branch)$(parse_git_dirty)$(tput setaf 2))$(tput sgr0)"
  fi
}
export PS1="\u\[$(tput setaf 2)\]@\[$(tput sgr0)\]\h\[$(tput setaf 2)\]:\[$(tput sgr0)\]\W\[\$(show_git_branch)\] "

Not sure exactly what the issue is, your code seems to work correctly, using it i get the following prompt, hutcho@hutcho-M17x:math(master+). BTW, this is a cool idea. — luke h, Feb 19 '11 at 11:11
I have some (not all that unusual) repositories where `git status` takes about 40 seconds to complete, and your code will run `git status` six times for each bash prompt! I've added an answer below mentioning `__git_ps1`, which probably does what you want and can be configured for different levels of detail in the output. — Mark Longair, Feb 19 '11 at 14:29

score 5 · Accepted Answer · answered Feb 19 '11 at 14:02

I glad to hear that you've solved the problem with your version, but I thought it might be worth pointing out that git is already distributed with a helpful and carefully thought out bash function called __git_ps1 that you can include in your PS1. For example, you could use it like this:

 export PS1='blah blah blah$(__git_ps1 " (%s)") '

If you're not in a git repository, the $(__git_ps1 " (%s)") will turn into the empty string. If you are, however, then the format string will be used. That will usually show you your current branch, but if you're in the middle of a merge or a rebase that will be shown instead.

By default __git_ps1 won't show you whether the tree is dirty or there are untracked files, since in certain repositories this could make it irritatingly slow for your bash prompt to appear. However, if you want to see this information as well, it'll show them if you set GIT_PS1_SHOWDIRTYSTATE or GIT_PS1_SHOWUNTRACKEDFILES to something non-empty.

You can find more information at the top of the git-completion.sh source file.

Funny how I reinvented the wheel and got to almost the same markers as __git_ps1 for dirty states and local vs. remote status. — Benoît Pointet, Feb 19 '11 at 18:54

Dennis Williamson · Answer 2 · 2011-02-19T11:18:35.847

3

You need single quotes around the value in the assignment:

export PS1='\u\[$(tput setaf 2)\]@\[$(tput sgr0)\]\h\[$(tput setaf 2)\]:\[$(tput sgr0)\]\W\[$(show_git_branch)\] '

Since the contents are evaluated when the prompt is issued, you don't need double quotes as you would in other circumstances.

edited Feb 19 '11 at 11:18

answered Feb 19 '11 at 11:06

Dennis Williamson

346,391
90
374
439

thanks! I just needed to remove the escpaing of the show_git_branch function and it worked. – Benoît Pointet Feb 19 '11 at 11:13
@BenoîtPointet: Sorry I missed that. I've corrected my answer. – Dennis Williamson Feb 19 '11 at 11:19

score 1 · Answer 3 · answered Feb 19 '11 at 11:14

Thanks to Dennis, the corrected code is:

function parse_git_dirty {
  # TODO make git status response a variable
  # [branch+] : working dir has staged changes
  if [[ $(git status 2> /dev/null | grep "to be committed") ]]
  then S=$S"$(tput setaf 2)+$(tput sgr0)"
  fi
  # [branch+] : working dir has unstaged changes
  if [[ $(git status 2> /dev/null | grep "not staged for commit") ]]
  then S=$S"$(tput setaf 1)+$(tput sgr0)"
  fi
  # [branch+] : working dir has untracked files
  if [[ $(git status 2> /dev/null | grep "tracked files") ]]
  then S=$S"$(tput setaf 1)+$(tput sgr0)"
  fi
  # [branch<] : local branch is behind origin
  if [[ $(git status 2> /dev/null | grep "Your branch is behind") ]]
  then S=$S"$(tput setaf 5)<$(tput sgr0)"
  fi
  # [branch>] : local branch is ahead origin
  if [[ $(git status 2> /dev/null | grep "branch is ahead of") ]]
  then S=$S"$(tput setaf 5)>$(tput sgr0)"
  fi
  # [branch<>] : branches have diverged
  if [[ $(git status 2> /dev/null | grep "have diverged") ]]
  then S=$S"$(tput setaf 5)<>$(tput sgr0)"
  fi
  echo $S
}
function parse_git_branch {
  git branch --no-color 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/\1/'
}
function show_git_branch {
  if [[ $(parse_git_branch) ]]
  then echo "$(tput setaf 2)($(tput sgr0)$(parse_git_branch)$(parse_git_dirty)$(tput setaf 2))$(tput sgr0)"
  fi
}
export PS1='\u\[$(tput setaf 2)\]@\[$(tput sgr0)\]\h\[$(tput setaf 2)\]:\[$(tput sgr0)\]\W\[$(show_git_branch)\] '

broken bash prompt wrap line

3 Answers3

Linked