Blame view

plugins/mercurial/README.md 2.23 KB
238d8e65a   mj   Squashed 'repos/r...
1
2
3
  # Mercurial plugin
  ### Usage
  Update .zshrc:
f4c442e7d   mj   Squashed 'repos/r...
4
  1. Add name to the list of plugins, e.g. `plugins=(... mercurial ...)`
238d8e65a   mj   Squashed 'repos/r...
5
     (that is pretty obvious).
f4c442e7d   mj   Squashed 'repos/r...
6
  2. Switch to a theme which uses `hg_prompt_info`.
238d8e65a   mj   Squashed 'repos/r...
7

f4c442e7d   mj   Squashed 'repos/r...
8
     Or, customize the `$PROMPT` variable of your current theme to contain current folder mercurial repo info. This can be done by putting a custom version of the theme in `$ZSH_CUSTOM` or by changing `$PROMPT` in `.zshrc` after loading the theme.
238d8e65a   mj   Squashed 'repos/r...
9

f4c442e7d   mj   Squashed 'repos/r...
10
11
12
13
     The `robbyrussell` theme is used by default, so you need to modify `$PROMPT` var by adding `$(hg_prompt_info)` after `$(git_prompt_info)`, so it looks like this:
  
     ```zsh
     PROMPT='${ret_status}%{$fg_bold[green]%}%p %{$fg[cyan]%}%c %{$fg_bold[blue]%}$(git_prompt_info)$(hg_prompt_info)%{$fg_bold[blue]%} % %{$reset_color%}'
238d8e65a   mj   Squashed 'repos/r...
14
     ```
f4c442e7d   mj   Squashed 'repos/r...
15

238d8e65a   mj   Squashed 'repos/r...
16
  3. Initialize additional vars used in plugin. So in short put next in **.zshrc**:
f4c442e7d   mj   Squashed 'repos/r...
17

238d8e65a   mj   Squashed 'repos/r...
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
     ```
     ZSH_THEME_HG_PROMPT_PREFIX="%{$fg_bold[magenta]%}hg:(%{$fg[red]%}"
     ZSH_THEME_HG_PROMPT_SUFFIX="%{$reset_color%}"
     ZSH_THEME_HG_PROMPT_DIRTY="%{$fg[magenta]%}) %{$fg[yellow]%}✗%{$reset_color%}"
     ZSH_THEME_HG_PROMPT_CLEAN="%{$fg[magenta]%})"
     ```
  
  ### What's inside?
  #### Adds handy aliases:
  ###### general
  * `hgc` - `hg commit`
  * `hgb` - `hg branch`
  * `hgba` - `hg branches`
  * `hgbk` - `hg bookmarks`
  * `hgco` - `hg checkout`
  * `hgd`  - `hg diff`
  * `hged` - `hg diffmerge`
  
  ###### pull and update
  * `hgi` - `hg incoming`
  * `hgl` - `hg pull -u`
  * `hglr` - `hg pull --rebase`
  * `hgo` - `hg outgoing`
  * `hgp` - `hg push`
  * `hgs` - `hg status`
  * `hgsl` - `hg log --limit 20 --template "{node|short} | {date|isodatesec} | {author|user}: {desc|strip|firstline}
  "`
  
  ###### this is the 'git commit --amend' equivalent
  * `hgca` - `hg qimport -r tip ; hg qrefresh -e ; hg qfinish tip`
  
  ###### list unresolved files (since hg does not list unmerged files in the status command)
  * `hgun` - `hg resolve --list`
  
  #### Displays repo branch and directory status in prompt
  This is the same as git plugin does.
f4c442e7d   mj   Squashed 'repos/r...
54
  **Note**: Additional changes to **.zshrc**, or using a theme designed to use `hg_prompt_info`, are required in order for this to work.
238d8e65a   mj   Squashed 'repos/r...
55
56
57
58
59
  
  ### Mantainers
  [ptrv](https://github.com/ptrv) - original creator
  
  [oshybystyi](https://github.com/oshybystyi) - created this README and know how most of code works