git.zsh 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318
  1. # The git prompt's git commands are read-only and should not interfere with
  2. # other processes. This environment variable is equivalent to running with `git
  3. # --no-optional-locks`, but falls back gracefully for older versions of git.
  4. # See git(1) for and git-status(1) for a description of that flag.
  5. #
  6. # We wrap in a local function instead of exporting the variable directly in
  7. # order to avoid interfering with manually-run git commands by the user.
  8. function __git_prompt_git() {
  9. GIT_OPTIONAL_LOCKS=0 command git "$@"
  10. }
  11. function _omz_git_prompt_status() {
  12. # If we are on a folder not tracked by git, get out.
  13. # Otherwise, check for hide-info at global and local repository level
  14. if ! __git_prompt_git rev-parse --git-dir &> /dev/null \
  15. || [[ "$(__git_prompt_git config --get oh-my-zsh.hide-info 2>/dev/null)" == 1 ]]; then
  16. return 0
  17. fi
  18. # Get either:
  19. # - the current branch name
  20. # - the tag name if we are on a tag
  21. # - the short SHA of the current commit
  22. local ref
  23. ref=$(__git_prompt_git symbolic-ref --short HEAD 2> /dev/null) \
  24. || ref=$(__git_prompt_git describe --tags --exact-match HEAD 2> /dev/null) \
  25. || ref=$(__git_prompt_git rev-parse --short HEAD 2> /dev/null) \
  26. || return 0
  27. # Use global ZSH_THEME_GIT_SHOW_UPSTREAM=1 for including upstream remote info
  28. local upstream
  29. if (( ${+ZSH_THEME_GIT_SHOW_UPSTREAM} )); then
  30. upstream=$(__git_prompt_git rev-parse --abbrev-ref --symbolic-full-name "@{upstream}" 2>/dev/null) \
  31. && upstream=" -> ${upstream}"
  32. fi
  33. echo "${ZSH_THEME_GIT_PROMPT_PREFIX}${ref:gs/%/%%}${upstream:gs/%/%%}$(parse_git_dirty)${ZSH_THEME_GIT_PROMPT_SUFFIX}"
  34. }
  35. # Enable async prompt by default unless the setting is at false / no
  36. if zstyle -t ':omz:alpha:lib:git' async-prompt; then
  37. function git_prompt_info() {
  38. if [[ -n "$_OMZ_ASYNC_OUTPUT[_omz_git_prompt_status]" ]]; then
  39. echo -n "$_OMZ_ASYNC_OUTPUT[_omz_git_prompt_status]"
  40. fi
  41. }
  42. # Conditionally register the async handler, only if it's needed in $PROMPT
  43. # or any of the other prompt variables
  44. function _defer_async_git_register() {
  45. # Check if git_prompt_info is used in a prompt variable
  46. case "${PS1}:${PS2}:${PS3}:${PS4}:${RPS1}:${RPS2}:${RPS3}:${RPS4}" in
  47. *(\$\(git_prompt_info\)|\`git_prompt_info\`)*)
  48. _omz_register_handler _omz_git_prompt_status
  49. return
  50. ;;
  51. esac
  52. add-zsh-hook -d precmd _defer_async_git_register
  53. unset -f _defer_async_git_register
  54. }
  55. # Register the async handler first. This needs to be done before
  56. # the async request prompt is run
  57. precmd_functions=(_defer_async_git_register $precmd_functions)
  58. else
  59. function git_prompt_info() {
  60. _omz_git_prompt_status
  61. }
  62. fi
  63. # Checks if working tree is dirty
  64. function parse_git_dirty() {
  65. local STATUS
  66. local -a FLAGS
  67. FLAGS=('--porcelain')
  68. if [[ "$(__git_prompt_git config --get oh-my-zsh.hide-dirty)" != "1" ]]; then
  69. if [[ "${DISABLE_UNTRACKED_FILES_DIRTY:-}" == "true" ]]; then
  70. FLAGS+='--untracked-files=no'
  71. fi
  72. case "${GIT_STATUS_IGNORE_SUBMODULES:-}" in
  73. git)
  74. # let git decide (this respects per-repo config in .gitmodules)
  75. ;;
  76. *)
  77. # if unset: ignore dirty submodules
  78. # other values are passed to --ignore-submodules
  79. FLAGS+="--ignore-submodules=${GIT_STATUS_IGNORE_SUBMODULES:-dirty}"
  80. ;;
  81. esac
  82. STATUS=$(__git_prompt_git status ${FLAGS} 2> /dev/null | tail -n 1)
  83. fi
  84. if [[ -n $STATUS ]]; then
  85. echo "$ZSH_THEME_GIT_PROMPT_DIRTY"
  86. else
  87. echo "$ZSH_THEME_GIT_PROMPT_CLEAN"
  88. fi
  89. }
  90. # Gets the difference between the local and remote branches
  91. function git_remote_status() {
  92. local remote ahead behind git_remote_status git_remote_status_detailed
  93. remote=${$(__git_prompt_git rev-parse --verify ${hook_com[branch]}@{upstream} --symbolic-full-name 2>/dev/null)/refs\/remotes\/}
  94. if [[ -n ${remote} ]]; then
  95. ahead=$(__git_prompt_git rev-list ${hook_com[branch]}@{upstream}..HEAD 2>/dev/null | wc -l)
  96. behind=$(__git_prompt_git rev-list HEAD..${hook_com[branch]}@{upstream} 2>/dev/null | wc -l)
  97. if [[ $ahead -eq 0 ]] && [[ $behind -eq 0 ]]; then
  98. git_remote_status="$ZSH_THEME_GIT_PROMPT_EQUAL_REMOTE"
  99. elif [[ $ahead -gt 0 ]] && [[ $behind -eq 0 ]]; then
  100. git_remote_status="$ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE"
  101. git_remote_status_detailed="$ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE_COLOR$ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE$((ahead))%{$reset_color%}"
  102. elif [[ $behind -gt 0 ]] && [[ $ahead -eq 0 ]]; then
  103. git_remote_status="$ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE"
  104. git_remote_status_detailed="$ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE_COLOR$ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE$((behind))%{$reset_color%}"
  105. elif [[ $ahead -gt 0 ]] && [[ $behind -gt 0 ]]; then
  106. git_remote_status="$ZSH_THEME_GIT_PROMPT_DIVERGED_REMOTE"
  107. git_remote_status_detailed="$ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE_COLOR$ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE$((ahead))%{$reset_color%}$ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE_COLOR$ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE$((behind))%{$reset_color%}"
  108. fi
  109. if [[ -n $ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_DETAILED ]]; then
  110. git_remote_status="$ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_PREFIX${remote:gs/%/%%}$git_remote_status_detailed$ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_SUFFIX"
  111. fi
  112. echo $git_remote_status
  113. fi
  114. }
  115. # Outputs the name of the current branch
  116. # Usage example: git pull origin $(git_current_branch)
  117. # Using '--quiet' with 'symbolic-ref' will not cause a fatal error (128) if
  118. # it's not a symbolic ref, but in a Git repo.
  119. function git_current_branch() {
  120. local ref
  121. ref=$(__git_prompt_git symbolic-ref --quiet HEAD 2> /dev/null)
  122. local ret=$?
  123. if [[ $ret != 0 ]]; then
  124. [[ $ret == 128 ]] && return # no git repo.
  125. ref=$(__git_prompt_git rev-parse --short HEAD 2> /dev/null) || return
  126. fi
  127. echo ${ref#refs/heads/}
  128. }
  129. # Gets the number of commits ahead from remote
  130. function git_commits_ahead() {
  131. if __git_prompt_git rev-parse --git-dir &>/dev/null; then
  132. local commits="$(__git_prompt_git rev-list --count @{upstream}..HEAD 2>/dev/null)"
  133. if [[ -n "$commits" && "$commits" != 0 ]]; then
  134. echo "$ZSH_THEME_GIT_COMMITS_AHEAD_PREFIX$commits$ZSH_THEME_GIT_COMMITS_AHEAD_SUFFIX"
  135. fi
  136. fi
  137. }
  138. # Gets the number of commits behind remote
  139. function git_commits_behind() {
  140. if __git_prompt_git rev-parse --git-dir &>/dev/null; then
  141. local commits="$(__git_prompt_git rev-list --count HEAD..@{upstream} 2>/dev/null)"
  142. if [[ -n "$commits" && "$commits" != 0 ]]; then
  143. echo "$ZSH_THEME_GIT_COMMITS_BEHIND_PREFIX$commits$ZSH_THEME_GIT_COMMITS_BEHIND_SUFFIX"
  144. fi
  145. fi
  146. }
  147. # Outputs if current branch is ahead of remote
  148. function git_prompt_ahead() {
  149. if [[ -n "$(__git_prompt_git rev-list origin/$(git_current_branch)..HEAD 2> /dev/null)" ]]; then
  150. echo "$ZSH_THEME_GIT_PROMPT_AHEAD"
  151. fi
  152. }
  153. # Outputs if current branch is behind remote
  154. function git_prompt_behind() {
  155. if [[ -n "$(__git_prompt_git rev-list HEAD..origin/$(git_current_branch) 2> /dev/null)" ]]; then
  156. echo "$ZSH_THEME_GIT_PROMPT_BEHIND"
  157. fi
  158. }
  159. # Outputs if current branch exists on remote or not
  160. function git_prompt_remote() {
  161. if [[ -n "$(__git_prompt_git show-ref origin/$(git_current_branch) 2> /dev/null)" ]]; then
  162. echo "$ZSH_THEME_GIT_PROMPT_REMOTE_EXISTS"
  163. else
  164. echo "$ZSH_THEME_GIT_PROMPT_REMOTE_MISSING"
  165. fi
  166. }
  167. # Formats prompt string for current git commit short SHA
  168. function git_prompt_short_sha() {
  169. local SHA
  170. SHA=$(__git_prompt_git rev-parse --short HEAD 2> /dev/null) && echo "$ZSH_THEME_GIT_PROMPT_SHA_BEFORE$SHA$ZSH_THEME_GIT_PROMPT_SHA_AFTER"
  171. }
  172. # Formats prompt string for current git commit long SHA
  173. function git_prompt_long_sha() {
  174. local SHA
  175. SHA=$(__git_prompt_git rev-parse HEAD 2> /dev/null) && echo "$ZSH_THEME_GIT_PROMPT_SHA_BEFORE$SHA$ZSH_THEME_GIT_PROMPT_SHA_AFTER"
  176. }
  177. function git_prompt_status() {
  178. [[ "$(__git_prompt_git config --get oh-my-zsh.hide-status 2>/dev/null)" = 1 ]] && return
  179. # Maps a git status prefix to an internal constant
  180. # This cannot use the prompt constants, as they may be empty
  181. local -A prefix_constant_map
  182. prefix_constant_map=(
  183. '\?\? ' 'UNTRACKED'
  184. 'A ' 'ADDED'
  185. 'M ' 'ADDED'
  186. 'MM ' 'MODIFIED'
  187. ' M ' 'MODIFIED'
  188. 'AM ' 'MODIFIED'
  189. ' T ' 'MODIFIED'
  190. 'R ' 'RENAMED'
  191. ' D ' 'DELETED'
  192. 'D ' 'DELETED'
  193. 'UU ' 'UNMERGED'
  194. 'ahead' 'AHEAD'
  195. 'behind' 'BEHIND'
  196. 'diverged' 'DIVERGED'
  197. 'stashed' 'STASHED'
  198. )
  199. # Maps the internal constant to the prompt theme
  200. local -A constant_prompt_map
  201. constant_prompt_map=(
  202. 'UNTRACKED' "$ZSH_THEME_GIT_PROMPT_UNTRACKED"
  203. 'ADDED' "$ZSH_THEME_GIT_PROMPT_ADDED"
  204. 'MODIFIED' "$ZSH_THEME_GIT_PROMPT_MODIFIED"
  205. 'RENAMED' "$ZSH_THEME_GIT_PROMPT_RENAMED"
  206. 'DELETED' "$ZSH_THEME_GIT_PROMPT_DELETED"
  207. 'UNMERGED' "$ZSH_THEME_GIT_PROMPT_UNMERGED"
  208. 'AHEAD' "$ZSH_THEME_GIT_PROMPT_AHEAD"
  209. 'BEHIND' "$ZSH_THEME_GIT_PROMPT_BEHIND"
  210. 'DIVERGED' "$ZSH_THEME_GIT_PROMPT_DIVERGED"
  211. 'STASHED' "$ZSH_THEME_GIT_PROMPT_STASHED"
  212. )
  213. # The order that the prompt displays should be added to the prompt
  214. local status_constants
  215. status_constants=(
  216. UNTRACKED ADDED MODIFIED RENAMED DELETED
  217. STASHED UNMERGED AHEAD BEHIND DIVERGED
  218. )
  219. local status_text
  220. status_text="$(__git_prompt_git status --porcelain -b 2> /dev/null)"
  221. # Don't continue on a catastrophic failure
  222. if [[ $? -eq 128 ]]; then
  223. return 1
  224. fi
  225. # A lookup table of each git status encountered
  226. local -A statuses_seen
  227. if __git_prompt_git rev-parse --verify refs/stash &>/dev/null; then
  228. statuses_seen[STASHED]=1
  229. fi
  230. local status_lines
  231. status_lines=("${(@f)${status_text}}")
  232. # If the tracking line exists, get and parse it
  233. if [[ "$status_lines[1]" =~ "^## [^ ]+ \[(.*)\]" ]]; then
  234. local branch_statuses
  235. branch_statuses=("${(@s/,/)match}")
  236. for branch_status in $branch_statuses; do
  237. if [[ ! $branch_status =~ "(behind|diverged|ahead) ([0-9]+)?" ]]; then
  238. continue
  239. fi
  240. local last_parsed_status=$prefix_constant_map[$match[1]]
  241. statuses_seen[$last_parsed_status]=$match[2]
  242. done
  243. fi
  244. # For each status prefix, do a regex comparison
  245. for status_prefix in ${(k)prefix_constant_map}; do
  246. local status_constant="${prefix_constant_map[$status_prefix]}"
  247. local status_regex=$'(^|\n)'"$status_prefix"
  248. if [[ "$status_text" =~ $status_regex ]]; then
  249. statuses_seen[$status_constant]=1
  250. fi
  251. done
  252. # Display the seen statuses in the order specified
  253. local status_prompt
  254. for status_constant in $status_constants; do
  255. if (( ${+statuses_seen[$status_constant]} )); then
  256. local next_display=$constant_prompt_map[$status_constant]
  257. status_prompt="$next_display$status_prompt"
  258. fi
  259. done
  260. echo $status_prompt
  261. }
  262. # Outputs the name of the current user
  263. # Usage example: $(git_current_user_name)
  264. function git_current_user_name() {
  265. __git_prompt_git config user.name 2>/dev/null
  266. }
  267. # Outputs the email of the current user
  268. # Usage example: $(git_current_user_email)
  269. function git_current_user_email() {
  270. __git_prompt_git config user.email 2>/dev/null
  271. }
  272. # Output the name of the root directory of the git repository
  273. # Usage example: $(git_repo_name)
  274. function git_repo_name() {
  275. local repo_path
  276. if repo_path="$(__git_prompt_git rev-parse --show-toplevel 2>/dev/null)" && [[ -n "$repo_path" ]]; then
  277. echo ${repo_path:t}
  278. fi
  279. }