API tools faq
paste
Guest User

Untitled

a guest
Oct 27th, 2016
51
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 15.01 KB | None | 0 0
raw download clone embed print report
  1. # bash/zsh git prompt support
  2. #
  3. # Copyright (C) 2006,2007 Shawn O. Pearce <spearce@spearce.org>
  4. # Distributed under the GNU General Public License, version 2.0.
  5. #
  6. # This script allows you to see repository status in your prompt.
  7. #
  8. # To enable:
  9. #
  10. # 1) Copy this file to somewhere (e.g. ~/.git-prompt.sh).
  11. # 2) Add the following line to your .bashrc/.zshrc:
  12. # source ~/.git-prompt.sh
  13. # 3a) Change your PS1 to call __git_ps1 as
  14. # command-substitution:
  15. # Bash: PS1='[\u@\h \W$(__git_ps1 " (%s)")]\$ '
  16. # ZSH: setopt PROMPT_SUBST ; PS1='[%n@%m %c$(__git_ps1 " (%s)")]\$ '
  17. # the optional argument will be used as format string.
  18. # 3b) Alternatively, for a slightly faster prompt, __git_ps1 can
  19. # be used for PROMPT_COMMAND in Bash or for precmd() in Zsh
  20. # with two parameters, <pre> and <post>, which are strings
  21. # you would put in $PS1 before and after the status string
  22. # generated by the git-prompt machinery. e.g.
  23. # Bash: PROMPT_COMMAND='__git_ps1 "\u@\h:\w" "\\\$ "'
  24. # will show username, at-sign, host, colon, cwd, then
  25. # various status string, followed by dollar and SP, as
  26. # your prompt.
  27. # ZSH: precmd () { __git_ps1 "%n" ":%~$ " "|%s" }
  28. # will show username, pipe, then various status string,
  29. # followed by colon, cwd, dollar and SP, as your prompt.
  30. # Optionally, you can supply a third argument with a printf
  31. # format string to finetune the output of the branch status
  32. #
  33. # The repository status will be displayed only if you are currently in a
  34. # git repository. The %s token is the placeholder for the shown status.
  35. #
  36. # The prompt status always includes the current branch name.
  37. #
  38. # In addition, if you set GIT_PS1_SHOWDIRTYSTATE to a nonempty value,
  39. # unstaged (*) and staged (+) changes will be shown next to the branch
  40. # name. You can configure this per-repository with the
  41. # bash.showDirtyState variable, which defaults to true once
  42. # GIT_PS1_SHOWDIRTYSTATE is enabled.
  43. #
  44. # You can also see if currently something is stashed, by setting
  45. # GIT_PS1_SHOWSTASHSTATE to a nonempty value. If something is stashed,
  46. # then a '$' will be shown next to the branch name.
  47. #
  48. # If you would like to see if there're untracked files, then you can set
  49. # GIT_PS1_SHOWUNTRACKEDFILES to a nonempty value. If there're untracked
  50. # files, then a '%' will be shown next to the branch name. You can
  51. # configure this per-repository with the bash.showUntrackedFiles
  52. # variable, which defaults to true once GIT_PS1_SHOWUNTRACKEDFILES is
  53. # enabled.
  54. #
  55. # If you would like to see the difference between HEAD and its upstream,
  56. # set GIT_PS1_SHOWUPSTREAM="auto". A "<" indicates you are behind, ">"
  57. # indicates you are ahead, "<>" indicates you have diverged and "="
  58. # indicates that there is no difference. You can further control
  59. # behaviour by setting GIT_PS1_SHOWUPSTREAM to a space-separated list
  60. # of values:
  61. #
  62. # verbose show number of commits ahead/behind (+/-) upstream
  63. # name if verbose, then also show the upstream abbrev name
  64. # legacy don't use the '--count' option available in recent
  65. # versions of git-rev-list
  66. # git always compare HEAD to @{upstream}
  67. # svn always compare HEAD to your SVN upstream
  68. #
  69. # By default, __git_ps1 will compare HEAD to your SVN upstream if it can
  70. # find one, or @{upstream} otherwise. Once you have set
  71. # GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by
  72. # setting the bash.showUpstream config variable.
  73. #
  74. # If you would like to see more information about the identity of
  75. # commits checked out as a detached HEAD, set GIT_PS1_DESCRIBE_STYLE
  76. # to one of these values:
  77. #
  78. # contains relative to newer annotated tag (v1.6.3.2~35)
  79. # branch relative to newer tag or branch (master~4)
  80. # describe relative to older annotated tag (v1.6.3.1-13-gdd42c2f)
  81. # default exactly matching tag
  82. #
  83. # If you would like a colored hint about the current dirty state, set
  84. # GIT_PS1_SHOWCOLORHINTS to a nonempty value. The colors are based on
  85. # the colored output of "git status -sb" and are available only when
  86. # using __git_ps1 for PROMPT_COMMAND or precmd.
  87.  
  88. # check whether printf supports -v
  89. __git_printf_supports_v=
  90. printf -v __git_printf_supports_v -- '%s' yes >/dev/null 2>&1
  91.  
  92. # stores the divergence from upstream in $p
  93. # used by GIT_PS1_SHOWUPSTREAM
  94. __git_ps1_show_upstream ()
  95. {
  96. local key value
  97. local svn_remote svn_url_pattern count n
  98. local upstream=git legacy="" verbose="" name=""
  99.  
  100. svn_remote=()
  101. # get some config options from git-config
  102. local output="$(git config -z --get-regexp '^(svn-remote\..*\.url|bash\.showupstream)$' 2>/dev/null | tr '\0\n' '\n ')"
  103. while read -r key value; do
  104. case "$key" in
  105. bash.showupstream)
  106. GIT_PS1_SHOWUPSTREAM="$value"
  107. if [[ -z "${GIT_PS1_SHOWUPSTREAM}" ]]; then
  108. p=""
  109. return
  110. fi
  111. ;;
  112. svn-remote.*.url)
  113. svn_remote[$((${#svn_remote[@]} + 1))]="$value"
  114. svn_url_pattern="$svn_url_pattern\\|$value"
  115. upstream=svn+git # default upstream is SVN if available, else git
  116. ;;
  117. esac
  118. done <<< "$output"
  119.  
  120. # parse configuration values
  121. for option in ${GIT_PS1_SHOWUPSTREAM}; do
  122. case "$option" in
  123. git|svn) upstream="$option" ;;
  124. verbose) verbose=1 ;;
  125. legacy) legacy=1 ;;
  126. name) name=1 ;;
  127. esac
  128. done
  129.  
  130. # Find our upstream
  131. case "$upstream" in
  132. git) upstream="@{upstream}" ;;
  133. svn*)
  134. # get the upstream from the "git-svn-id: ..." in a commit message
  135. # (git-svn uses essentially the same procedure internally)
  136. local -a svn_upstream
  137. svn_upstream=($(git log --first-parent -1 \
  138. --grep="^git-svn-id: \(${svn_url_pattern#??}\)" 2>/dev/null))
  139. if [[ 0 -ne ${#svn_upstream[@]} ]]; then
  140. svn_upstream=${svn_upstream[${#svn_upstream[@]} - 2]}
  141. svn_upstream=${svn_upstream%@*}
  142. local n_stop="${#svn_remote[@]}"
  143. for ((n=1; n <= n_stop; n++)); do
  144. svn_upstream=${svn_upstream#${svn_remote[$n]}}
  145. done
  146.  
  147. if [[ -z "$svn_upstream" ]]; then
  148. # default branch name for checkouts with no layout:
  149. upstream=${GIT_SVN_ID:-git-svn}
  150. else
  151. upstream=${svn_upstream#/}
  152. fi
  153. elif [[ "svn+git" = "$upstream" ]]; then
  154. upstream="@{upstream}"
  155. fi
  156. ;;
  157. esac
  158.  
  159. # Find how many commits we are ahead/behind our upstream
  160. if [[ -z "$legacy" ]]; then
  161. count="$(git rev-list --count --left-right \
  162. "$upstream"...HEAD 2>/dev/null)"
  163. else
  164. # produce equivalent output to --count for older versions of git
  165. local commits
  166. if commits="$(git rev-list --left-right "$upstream"...HEAD 2>/dev/null)"
  167. then
  168. local commit behind=0 ahead=0
  169. for commit in $commits
  170. do
  171. case "$commit" in
  172. "<"*) ((behind++)) ;;
  173. *) ((ahead++)) ;;
  174. esac
  175. done
  176. count="$behind $ahead"
  177. else
  178. count=""
  179. fi
  180. fi
  181.  
  182. # calculate the result
  183. if [[ -z "$verbose" ]]; then
  184. case "$count" in
  185. "") # no upstream
  186. p="" ;;
  187. "0 0") # equal to upstream
  188. p="=" ;;
  189. "0 "*) # ahead of upstream
  190. p=">" ;;
  191. *" 0") # behind upstream
  192. p="<" ;;
  193. *) # diverged from upstream
  194. p="<>" ;;
  195. esac
  196. else
  197. case "$count" in
  198. "") # no upstream
  199. p="" ;;
  200. "0 0") # equal to upstream
  201. p=" u=" ;;
  202. "0 "*) # ahead of upstream
  203. p=" u+${count#0 }" ;;
  204. *" 0") # behind upstream
  205. p=" u-${count% 0}" ;;
  206. *) # diverged from upstream
  207. p=" u+${count#* }-${count% *}" ;;
  208. esac
  209. if [[ -n "$count" && -n "$name" ]]; then
  210. __git_ps1_upstream_name=$(git rev-parse \
  211. --abbrev-ref "$upstream" 2>/dev/null)
  212. if [ $pcmode = yes ] && [ $ps1_expanded = yes ]; then
  213. p="$p \${__git_ps1_upstream_name}"
  214. else
  215. p="$p ${__git_ps1_upstream_name}"
  216. # not needed anymore; keep user's
  217. # environment clean
  218. unset __git_ps1_upstream_name
  219. fi
  220. fi
  221. fi
  222.  
  223. }
  224.  
  225. # Helper function that is meant to be called from __git_ps1. It
  226. # injects color codes into the appropriate gitstring variables used
  227. # to build a gitstring.
  228. __git_ps1_colorize_gitstring ()
  229. {
  230. if [[ -n ${ZSH_VERSION-} ]]; then
  231. local c_red='%F{red}'
  232. local c_green='%F{green}'
  233. local c_lblue='%F{blue}'
  234. local c_clear='%f'
  235. else
  236. # Using \[ and \] around colors is necessary to prevent
  237. # issues with command line editing/browsing/completion!
  238. local c_red='\[\e[31m\]'
  239. local c_green='\[\e[32m\]'
  240. local c_lblue='\[\e[1;34m\]'
  241. local c_clear='\[\e[0m\]'
  242. fi
  243. local bad_color=$c_red
  244. local ok_color=$c_green
  245. local flags_color="$c_lblue"
  246.  
  247. local branch_color=""
  248. if [ $detached = no ]; then
  249. branch_color="$ok_color"
  250. else
  251. branch_color="$bad_color"
  252. fi
  253. c="$branch_color$c"
  254.  
  255. z="$c_clear$z"
  256. if [ "$w" = "*" ]; then
  257. w="$bad_color$w"
  258. fi
  259. if [ -n "$i" ]; then
  260. i="$ok_color$i"
  261. fi
  262. if [ -n "$s" ]; then
  263. s="$flags_color$s"
  264. fi
  265. if [ -n "$u" ]; then
  266. u="$bad_color$u"
  267. fi
  268. r="$c_clear$r"
  269. }
  270.  
  271. __git_eread ()
  272. {
  273. f="$1"
  274. shift
  275. test -r "$f" && read "$@" <"$f"
  276. }
  277.  
  278. # __git_ps1 accepts 0 or 1 arguments (i.e., format string)
  279. # when called from PS1 using command substitution
  280. # in this mode it prints text to add to bash PS1 prompt (includes branch name)
  281. #
  282. # __git_ps1 requires 2 or 3 arguments when called from PROMPT_COMMAND (pc)
  283. # in that case it _sets_ PS1. The arguments are parts of a PS1 string.
  284. # when two arguments are given, the first is prepended and the second appended
  285. # to the state string when assigned to PS1.
  286. # The optional third parameter will be used as printf format string to further
  287. # customize the output of the git-status string.
  288. # In this mode you can request colored hints using GIT_PS1_SHOWCOLORHINTS=true
  289. __git_ps1 ()
  290. {
  291. local pcmode=no
  292. local detached=no
  293. local ps1pc_start='\u@\h:\w '
  294. local ps1pc_end='\$ '
  295. local printf_format=' (%s)'
  296.  
  297. case "$#" in
  298. 2|3) pcmode=yes
  299. ps1pc_start="$1"
  300. ps1pc_end="$2"
  301. printf_format="${3:-$printf_format}"
  302. ;;
  303. 0|1) printf_format="${1:-$printf_format}"
  304. ;;
  305. *) return
  306. ;;
  307. esac
  308.  
  309. # ps1_expanded: This variable is set to 'yes' if the shell
  310. # subjects the value of PS1 to parameter expansion:
  311. #
  312. # * bash does unless the promptvars option is disabled
  313. # * zsh does not unless the PROMPT_SUBST option is set
  314. # * POSIX shells always do
  315. #
  316. # If the shell would expand the contents of PS1 when drawing
  317. # the prompt, a raw ref name must not be included in PS1.
  318. # This protects the user from arbitrary code execution via
  319. # specially crafted ref names. For example, a ref named
  320. # 'refs/heads/$(IFS=_;cmd=sudo_rm_-rf_/;$cmd)' might cause the
  321. # shell to execute 'sudo rm -rf /' when the prompt is drawn.
  322. #
  323. # Instead, the ref name should be placed in a separate global
  324. # variable (in the __git_ps1_* namespace to avoid colliding
  325. # with the user's environment) and that variable should be
  326. # referenced from PS1. For example:
  327. #
  328. # __git_ps1_foo=$(do_something_to_get_ref_name)
  329. # PS1="...stuff...\${__git_ps1_foo}...stuff..."
  330. #
  331. # If the shell does not expand the contents of PS1, the raw
  332. # ref name must be included in PS1.
  333. #
  334. # The value of this variable is only relevant when in pcmode.
  335. #
  336. # Assume that the shell follows the POSIX specification and
  337. # expands PS1 unless determined otherwise. (This is more
  338. # likely to be correct if the user has a non-bash, non-zsh
  339. # shell and safer than the alternative if the assumption is
  340. # incorrect.)
  341. #
  342. local ps1_expanded=yes
  343. [ -z "$ZSH_VERSION" ] || [[ -o PROMPT_SUBST ]] || ps1_expanded=no
  344. [ -z "$BASH_VERSION" ] || shopt -q promptvars || ps1_expanded=no
  345.  
  346. local repo_info rev_parse_exit_code
  347. repo_info="$(git rev-parse --git-dir --is-inside-git-dir \
  348. --is-bare-repository --is-inside-work-tree \
  349. --short HEAD 2>/dev/null)"
  350. rev_parse_exit_code="$?"
  351.  
  352. if [ -z "$repo_info" ]; then
  353. if [ $pcmode = yes ]; then
  354. #In PC mode PS1 always needs to be set
  355. PS1="$ps1pc_start$ps1pc_end"
  356. fi
  357. return
  358. fi
  359.  
  360. local short_sha
  361. if [ "$rev_parse_exit_code" = "0" ]; then
  362. short_sha="${repo_info##*$'\n'}"
  363. repo_info="${repo_info%$'\n'*}"
  364. fi
  365. local inside_worktree="${repo_info##*$'\n'}"
  366. repo_info="${repo_info%$'\n'*}"
  367. local bare_repo="${repo_info##*$'\n'}"
  368. repo_info="${repo_info%$'\n'*}"
  369. local inside_gitdir="${repo_info##*$'\n'}"
  370. local g="${repo_info%$'\n'*}"
  371.  
  372. local r=""
  373. local b=""
  374. local step=""
  375. local total=""
  376. if [ -d "$g/rebase-merge" ]; then
  377. __git_eread "$g/rebase-merge/head-name" b
  378. __git_eread "$g/rebase-merge/msgnum" step
  379. __git_eread "$g/rebase-merge/end" total
  380. if [ -f "$g/rebase-merge/interactive" ]; then
  381. r="|REBASE-i"
  382. else
  383. r="|REBASE-m"
  384. fi
  385. else
  386. if [ -d "$g/rebase-apply" ]; then
  387. __git_eread "$g/rebase-apply/next" step
  388. __git_eread "$g/rebase-apply/last" total
  389. if [ -f "$g/rebase-apply/rebasing" ]; then
  390. __git_eread "$g/rebase-apply/head-name" b
  391. r="|REBASE"
  392. elif [ -f "$g/rebase-apply/applying" ]; then
  393. r="|AM"
  394. else
  395. r="|AM/REBASE"
  396. fi
  397. elif [ -f "$g/MERGE_HEAD" ]; then
  398. r="|MERGING"
  399. elif [ -f "$g/CHERRY_PICK_HEAD" ]; then
  400. r="|CHERRY-PICKING"
  401. elif [ -f "$g/REVERT_HEAD" ]; then
  402. r="|REVERTING"
  403. elif [ -f "$g/BISECT_LOG" ]; then
  404. r="|BISECTING"
  405. fi
  406.  
  407. if [ -n "$b" ]; then
  408. :
  409. elif [ -h "$g/HEAD" ]; then
  410. # symlink symbolic ref
  411. b="$(git symbolic-ref HEAD 2>/dev/null)"
  412. else
  413. local head=""
  414. if ! __git_eread "$g/HEAD" head; then
  415. if [ $pcmode = yes ]; then
  416. PS1="$ps1pc_start$ps1pc_end"
  417. fi
  418. return
  419. fi
  420. # is it a symbolic ref?
  421. b="${head#ref: }"
  422. if [ "$head" = "$b" ]; then
  423. detached=yes
  424. b="$(
  425. case "${GIT_PS1_DESCRIBE_STYLE-}" in
  426. (contains)
  427. git describe --contains HEAD ;;
  428. (branch)
  429. git describe --contains --all HEAD ;;
  430. (describe)
  431. git describe HEAD ;;
  432. (* | default)
  433. git describe --tags --exact-match HEAD ;;
  434. esac 2>/dev/null)" ||
  435.  
  436. b="$short_sha..."
  437. b="($b)"
  438. fi
  439. fi
  440. fi
  441.  
  442. if [ -n "$step" ] && [ -n "$total" ]; then
  443. r="$r $step/$total"
  444. fi
  445.  
  446. local w=""
  447. local i=""
  448. local s=""
  449. local u=""
  450. local c=""
  451. local p=""
  452.  
  453. if [ "true" = "$inside_gitdir" ]; then
  454. if [ "true" = "$bare_repo" ]; then
  455. c="BARE:"
  456. else
  457. b="GIT_DIR!"
  458. fi
  459. elif [ "true" = "$inside_worktree" ]; then
  460. if [ -n "${GIT_PS1_SHOWDIRTYSTATE-}" ] &&
  461. [ "$(git config --bool bash.showDirtyState)" != "false" ]
  462. then
  463. git diff --no-ext-diff --quiet --exit-code || w="*"
  464. if [ -n "$short_sha" ]; then
  465. git diff-index --cached --quiet HEAD -- || i="+"
  466. else
  467. i="#"
  468. fi
  469. fi
  470. if [ -n "${GIT_PS1_SHOWSTASHSTATE-}" ] &&
  471. [ -r "$g/refs/stash" ]; then
  472. s="$"
  473. fi
  474.  
  475. if [ -n "${GIT_PS1_SHOWUNTRACKEDFILES-}" ] &&
  476. [ "$(git config --bool bash.showUntrackedFiles)" != "false" ] &&
  477. git ls-files --others --exclude-standard --error-unmatch -- '*' >/dev/null 2>/dev/null
  478. then
  479. u="%${ZSH_VERSION+%}"
  480. fi
  481.  
  482. if [ -n "${GIT_PS1_SHOWUPSTREAM-}" ]; then
  483. __git_ps1_show_upstream
  484. fi
  485. fi
  486.  
  487. local z="${GIT_PS1_STATESEPARATOR-" "}"
  488.  
  489. # NO color option unless in PROMPT_COMMAND mode
  490. if [ $pcmode = yes ] && [ -n "${GIT_PS1_SHOWCOLORHINTS-}" ]; then
  491. __git_ps1_colorize_gitstring
  492. fi
  493.  
  494. b=${b##refs/heads/}
  495. if [ $pcmode = yes ] && [ $ps1_expanded = yes ]; then
  496. __git_ps1_branch_name=$b
  497. b="\${__git_ps1_branch_name}"
  498. fi
  499.  
  500. local f="$w$i$s$u"
  501. local gitstring="$c$b${f:+$z$f}$r$p"
  502.  
  503. if [ $pcmode = yes ]; then
  504. if [ "${__git_printf_supports_v-}" != yes ]; then
  505. gitstring=$(printf -- "$printf_format" "$gitstring")
  506. else
  507. printf -v gitstring -- "$printf_format" "$gitstring"
  508. fi
  509. PS1="$ps1pc_start$gitstring$ps1pc_end"
  510. else
  511. printf -- "$printf_format" "$gitstring"
  512. fi
  513. }
Add Comment
Please, Sign In to add comment
Public Pastes
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!