-
-
Save r4dian/f72da81c27ea21b634a76d5f06385dd0 to your computer and use it in GitHub Desktop.
Set colour bash prompt according to active virtualenv, Git, Mercurial or Subversion branch and return status of last command.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/bin/bash | |
# | |
# DESCRIPTION: | |
# | |
# Set the bash prompt according to: | |
# * the active virtualenv | |
# * the branch/status of the current Git, Mercurial or Subversion repository | |
# * the return value of the previous command | |
# * the fact you just came from Windows and are used to having newlines in | |
# your prompts. [Are you!? - r4dian] | |
# | |
# USAGE: | |
# | |
# 1. Save this file as ~/.bash_prompt | |
# 2. Add the following line to the end of your ~/.bashrc or ~/.bash_profile: | |
# . ~/.bash_prompt | |
# | |
# LINEAGE: | |
# | |
# Based on work by woods | |
# https://gist.github.com/31967 | |
# | |
# and jcook793 | |
# https://gist.github.com/2394150 | |
# The various escape codes that we can use to colour our prompt. | |
RED="\[\033[0;31m\]" | |
YELLOW="\[\033[1;33m\]" | |
GREEN="\[\033[0;32m\]" | |
BLUE="\[\033[1;34m\]" | |
LIGHT_RED="\[\033[1;31m\]" | |
LIGHT_GREEN="\[\033[1;32m\]" | |
WHITE="\[\033[1;37m\]" | |
LIGHT_GREY="\[\033[0;37m\]" | |
COLOUR_NONE="\[\e[0m\]" | |
# Detect whether the current directory is a git repository. | |
function is_git_repository { | |
git branch > /dev/null 2>&1 | |
} | |
# Detect whether the current directory is a Mercurial repository. | |
function is_mercurial_repository { | |
branch=$(hg branch 2>/dev/null) | |
if [ -n "${branch}" ]; then | |
return 0 | |
else | |
return 1 | |
fi | |
} | |
# Detect whether the current directory is a Subversion repository. | |
function is_subversion_repository { | |
test -d .svn | |
} | |
# Determine the branch/state information for this git repository. | |
function set_git_branch { | |
# Capture the output of the "git status" command. | |
git_status="$(git status 2> /dev/null)" | |
# Set colour based on clean/staged/dirty. | |
if [[ ${git_status} =~ "working directory clean" ]]; then | |
state="${GREEN}" | |
elif [[ ${git_status} =~ "Changes to be committed" ]]; then | |
state="${YELLOW}" | |
else | |
state="${LIGHT_RED}" | |
fi | |
# Set arrow icon based on status against remote. | |
remote_pattern="Your branch is (.*) of" | |
if [[ ${git_status} =~ ${remote_pattern} ]]; then | |
if [[ ${BASH_REMATCH[1]} == "ahead" ]]; then | |
remote="▲" | |
else | |
remote="▼" | |
fi | |
else | |
remote="" | |
fi | |
diverge_pattern="Your branch and (.*) have diverged" | |
if [[ ${git_status} =~ ${diverge_pattern} ]]; then | |
remote="▲▼" | |
fi | |
# Get the name of the branch. | |
branch=$(git symbolic-ref --short HEAD 2> /dev/null) | |
# Set the final branch string. | |
BRANCH="${state}(${branch})${remote}${COLOUR_NONE} " | |
} | |
# Determine the branch/state information for this Mercurial repository. | |
function set_mercurial_branch { | |
# Get the name of the branch. | |
branch=$(hg branch 2>/dev/null) | |
# Default state | |
state="${GREEN}" | |
if [ -n "${branch}" ]; then | |
branch=" (${branch})" | |
# Capture the output of the "hg status" command. | |
hg_status="$(hg status | wc -l)" | |
# Set colour based on clean/staged/dirty. | |
if [ "${hg_status}" -ne "0" ]; then | |
state="${RED}" | |
fi | |
fi | |
# Set the final branch string. | |
BRANCH="${state}${branch}${COLOUR_NONE} " | |
} | |
# Determine the branch informatioin for this Subversion repository. No support | |
# for svn status, since that needs to hit the remote repository. | |
function set_subversion_branch { | |
# Capture the output of the "svn info" command | |
svn_info="$(svn info | egrep '^URL: ' 2> /dev/null)" | |
# Get the name of the branch. | |
branch_pattern="^URL: .*/(branches|tags)/([^/]+)" | |
trunk_pattern="^URL: .*/trunk(/.*)?$" | |
if [[ ${svn_info} =~ $branch_pattern ]]; then | |
branch=${BASH_REMATCH[2]} | |
elif [[ ${svn_info} =~ $trunk_pattern ]]; then | |
branch='trunk' | |
fi | |
# Set the final branch string. | |
BRANCH="(${branch}) " | |
} | |
# Return the prompt symbol to use, colourized based on the return value of the | |
# previous command. | |
function set_prompt_symbol () { | |
if test $1 -eq 0 ; then | |
PROMPT_SYMBOL="\$" | |
else | |
PROMPT_SYMBOL="${LIGHT_RED}\$${COLOUR_NONE}" | |
fi | |
} | |
# Determine active Python virtualenv details. | |
function set_virtualenv () { | |
if test -z "$VIRTUAL_ENV" ; then | |
PYTHON_VIRTUALENV="" | |
else | |
PYTHON_VIRTUALENV="${BLUE}[`basename \"$VIRTUAL_ENV\"`]${COLOUR_NONE} " | |
fi | |
} | |
# Set the full bash prompt. | |
function set_bash_prompt () { | |
# Set the PROMPT_SYMBOL variable. We do this first so we don't lose the | |
# return value of the last command. | |
set_prompt_symbol $? | |
# Set the PYTHON_VIRTUALENV variable. | |
set_virtualenv | |
# Set the BRANCH variable. | |
if is_git_repository ; then | |
set_git_branch | |
elif is_subversion_repository ; then | |
set_subversion_branch | |
elif is_mercurial_repository ; then | |
set_mercurial_branch | |
else | |
BRANCH='' | |
fi | |
# Set the bash prompt variable. | |
PS1="${LIGHT_RED}\u${WHITE}@\h ${PYTHON_VIRTUALENV}${COLOUR_NONE}\w ${BRANCH} | |
${PROMPT_SYMBOL} " | |
} | |
# Tell bash to execute this function just before displaying its prompt. | |
PROMPT_COMMAND=set_bash_prompt |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment