summaryrefslogtreecommitdiff
path: root/plugins/git-prompt
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/git-prompt')
-rw-r--r--plugins/git-prompt/README.md61
-rw-r--r--plugins/git-prompt/git-prompt.plugin.zsh93
-rw-r--r--plugins/git-prompt/gitstatus.py140
3 files changed, 193 insertions, 101 deletions
diff --git a/plugins/git-prompt/README.md b/plugins/git-prompt/README.md
new file mode 100644
index 000000000..e3b2d623a
--- /dev/null
+++ b/plugins/git-prompt/README.md
@@ -0,0 +1,61 @@
+# git-prompt plugin
+
+A `zsh` prompt that displays information about the current git repository. In particular:
+the branch name, difference with remote branch, number of files staged or changed, etc.
+
+To use it, add `git-prompt` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... git-prompt)
+```
+
+See the [original repository](https://github.com/olivierverdier/zsh-git-prompt).
+
+## Examples
+
+The prompt may look like the following:
+
+- `(master↑3|✚1)`: on branch `master`, ahead of remote by 3 commits, 1 file changed but not staged
+- `(status|●2)`: on branch `status`, 2 files staged
+- `(master|✚7…)`: on branch `master`, 7 files changed, some files untracked
+- `(master|✖2✚3)`: on branch `master`, 2 conflicts, 3 files changed
+- `(experimental↓2↑3|✔)`: on branch `experimental`; your branch has diverged by 3 commits, remote by 2 commits; the repository is otherwise clean
+- `(:70c2952|✔)`: not on any branch; parent commit has hash `70c2952`; the repository is otherwise clean
+
+## Prompt Structure
+
+By default, the general appearance of the prompt is:
+
+```
+(<branch><branch tracking>|<local status>)
+```
+
+The symbols are as follows:
+
+### Local Status Symbols
+
+| Symbol | Meaning |
+|--------|--------------------------------|
+| ✔ | repository clean |
+| ●n | there are `n` staged files |
+| ✖n | there are `n` unmerged files |
+| ✚n | there are `n` unstaged files |
+| … | there are some untracked files |
+
+### Branch Tracking Symbols
+
+| Symbol | Meaning |
+|--------|---------------------------------------------------------------|
+| ↑n | ahead of remote by `n` commits |
+| ↓n | behind remote by `n` commits |
+| ↓m↑n | branches diverged: other by `m` commits, yours by `n` commits |
+
+## Customisation
+
+- Set the variable `ZSH_THEME_GIT_PROMPT_CACHE` to any value in order to enable caching.
+- You may also change a number of variables (whose name start with `ZSH_THEME_GIT_PROMPT_`)
+ to change the appearance of the prompt. Take a look at the bottom of the [plugin file](git-prompt.plugin.zsh)`
+ to see what variables are available.
+
+
+**Enjoy!**
diff --git a/plugins/git-prompt/git-prompt.plugin.zsh b/plugins/git-prompt/git-prompt.plugin.zsh
index d868a5fe1..da674af98 100644
--- a/plugins/git-prompt/git-prompt.plugin.zsh
+++ b/plugins/git-prompt/git-prompt.plugin.zsh
@@ -1,57 +1,90 @@
-# ZSH Git Prompt Plugin from:
-# http://github.com/olivierverdier/zsh-git-prompt
-#
-export __GIT_PROMPT_DIR=$ZSH/plugins/git-prompt
+__GIT_PROMPT_DIR="${0:A:h}"
-# Allow for functions in the prompt.
-setopt PROMPT_SUBST
-
-## Enable auto-execution of functions.
-typeset -ga preexec_functions
-typeset -ga precmd_functions
-typeset -ga chpwd_functions
-
-# Append git functions needed for prompt.
-preexec_functions+='preexec_update_git_vars'
-precmd_functions+='precmd_update_git_vars'
-chpwd_functions+='chpwd_update_git_vars'
+## Hook function definitions
+function chpwd_update_git_vars() {
+ update_current_git_vars
+}
-## Function definitions
function preexec_update_git_vars() {
case "$2" in
- git*)
+ git*|hub*|gh*|stg*)
__EXECUTED_GIT_COMMAND=1
;;
esac
}
function precmd_update_git_vars() {
- if [ -n "$__EXECUTED_GIT_COMMAND" ]; then
+ if [ -n "$__EXECUTED_GIT_COMMAND" ] || [ ! -n "$ZSH_THEME_GIT_PROMPT_CACHE" ]; then
update_current_git_vars
unset __EXECUTED_GIT_COMMAND
fi
}
-function chpwd_update_git_vars() {
- update_current_git_vars
-}
+autoload -U add-zsh-hook
+add-zsh-hook chpwd chpwd_update_git_vars
+add-zsh-hook precmd precmd_update_git_vars
+add-zsh-hook preexec preexec_update_git_vars
+
+## Function definitions
function update_current_git_vars() {
unset __CURRENT_GIT_STATUS
local gitstatus="$__GIT_PROMPT_DIR/gitstatus.py"
- _GIT_STATUS=`python ${gitstatus}`
- __CURRENT_GIT_STATUS=("${(f)_GIT_STATUS}")
+ _GIT_STATUS=$(python ${gitstatus} 2>/dev/null)
+ __CURRENT_GIT_STATUS=("${(@s: :)_GIT_STATUS}")
+ GIT_BRANCH=$__CURRENT_GIT_STATUS[1]
+ GIT_AHEAD=$__CURRENT_GIT_STATUS[2]
+ GIT_BEHIND=$__CURRENT_GIT_STATUS[3]
+ GIT_STAGED=$__CURRENT_GIT_STATUS[4]
+ GIT_CONFLICTS=$__CURRENT_GIT_STATUS[5]
+ GIT_CHANGED=$__CURRENT_GIT_STATUS[6]
+ GIT_UNTRACKED=$__CURRENT_GIT_STATUS[7]
}
-function prompt_git_info() {
+git_super_status() {
+ precmd_update_git_vars
if [ -n "$__CURRENT_GIT_STATUS" ]; then
- echo "(%{${fg[red]}%}$__CURRENT_GIT_STATUS[1]%{${fg[default]}%}$__CURRENT_GIT_STATUS[2]%{${fg[magenta]}%}$__CURRENT_GIT_STATUS[3]%{${fg[default]}%})"
+ STATUS="$ZSH_THEME_GIT_PROMPT_PREFIX$ZSH_THEME_GIT_PROMPT_BRANCH$GIT_BRANCH%{${reset_color}%}"
+ if [ "$GIT_BEHIND" -ne "0" ]; then
+ STATUS="$STATUS$ZSH_THEME_GIT_PROMPT_BEHIND$GIT_BEHIND%{${reset_color}%}"
+ fi
+ if [ "$GIT_AHEAD" -ne "0" ]; then
+ STATUS="$STATUS$ZSH_THEME_GIT_PROMPT_AHEAD$GIT_AHEAD%{${reset_color}%}"
+ fi
+ STATUS="$STATUS$ZSH_THEME_GIT_PROMPT_SEPARATOR"
+ if [ "$GIT_STAGED" -ne "0" ]; then
+ STATUS="$STATUS$ZSH_THEME_GIT_PROMPT_STAGED$GIT_STAGED%{${reset_color}%}"
+ fi
+ if [ "$GIT_CONFLICTS" -ne "0" ]; then
+ STATUS="$STATUS$ZSH_THEME_GIT_PROMPT_CONFLICTS$GIT_CONFLICTS%{${reset_color}%}"
+ fi
+ if [ "$GIT_CHANGED" -ne "0" ]; then
+ STATUS="$STATUS$ZSH_THEME_GIT_PROMPT_CHANGED$GIT_CHANGED%{${reset_color}%}"
+ fi
+ if [ "$GIT_UNTRACKED" -ne "0" ]; then
+ STATUS="$STATUS$ZSH_THEME_GIT_PROMPT_UNTRACKED%{${reset_color}%}"
+ fi
+ if [ "$GIT_CHANGED" -eq "0" ] && [ "$GIT_CONFLICTS" -eq "0" ] && [ "$GIT_STAGED" -eq "0" ] && [ "$GIT_UNTRACKED" -eq "0" ]; then
+ STATUS="$STATUS$ZSH_THEME_GIT_PROMPT_CLEAN"
+ fi
+ STATUS="$STATUS%{${reset_color}%}$ZSH_THEME_GIT_PROMPT_SUFFIX"
+ echo "$STATUS"
fi
}
+# Default values for the appearance of the prompt.
+ZSH_THEME_GIT_PROMPT_PREFIX="("
+ZSH_THEME_GIT_PROMPT_SUFFIX=")"
+ZSH_THEME_GIT_PROMPT_SEPARATOR="|"
+ZSH_THEME_GIT_PROMPT_BRANCH="%{$fg_bold[magenta]%}"
+ZSH_THEME_GIT_PROMPT_STAGED="%{$fg[red]%}%{●%G%}"
+ZSH_THEME_GIT_PROMPT_CONFLICTS="%{$fg[red]%}%{✖%G%}"
+ZSH_THEME_GIT_PROMPT_CHANGED="%{$fg[blue]%}%{✚%G%}"
+ZSH_THEME_GIT_PROMPT_BEHIND="%{↓%G%}"
+ZSH_THEME_GIT_PROMPT_AHEAD="%{↑%G%}"
+ZSH_THEME_GIT_PROMPT_UNTRACKED="%{…%G%}"
+ZSH_THEME_GIT_PROMPT_CLEAN="%{$fg_bold[green]%}%{✔%G%}"
+
# Set the prompt.
-#PROMPT='%B%m%~%b$(prompt_git_info) %# '
-# for a right prompt:
-#RPROMPT='%b$(prompt_git_info)'
-RPROMPT='$(prompt_git_info)'
+RPROMPT='$(git_super_status)'
diff --git a/plugins/git-prompt/gitstatus.py b/plugins/git-prompt/gitstatus.py
index 256841432..300365d71 100644
--- a/plugins/git-prompt/gitstatus.py
+++ b/plugins/git-prompt/gitstatus.py
@@ -1,82 +1,80 @@
#!/usr/bin/env python
-# -*- coding: UTF-8 -*-
-from subprocess import Popen, PIPE
+from __future__ import print_function
+
+import os
+import sys
import re
+from subprocess import Popen, PIPE, check_output
-# change those symbols to whatever you prefer
-symbols = {
- 'ahead of': '↑',
- 'behind': '↓',
- 'staged': '♦',
- 'changed': '‣',
- 'untracked': '…',
- 'clean': '⚡',
- 'unmerged': '≠',
- 'sha1': ':'
-}
-output, error = Popen(
- ['git', 'status'], stdout=PIPE, stderr=PIPE, universal_newlines=True).communicate()
+def get_tagname_or_hash():
+ """return tagname if exists else hash"""
+ # get hash
+ hash_cmd = ['git', 'rev-parse', '--short', 'HEAD']
+ hash_ = check_output(hash_cmd).strip()
-if error:
- import sys
- sys.exit(0)
-lines = output.splitlines()
+ # get tagname
+ tags_cmd = ['git', 'for-each-ref', '--points-at=HEAD', '--count=2', '--sort=-version:refname', '--format=%(refname:short)', 'refs/tags']
+ tags = check_output(tags_cmd).split()
-behead_re = re.compile(
- r"^# Your branch is (ahead of|behind) '(.*)' by (\d+) commit")
-diverge_re = re.compile(r"^# and have (\d+) and (\d+) different")
+ if tags:
+ return tags[0] + ('+' if len(tags) > 1 else '')
+ elif hash_:
+ return hash_
+ return None
-status = ''
-staged = re.compile(r'^# Changes to be committed:$', re.MULTILINE)
-changed = re.compile(r'^# Changed but not updated:$', re.MULTILINE)
-untracked = re.compile(r'^# Untracked files:$', re.MULTILINE)
-unmerged = re.compile(r'^# Unmerged paths:$', re.MULTILINE)
+# `git status --porcelain --branch` can collect all information
+# branch, remote_branch, untracked, staged, changed, conflicts, ahead, behind
+po = Popen(['git', 'status', '--porcelain', '--branch'], env=dict(os.environ, LANG="C"), stdout=PIPE, stderr=PIPE)
+stdout, sterr = po.communicate()
+if po.returncode != 0:
+ sys.exit(0) # Not a git repository
-def execute(*command):
- out, err = Popen(stdout=PIPE, stderr=PIPE, *command).communicate()
- if not err:
- nb = len(out.splitlines())
+# collect git status information
+untracked, staged, changed, conflicts = [], [], [], []
+ahead, behind = 0, 0
+status = [(line[0], line[1], line[2:]) for line in stdout.decode('utf-8').splitlines()]
+for st in status:
+ if st[0] == '#' and st[1] == '#':
+ if re.search('Initial commit on', st[2]) or re.search('No commits yet on', st[2]):
+ branch = st[2].split(' ')[-1]
+ elif re.search('no branch', st[2]): # detached status
+ branch = get_tagname_or_hash()
+ elif len(st[2].strip().split('...')) == 1:
+ branch = st[2].strip()
+ else:
+ # current and remote branch info
+ branch, rest = st[2].strip().split('...')
+ if len(rest.split(' ')) == 1:
+ # remote_branch = rest.split(' ')[0]
+ pass
+ else:
+ # ahead or behind
+ divergence = ' '.join(rest.split(' ')[1:])
+ divergence = divergence.lstrip('[').rstrip(']')
+ for div in divergence.split(', '):
+ if 'ahead' in div:
+ ahead = int(div[len('ahead '):].strip())
+ elif 'behind' in div:
+ behind = int(div[len('behind '):].strip())
+ elif st[0] == '?' and st[1] == '?':
+ untracked.append(st)
else:
- nb = '?'
- return nb
-
-if staged.search(output):
- nb = execute(
- ['git', 'diff', '--staged', '--name-only', '--diff-filter=ACDMRT'])
- status += '%s%s' % (symbols['staged'], nb)
-if unmerged.search(output):
- nb = execute(['git', 'diff', '--staged', '--name-only', '--diff-filter=U'])
- status += '%s%s' % (symbols['unmerged'], nb)
-if changed.search(output):
- nb = execute(['git', 'diff', '--name-only', '--diff-filter=ACDMRT'])
- status += '%s%s' % (symbols['changed'], nb)
-if untracked.search(output):
- status += symbols['untracked']
-if status == '':
- status = symbols['clean']
-
-remote = ''
-
-bline = lines[0]
-if bline.find('Not currently on any branch') != -1:
- branch = symbols['sha1'] + Popen([
- 'git',
- 'rev-parse',
- '--short',
- 'HEAD'], stdout=PIPE).communicate()[0][:-1]
-else:
- branch = bline.split(' ')[-1]
- bstatusline = lines[1]
- match = behead_re.match(bstatusline)
- if match:
- remote = symbols[match.groups()[0]]
- remote += match.groups()[2]
- elif lines[2:]:
- div_match = diverge_re.match(lines[2])
- if div_match:
- remote = "{behind}{1}{ahead of}{0}".format(
- *div_match.groups(), **symbols)
+ if st[1] == 'M':
+ changed.append(st)
+ if st[0] == 'U':
+ conflicts.append(st)
+ elif st[0] != ' ':
+ staged.append(st)
-print('\n'.join([branch, remote, status]))
+out = ' '.join([
+ branch,
+ str(ahead),
+ str(behind),
+ str(len(staged)),
+ str(len(conflicts)),
+ str(len(changed)),
+ str(len(untracked)),
+])
+print(out, end='')
generated by cgit v1.2.3-70-g09d2 (git 2.48.1) at 2025-02-09 09:26:14 +0000