ohmyzsh/lib/git.zsh
LFDM edc8ee9867 Adds toggle_git_prompt_visibility - fixes #2404
Reenables local hiding of a git prompt for large repositories.
Can be toggled through this new function. - Also doesn't falter when a
user has no permission to read the git config.
2014-01-07 23:25:16 +01:00

223 lines
6.6 KiB
Bash

# Basic git handling - if you need more, check the plugin
#
# This file provides several methods to inform your prompt about your
# git status. All symbols and delimiters used can be customized.
#
# The variables and methods at a glance:
#
# git_prompt_info
# Shows your branch and whether your working tree is dirty or not.
# The string is delimited by
# ZSH_THEME_GIT_PROMPT_PREFIX
# ZSH_THEME_GIT_PROMPT_SUFFIX
# The symbols used to show dirtyness (evaluated in parse_git_dirty) are
# ZSH_THEME_GIT_PROMPT_DIRTY
# ZSH_THEME_GIT_PROMPT_CLEAN
# Dirty submodules are not tracked if your git version is post 1.7.2.
# To ignore untracked files making your branch dirty, set
# DISABLE_UNTRACKED_FILES_DIRTY to 'true'
#
# git_prompt_sha
# Delimited by
# ZSH_THEME_GIT_PROMPT_SHA_BEFORE
# ZSH_THEME_GIT_PROMPT_SHA_AFTER
# By default displays the long sha key, call git_prompt_sha --short
# to have it shortened. The former functions git_prompt_long_sha and
# git_prompt_short_sha are kept for backward compatibility.
#
# git_remote_status
# Shows the difference between your local and its remote branch. Checks
# for ahead, behind or diverged status and is shown with the help of
# ZSH_THEME_GIT_PROMPT_AHEAD
# ZSH_THEME_GIT_PROMPT_BEHIND
# ZSH_THEME_GIT_PROMPT_DIVERGED
#
# git_stash_status
# Shows whether you have stashed commits or not
# ZSH_THEME_GIT_PROMPT_STASHED
#
# git_change_status
# More detailed information about the status of your working tree. Shows
# what exactly makes it dirty
# ZSH_THEME_GIT_PROMPT_ADDED
# ZSH_THEME_GIT_PROMPT_DELETED
# ZSH_THEME_GIT_PROMPT_MODIFIED
# ZSH_THEME_GIT_PROMPT_UNMERGED
# ZSH_THEME_GIT_PROMPT_UNTRACKED
#
# git_prompt_status
# Acts as a superset and combines the information of git_change_status,
# git_remote_status and git_stash_status
#
# git_prompt_info, git_prompt_status and parse_git_dirty can be disabled:
# * globally through setting ZSH_THEME_GIT_PROMPT_HIDE to 'true'
# * locally through adding a key to your repositories config file
# This needs not to be done manually, just call the function
# toggle_git_prompt_visibility to hide a specific repository.
#
# get the name of the branch we are on
function git_prompt_info() {
local branch
git_prompt_is_active || return
branch=$(current_branch) || return 1
printf '%s%s%s%s\n' \
$ZSH_THEME_GIT_PROMPT_PREFIX \
$branch \
$(parse_git_dirty) \
$ZSH_THEME_GIT_PROMPT_SUFFIX
}
# Shows the current git branch.
# Exits with 1 when git is not available
git_current_branch() {
local ref
ref=$(command git symbolic-ref HEAD 2>/dev/null) || \
ref=$(command git rev-parse --short HEAD 2>/dev/null) || return 1
echo ${ref#refs/heads/}
}
# Checks if working tree is dirty
parse_git_dirty() {
git_prompt_is_active || return
if git_is_clean; then
echo $ZSH_THEME_GIT_PROMPT_CLEAN
else
echo $ZSH_THEME_GIT_PROMPT_DIRTY
fi
}
git_is_clean() {
[[ $(command git status -s $GIT_STATUS_OPTIONS 2> /dev/null) == '' ]]
}
# Shows the long git sha, pass in --short to get it shortened
git_prompt_sha() {
local sha
sha=$(command git rev-parse $1 HEAD 2> /dev/null) && \
printf '%s%s%s\n' \
$ZSH_THEME_GIT_PROMPT_SHA_BEFORE \
$sha \
$ZSH_THEME_GIT_PROMPT_SHA_AFTER
}
# The following are kept for backwards compatibility
git_prompt_short_sha() { git_prompt_sha --short }
git_prompt_long_sha() { git_prompt_sha }
# get the difference between the local and remote branches
git_remote_status() {
local val
local remote
local return_str
remote=${1:=$(command git status --porcelain -b 2> /dev/null)}
remote=$(echo $remote | head -1)
for val in ahead behind diverged; do
echo $remote | grep "##.*$val" &>/dev/null && \
return_str+=$(eval echo \$ZSH_THEME_GIT_PROMPT_$val:u)
done
echo $return_str
}
# shows if you have stashed commits
git_stash_status() {
has_stashed_commits && echo $ZSH_THEME_GIT_PROMPT_STASHED
}
has_stashed_commits() {
command git rev-parse --verify refs/stash &>/dev/null
}
# reveals the nature of your changes in git
git_change_status() {
local change_stats
local key
local return_str
change_stats=${1:=$(command git status --porcelain -b 2> /dev/null)}
change_stats=$(echo $change_stats | awk '{ print $1 }')
for key in ${(k)ZSH_THEME_GIT_CHANGE_MAP}; do
echo $change_stats | grep -E "$key" &>/dev/null && \
return_str+=$ZSH_THEME_GIT_CHANGE_MAP[$key]
done
echo $return_str
}
# provides an associative array with instructions
# used by grep in git_change_status
setup_git_change_status() {
declare -Ag ZSH_THEME_GIT_CHANGE_MAP
# need to shield the vars with quotes, because they might
# be empty strings!
ZSH_THEME_GIT_CHANGE_MAP=(
"\?\?" "$ZSH_THEME_GIT_PROMPT_UNTRACKED"
"A" "$ZSH_THEME_GIT_PROMPT_ADDED"
"[MT]" "$ZSH_THEME_GIT_PROMPT_MODIFIED"
"D" "$ZSH_THEME_GIT_PROMPT_DELETED"
"UU" "$ZSH_THEME_GIT_PROMPT_UNMERGED"
)
}
# Combines the output of git_change_status, git_remote_status and
# git_stash_status
git_prompt_status() {
git_prompt_is_active || return
local git_index
git_index=$(command git status --porcelain -b 2> /dev/null)
printf '%s%s%s\n' \
$(git_change_status $git_index)\
$(git_remote_status $git_index)\
$(git_stash_status)
}
# compare the provided version of git to the version installed and on path
# prints 1 if installed version > input version
# prints -1 otherwise
is_recent_git_version() {
local not_recent_git
local installed_git
not_recent_git=(1 7 2);
installed_git=($(command git --version 2>/dev/null));
installed_git=(${(s/./)installed_git[3]});
for i in {1..3}; do
if [[ $installed_git[$i] -gt $not_recent_git[$i] ]]; then
return 0
fi
done
return 1
}
git_prompt_is_active() {
[[ $ZSH_THEME_GIT_PROMPT_HIDE != 'true' && \
$(command git config --get oh-my-zsh.hide-status 2>/dev/null) != "1" ]]
}
# Used to deactive git prompt updates for a single repository.
# Some users need this when they enter huge git repositories, which
# might unacceptibly slow down your prompt
toggle_git_prompt_visibility() {
local cmd='command git config --local'
local key='oh-my-zsh.hide-status'
if eval $cmd --get $key >/dev/null; then
eval $cmd --unset $key
else
eval $cmd --add $key 1
fi
}
setup_git_status_options() {
GIT_STATUS_OPTIONS=''
if is_recent_git_version; then
GIT_STATUS_OPTIONS+='--ignore-submodules=dirty'
fi
if [[ $DISABLE_UNTRACKED_FILES_DIRTY == 'true' ]]; then
GIT_STATUS_OPTIONS+=' -uno'
fi
}
# this is unlikely to change so make it all statically assigned
setup_git_status_options
setup_git_change_status