1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
<h1 align="center">📡 minimap.vim</h1>
<p align="center">
<em>Blazing fast minimap for vim, powered by <a href="https://github.com/wfxr/code-minimap">🛰 code-minimap</a> written in Rust.</em>
</p>
<p align="center">
<a href="https://github.com/wfxr/minimap.vim/actions?query=workflow%3Aci">
<img src="https://github.com/wfxr/minimap.vim/workflows/CI/badge.svg" alt="CI"/>
</a>
<a href="https://wfxr.mit-license.org/2020">
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"/>
</a>
<a href="https://github.com/vim/vim">
<img src="https://img.shields.io/badge/vim-8.2+-yellow.svg" alt="Vim"/>
</a>
<a href="https://github.com/neovim/neovim">
<img src="https://img.shields.io/badge/nvim-0.5.0+-yellow.svg" alt="Neovim"/>
</a>
<a href="https://github.com/pre-commit/pre-commit">
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white" alt="pre-commit" />
</a>
<a href="https://github.com/wfxr/minimap.vim/graphs/contributors">
<img src="https://img.shields.io/github/contributors/wfxr/minimap.vim" alt="Contributors"/>
</a>
</p>
### ✨ Features
* **Blazing-fast** (see [benchmark](https://github.com/wfxr/code-minimap#benchmark)).
* Dynamic **scaling**.
* Real-time **highlight**.
* It can be used to **scroll** buffer (in vim's way!).
### 📥 Installation
**Requirement**
- [🛰`code-minimap`](https://github.com/wfxr/code-minimap) is required. The plugin receives rendered minimap from it.
- vim8.2+, or neovim 0.5.0+.
Use your favorite plugin manager, [vim-plug](https://github.com/junegunn/vim-plug) for example:
```vim
Plug 'wfxr/minimap.vim'
```
*If you need to install the plugin manually, you can refer to this issue: [#2](https://github.com/wfxr/minimap.vim/issues/2).*
You can use [cargo](https://github.com/rust-lang/cargo) to install 'code-minimap' simultaneously (Only recommended for rust users):
```vim
Plug 'wfxr/minimap.vim', {'do': ':!cargo install --locked code-minimap'}
```
### 📑 Example configuration
```vim
let g:minimap_width = 10
let g:minimap_auto_start = 1
let g:minimap_auto_start_win_enter = 1
```
### 🛠Commands
| Flag | Description |
|------------------------|----------------------------------------------|
| Minimap | Show minimap window |
| MinimapClose | Close minimap window |
| MinimapToggle | Toggle minimap window |
| MinimapRefresh | Force refresh minimap window |
| MinimapUpdateHighlight | Force update minimap highlight |
| MinimapRescan | Force recalculation of minimap scaling ratio |
### âš™ Options
| Flag | Default | Description |
|------------------------------------------- |-----------------------------------------------------------|----------------------------------------------------------------------|
| `g:minimap_auto_start` | `0` | if, set minimap will show at startup |
| `g:minimap_auto_start_win_enter` | `0` | if, set with `g:minimap_auto_start` minimap shows on `WinEnter` |
| `g:minimap_width` | `10` | the width of the minimap window in characters |
| `g:minimap_window_width_override_for_scaling` | `2147483647` | the width cap for scaling the minimap (see minimap.txt help file) |
| `g:minimap_base_highlight` | `Normal` | the base color group for minimap |
| `g:minimap_block_filetypes` | `['fugitive', 'nerdtree', 'tagbar', 'fzf' ]` | disable minimap for specific file types |
| `g:minimap_block_buftypes` | `['nofile', 'nowrite', 'quickfix', 'terminal', 'prompt']` | disable minimap for specific buffer types |
| `g:minimap_close_filetypes` | `['startify', 'netrw', 'vim-plug']` | close minimap for specific file types |
| `g:minimap_close_buftypes` | `[]` | close minimap for specific buffer types |
| `g:minimap_exec_warning` | `1` | if set, enables code-minimap not found warning message at startup |
| `g:minimap_left` | `0` | if set, minimap window will append left |
| `g:minimap_highlight_range` | `1` | if set, minimap will highlight range of visible lines |
| `g:minimap_highlight_search` | `0` | if set, minimap will highlight searched patterns |
| `g:minimap_background_processing` | `0` | if set, minimap will use a background job to get the longest line (requires `gnu-wc` on MacOS) |
| `g:minimap_git_colors` | `0` | if set, minimap will highlight range of changes as reported by git |
| `g:minimap_enable_highlight_colorgroup` | `1` | if set, minimap will create an autocommand to set highlights on color scheme changes. |
### âš™ Color Options
Minimap.vim sets its own color groups to give a reasonable default.
| Flag | Default | Description |
|-------------------------------------|-----------------------------------------------------------|----------------------------------------------------------------------|
| `g:minimap_search_color_priority` | `120` | the priority for the search highlight colors |
| `g:minimap_cursor_color_priority` | `110` | the priority for the cursor highlight colors |
| `g:minimap_cursor_color` | `minimapCursor` | the color group for current position |
| `g:minimap_range_color` | `minimapRange` | the color group for window range (if highlight_range is enabled) |
| `g:minimap_search_color` | `Search` | the color group for highlighted search patterns in the minimap |
| `g:minimap_diffadd_color` | `minimapDiffAdded` | the color group for added lines (if git_colors is enabled) |
| `g:minimap_diffremove_color` | `minimapDiffRemoved` | the color group for removed lines (if git_colors is enabled) |
| `g:minimap_diff_color` | `minimapDiffLine` | the color group for modified lines (if git_colors is enabled) |
| `g:minimap_cursor_diffadd_color` | `minimapCursorDiffAdded` | the color group for the cursor over added lines |
| `g:minimap_cursor_diffremove_color` | `minimapCursorDiffRemoved` | the color group for the cursor over removed lines |
| `g:minimap_cursor_diff_color` | `minimapCursorDiffLine` | the color group for the cursor over modified lines |
| `g:minimap_range_diffadd_color` | `minimapRangeDiffAdded` | the color group for the window range encompassing added lines |
| `g:minimap_range_diffremove_color` | `minimapRangeDiffRemoved` | the color group for the window range encompassing removed lines |
| `g:minimap_range_diff_color` | `minimapRangeDiffLine` | the color group for the window range encompassing modified lines |
You can create your own colorgroup by specifying the foreground and background colors for the cterm or gui:
```
:highlight minimapCursor ctermbg=59 ctermfg=228 guibg=#5F5F5F guifg=#FFFF87
```
For more information, see `:help highlight`
Note: some colorschemes will clear all previous colors, so you may have to add an `autocmd` to ensure your custom colorgroups are added back:
```
autocmd ColorScheme *
\ highlight minimapCursor ctermbg=59 ctermfg=228 guibg=#5F5F5F guifg=#FFFF87 |
\ highlight minimapRange ctermbg=242 ctermfg=228 guibg=#4F4F4F guifg=#FFFF87
```
If you prefer to disable this behavior, set `g:minimap_enable_highlight_colorgroup` to 0 / false. This is useful if you have a color scheme that sets the minimap highlight groups explicitly.
### 💬 F.A.Q
---
#### Highlight and scroll are not working properly.
Check the vim version you are using. `minimap.vim` requires [vim 8.2+](https://github.com/wfxr/minimap.vim/issues/5) or [neovim 0.5.0+](https://github.com/wfxr/minimap.vim/issues/4).
---
#### Integrated with diagnostics or git status plugins?
Not implemented currently but it should be possible.
Welcome to contribute!
**update**: Git support has been implemented [#72](https://github.com/wfxr/minimap.vim/pull/72).
---
#### Minimap window is too wide for me, how to use it as a simple scrollbar?
You can reduce the width of the minimap window:
```vim
let g:minimap_width = 2
```
Or use [scrollbar.nvim](https://github.com/Xuyuanp/scrollbar.nvim) instead if what you want
is a pure scrollbar indicator.
---
#### How do the color priorities work?
A higher priority color group will override a lower priority color group.
By default, search > cursor/window position > git colors
---
#### I don't like the default highlight group, how to change it?
Choose any one of the highlight groups (or define a new one) and just set it for minimap like this:
```vim
hi MinimapCurrentLine ctermfg=Green guifg=#50FA7B guibg=#32302f
let g:minimap_cursor_color = 'MinimapCurrentLine'
```
*All existed Highlight groups can be displayed by `:hi`.*
---
#### Minimap shows up as a jumble of characters?
Check that your encoding is set to `utf-8` and not `latin1` (for Vim users).
Also, ensure that you're using a Unicode-compatible font that has Braille characters in it.
---
#### What is `g:minimap_highlight_range` and how do you use it?
You can have the minimap highlight all the visible lines in your current window
by setting `g:minimap_highlight_range`. If you use Neovim, and your version
is recent enough (after November 7, 2020), you can set this option to update
the highlight when the window is scrolled.
---
#### I'm using `g:minimap_highlight_search` and the highlighted searches don't go away until I `:nohlsearch` and save!
It is recommended that you create a mapping to run `:nohlsearch` and clear the
minimap all in one action. For example:
```
nnoremap <silent> `` :nohlsearch<CR>:call minimap#vim#ClearColorSearch()<CR>
```
---
#### I'm using `g:minimap_background_processing` on MacOS and the minimap isn't working!
The version of `wc` that ships with MacOS does not have support for the `-L` flag.
To use background processing on MacOS, install `gnu-wc`. Example via homebrew:
```
brew install coreutils
```
---
### 📋 Running Unit Tests
- Install [Testify](https://github.com/dhruvasagar/vim-testify).
- From the top level directory (minimap.vim/) `vim +TestifySuite` for a yay/nay
from your shell.
- For a more detailed run, open vim at the top level and run `:TestifySuite`.
`README.md` works, but an empty buffer at the top level works too.
- To hone in on one test file, open that file (located in the `t/` directory)
and run `:TestifyFile`.
- (As a note, the `t/` directory is named such as a requirement from [Testify](https://github.com/dhruvasagar/vim-testify).
`:TestifySuite` runs all the tests in the `t/` directory)
---
### 📦 Related Projects
* [code-minimap](https://github.com/wfxr/code-minimap): A high performance code minimap render.
* [scrollbar.nvim](https://github.com/Xuyuanp/scrollbar.nvim): A pure scrollbar indicator for neovim (nightly).
* [vim-minimap](https://github.com/severin-lemaignan/vim-minimap): A minimap plugin written in python.
### 🌼 Maintainers
| [](https://github.com/ZNielsen) | [](https://github.com/wfxr) | [](https://github.com/rabirabirara) |
| :---: | :---: | :---: |
| [ZNielsen](https://github.com/ZNielsen) | [wfxr](https://github.com/wfxr) | [rabirabirara](https://github.com/rabirabirara) |
### 📃 License
[MIT](https://wfxr.mit-license.org/2020) (c) Wenxuan Zhang
|
