A modular (Neo)Vim configuration!
Nearly every (Neo)Vim configuration you find online is composed of a single,
giant vimrc file. But this one is different: it's modular, relying on
(Neo)Vim's behavior of loading all plugin/**/*.vim files on startup to
cleanly partition your settings, mappings, packages, and other configuration
into separate files that each focus on a single topic and do one thing well.
-
Modularity of packages, filetypes, colorschemes, and Vim settings.
-
Lazy loading of filetype-specific packages to start Vim up quickly.
-
Parallel installation and updating of packages from Git repositories.
-
Easy upgrades with intelligent and automated Git conflict resolution.
-
Shell scripts for package management: insert, delete, rename, and more.
- Branches
- Scripts
- Packages
- Configs
- Dependencies
- Installation
- Usage
- Shortcuts
- Manuals
- References
- License
-
The origin branch is a "bare bones" template for anyone to start with.
-
The basics branch is a rudimentary configuration of the Standard Vim.
-
The qwerty branch is an enhanced configuration meant for QWERTY typists.
-
The dvorak branch is an optimized configuration meant for Dvorak typists --- those who type in Dvorak.
-
The engram branch is an optimized configuration meant for Engram typists --- those who type in Arno's Engram keyboard layout.
-
The master branch is the frontier, where I experiment with new plugins.
bin/*scripts automate common tasks. See below for their usage manuals.
-
**/*.getfiles specify URLs of Git repositories to clone for your packages. -
**/*.setfiles specify branch names or commit SHAs to check out from Git. -
**/*.runfiles specify shell commands to run after updating your packages. -
pack/*/start/*/directories are packages that Vim eagerly loads on start. -
pack/*/opt/*=*/directories are lazily loaded, filetype-specific packages.
-
plugin/**/*.vimconfigure Vim before it finishes starting up. -
pack/*/*/*.vimconfigure your packages before they are loaded. -
ftplugin/{*,/*}.vimconfigure your filetypes when they are loaded. -
after/colors/*.vimconfigure your colorschemes after they are applied. -
after/plugin/**/*.vimconfigure Vim after all of the above is finished.
-
Git 1.5+
-
POSIX environment (Linux, BSD, MacOSX, etc.)
Special note to Microsoft Windows users: simply
- replace
~/.vimwith%USERPROFILE%\vimfiles - replace
~/.vimrcwith%USERPROFILE%\_vimrc
in all commands listed throughout this document.
- replace
-
xargs with support for the
-rcommand-line option:Do not run the command if there are no arguments. Normally the command is executed at least once even if there are no arguments.
Backup your configuration:
mv ~/.vim ~/.vim.bak
mv ~/.config/nvim ~/.config/nvim.bak # for NeoVim
Install this configuration:
git clone https://github.com/sunaku/.vim.git ~/.vim
ln -s ~/.vim ~/.config/nvim # for NeoVim
cd ~/.vim
bin/setup
Select a Git branch to use:
bin/setup origin # template
bin/setup basics # template + basics
bin/setup qwerty # template + basics + my flair
bin/setup dvorak # template + basics + my flair + dvorak
bin/setup engram # template + basics + my flair + engram
bin/setup master # template + basics + my flair + engram + new stuff
See usage information:
bin/usage
See usage information for provided SCRIPT:
bin/usage SCRIPT
Add package from URL or Github USER/REPO under CATEGORY:
bin/insert URL CATEGORY
bin/insert USER/REPO CATEGORY
Add package from URL or Github USER/REPO under CATEGORY with PACKAGE_NAME:
bin/insert URL CATEGORY/PACKAGE_NAME
bin/insert USER/REPO CATEGORY/PACKAGE_NAME
Add ftpackage from URL or Github USER/REPO for FILETYPE:
bin/insert URL FILETYPE=
bin/insert USER/REPO FILETYPE=
Add ftpackage from URL or Github USER/REPO for FILETYPE with PACKAGE_NAME:
bin/insert URL FILETYPE=PACKAGE_NAME
bin/insert USER/REPO FILETYPE=PACKAGE_NAME
Rename packages with names matching PACKAGE_NAME regular expression:
bin/rename PACKAGE_NAME
Rename any/all packages flexibly from the comfort of Vim:
bin/rename-editor PACKAGE_NAME
Rename a *.get file from its current name to a new one:
bin/rename-fromto CURRENT_GET_FILE NEW_GET_FILE
Delete packages with names matching PACKAGE_NAME regular expression:
bin/delete PACKAGE_NAME
Lists untracked *.get files and packages lacking *.get files:
bin/orphans
Deletes untracked *.get files and packages lacking *.get files:
bin/clean # asks you for confirmation
bin/clean -f # no confirmation; force it
Update installed packages:
bin/update
Update this Vim configuration framework:
bin/rebase # asks to confirm bin/clean
bin/rebase -f # no confirmation; force it
Do all that periodically via crontab(1):
@daily cd ~/.vim && bin/rebase -f && bin/update
Track a certain Git BRANCH by creating a *.set file for your PACKAGE:
echo BRANCH > PACKAGE.set
Remove BRANCH tracking for your PACKAGE by deleting its *.set file:
rm PACKAGE.set
Lock a PACKAGE to a certain Git COMMITISH to prevent it from being updated:
cd PACKAGE
git checkout COMMITISH
Unlock a locked PACKAGE, so it can be updated, by checking out its master:
cd PACKAGE
git checkout master
This branch of the Vim configuration defines the following shortcuts, which assume that you type in Arno's Engram keyboard layout. If this assumption doesn't apply to you, then try the qwerty branch instead.
-
-is the<Leader>, used in some shortcuts in this configuration. -
<Space>(space bar) precedes most shortcuts in this configuration. Press it and wait a moment to view a searchable menu of all shortcuts. To use it in a:normalcommand, type<C-V>twice and then<Space>::normal ^V ic
-
<Space><Space>immediately opens a searchable menu of all shortcuts.
Inspired by the "verb then subject" design of Vim's own normal mode shortcuts,
I have attempted to mirror its mnemonic devices in my own <Space> shortcuts:
| Shortcuts | Key | Mnemonic | Same as Vim? |
|---|---|---|---|
<Space>a |
a | append | Yes |
<Space>o |
o | open | Yes |
<Space>e |
e | expose | No |
<Space>u |
u | undo | Yes |
<Space>i |
i | insert | Yes |
<Space>d |
d | delete | Yes |
<Space>h |
h | diff (hunk) | No |
<Space>t |
t | toggle | No |
<Space>n |
n | next | Yes |
<Space>w |
w | write | No |
<Space>v |
v | visual | Yes |
<Space>z |
z | fold | Yes |
<Space>, |
, | execute | No |
<Space>. |
. | repeat | Yes |
<Space>p |
p | paste | Yes |
<Space>y |
y | yank | Yes |
<Space>f |
f | format | No |
<Space>c |
c | change | Yes |
<Space>r |
r | read | No |
This table is always available (and searchable) in Vim: press space bar twice!
| Shortcut | Description |
|---|---|
, |
(sneak) repeat last sneak backward |
0gt |
expose last tab |
1gt |
expose first tab |
2gt |
expose tab 2 |
3gt |
expose tab 3 |
4gt |
expose tab 4 |
5gt |
expose tab 5 |
6gt |
expose tab 6 |
7gt |
expose tab 7 |
8gt |
expose tab 8 |
9gt |
expose tab 9 |
; |
(sneak) repeat last sneak forward |
<C-J> |
(Coc) Jump to next placeholder in snippet expansion. |
<C-K> |
(Coc) Jump to previous placeholder in snippet expansion. |
<C-Q> |
exit/quit vim |
<C-S> |
strip trailing whitespace in buffer and write buffer to file |
<Leader><C-Q> |
exit/quit vim forcefully |
<Leader><Leader>k |
(dasht) search ALL the docsets at command prompt |
<Leader><Leader>K |
(dasht) search ALL the docsets for cursor word or selected text |
<Leader><S-Down> |
minimum window height |
<Leader><S-Left> |
minimum window width |
<Leader><S-Right> |
maximum window width |
<Leader><S-Up> |
maximum window height |
<Leader>[[ |
(blockinsert) blockwise surround at start and end of line |
<Leader>[] |
(blockinsert) blockwise insert at start then end of line |
<Leader>]] |
(blockinsert) blockwise surround at start and end of line |
<Leader>a |
(blockinsert) blockwise append at end of line |
<Leader>b |
(CamelCaseMotion) go to start of current word in camel/snake case |
<Leader>e |
(CamelCaseMotion) go to end of current word in camel/snake case |
<Leader>gd |
(Coc) Open the definition of the symbol under the cursor. |
<Leader>ge |
(CamelCaseMotion) go to end of previous word in camel/snake case |
<Leader>gi |
(Coc) Open the implementation of the symbol under the cursor. |
<Leader>gR |
(Coc) Open the references of the symbol under the cursor. |
<Leader>gy |
(Coc) Open the type definition of the symbol under the cursor. |
<Leader>i |
(blockinsert) blockwise insert at start of line |
<Leader>k |
(dasht) search related docsets at command prompt |
<Leader>K |
(dasht) search related docsets for cursor word or selected text |
<Leader>o |
switch to most recently focused tab |
<Leader>p |
paste after cursor, adding a space |
<Leader>P |
paste before cursor, adding a space |
<Leader>q[[ |
(blockinsert) blockwise execute at start and end of line |
<Leader>q[] |
(blockinsert) blockwise execute at start then end of line |
<Leader>q]] |
(blockinsert) blockwise execute at start and end of line |
<Leader>qa |
(blockinsert) blockwise execute at end of line |
<Leader>qi |
(blockinsert) blockwise execute at start of line |
<Leader>tb |
(test) run all tests in buffer |
<Leader>tn |
(test) run test under cursor |
<Leader>ts |
(test) run all tests in suite |
<Leader>tt |
(test) repeat recent test run |
<Leader>tv |
(test) expose recently ran test |
<Leader>w |
(CamelCaseMotion) go to start of next word in camel/snake case |
<p |
(unimpaired) Paste after cursor, linewise, decreasing indent. |
<P |
(unimpaired) Paste before cursor, linewise, decreasing indent. |
<S-Down> |
decrease window height |
<S-Left> |
decrease window width |
<S-Right> |
increase window width |
<S-Up> |
increase window height |
<Space>!T |
(table-mode) evaluate "tmf:" formula line |
<Space>$t |
move tab to last place |
<Space>*G |
(fugitive) git grep: search repository for word under cursor |
<Space>+w |
increase window size |
<Space>-w |
decrease window size |
<Space>// |
(fuzzysearch) fuzzy-regex search in buffer |
<Space>/G |
(fugitive) git grep: search repository |
<Space>0T |
(table-mode) sort current column at cursor |
<Space>0w |
minimum window size |
<Space>1T |
(table-mode) add fomula for current table cell |
<Space>1w |
maximum window size |
<Space><Space> |
show shortcut menu and run chosen shortcut |
<Space><t |
move tab left |
<Space>=c |
(NERDCommenter) comment, aligning both delimiters |
<Space>=T |
(table-mode) realign table columns |
<Space>=w |
(visual-split) resize window to selection |
<Space>>t |
move tab right |
<Space>?G |
(fugitive) git grep: search repository for Vim search pattern |
<Space>^t |
move tab to first place |
<Space>ac |
(NERDCommenter) append comment at end of line |
<Space>Ac |
(NERDCommenter) comment from cursor to end of line |
<Space>aC |
(NERDCommenter) comment, nesting |
<Space>ag |
(fugitive) git commit --amend |
<Space>Ag |
(fugitive) git commit --amend --reuse-message=HEAD |
<Space>at |
append new tab |
<Space>At |
append new tab in last place |
<Space>aw |
split window right |
<Space>c* |
(traces) interactive search and replace for word at cursor |
<Space>c/ |
(traces) interactive search and replace in selection or buffer |
<Space>c? |
(abolish) interactive search and replace in selection or buffer |
<Space>cf |
(eunuch) rename file |
<Space>Cg |
(fugitive) git mv -f: rename file forcefully |
<Space>cg |
(fugitive) git mv: rename file |
<Space>cq |
(qfreplace) interactively change lines in quickfix window |
<Space>d$ |
(better-whitespace) strip trailing whitespace in buffer |
<Space>db |
(sayonara) close buffer while retaining window |
<Space>DB |
(wipeout) destroy all buffers not open in any tabs or windows |
<Space>Db |
close all buffers |
<Space>dc |
(NERDCommenter) uncomment, deleting comment delimiters |
<Space>dE |
(errormarker) remove all error markers from signcolumn |
<Space>df |
(eunuch) prompt to delete file |
<Space>Dg |
(fugitive) git rm -f: delete file from repository forcefully |
<Space>dg |
(fugitive) git rm: delete file from repository |
<Space>DT |
(table-mode) delete current column or [count] right columns |
<Space>dT |
(table-mode) delete current row or [count] rows |
<Space>Dt |
close other tabs |
<Space>dt |
close tab |
<Space>Dw |
close other windows |
<Space>dw |
close window |
<Space>Dz |
close all other folds in buffer |
<Space>e/ |
(fzf) repeat search from history |
<Space>e: |
(fzf) run command from menu |
<Space>e; |
(fzf) repeat command from history |
<Space>e<Space> |
(fzf) trigger mapping / keybinding / shortcut |
<Space>ea |
(projectionist) expose alternate file |
<Space>eA |
(projectionist) expose available projections |
<Space>eB |
(fzf) apply filetype |
<Space>ec |
(fzf) apply colorscheme |
<Space>eD |
(NERDTree) find current buffer in tree |
<Space>ed |
(NERDTree) open tree and focus it |
<Space>eE |
(errormarker) expose error message for cursor position |
<Space>eF |
edit file as... |
<Space>eG |
(fugitive) return to editing git buffer |
<Space>el |
(fzf) expose line in any buffer |
<Space>eL |
(fzf) expose line in buffer |
<Space>em |
(fzf) expose mark in buffer |
<Space>et |
(fzf) expose tag in any buffer |
<Space>eT |
(fzf) expose tag in buffer |
<Space>ew |
(fzf) expose window in any tab |
<Space>ex |
(scratch) expose scratch buffer |
<Space>f" |
convert single to double quotes at cursor |
<Space>f' |
convert double to single quotes at cursor |
<Space>f( |
format function call, removing parentheses |
<Space>f) |
format function call, adding parentheses |
<Space>f- |
format as separator, appending minus signs to end of line |
<Space>f1 |
format as markdown title heading <h1> |
<Space>f2 |
format as markdown section heading <h2> |
<Space>f: |
format ruby quotes to symbol at cursor |
<Space>f; |
format ruby symbol to quotes at cursor |
<Space>f<Space> |
indent with spaces in buffer |
<Space>f<Tab> |
indent with tabs in buffer |
<Space>f= |
format as separator, appending equal signs to end of line |
<Space>f_ |
format as separator, repeating last character to end of line |
<Space>fa |
(argwrap) toggle multi-line syntax at cursor |
<Space>fA |
(FIGlet) decorate {motion} or visual selection as ASCII art |
<Space>fC |
(FIGlet) comment {motion} or visual selection as ASCII art |
<Space>fc |
format as markdown fenced code block |
<Space>fh |
format line as comment section, surrounding with blank comment lines |
<Space>fH |
format line as comment section, surrounding with minus sign separators |
<Space>fJ |
format elixir pipeline at cursor: join into a single line |
<Space>fK |
format elixir pipeline at cursor: split into multiple lines |
<Space>fP |
format elixir function call to pipeline at cursor |
<Space>fp |
format elixir pipeline to function call at cursor |
<Space>fs |
(switch) cycle through alternate syntax at cursor |
<Space>fT |
(table-mode) tabelize selection, using | as delimiter |
<Space>FT |
(table-mode) tableize selection, asking for delimiter |
<Space>ft |
format as markdown table heading <th> |
<Space>GG |
(fugitive) git blame: who changed which line |
<Space>gg |
(fugitive) open git status window |
<Space>gh |
(GitGutter) preview git hunk at cursor |
<Space>gT |
(table-mode) inspect table, for defining formulas |
<Space>h, |
diff obtain hunk from left window |
<Space>h. |
diff obtain hunk from right window |
<Space>h< |
diff put hunk into left window |
<Space>h> |
diff put hunk into right window |
<Space>ha |
(conflict-marker) resolve merge conflict by keeping both versions |
<Space>hb |
diff buffer against original version |
<Space>hg |
(fugitive) git diff: show changes against repository |
<Space>hn |
(conflict-marker) resolve merge conflict by deleting both versions |
<Space>ho |
(conflict-marker) resolve merge conflict by keeping our version |
<Space>ht |
(conflict-marker) resolve merge conflict by keeping their version |
<Space>Ic |
(NERDCommenter) comment, aligning left delimiter |
<Space>ic |
(NERDCommenter) comment, inserting comment delimiters |
<Space>iC |
(NERDCommenter) comment, minimally |
<Space>IC |
(NERDCommenter) comment, sexily |
<Space>iD |
(projectionist) change buffer's working directory to innermost root |
<Space>id |
(projectionist) change working directory to innermost root |
<Space>if |
(projectionist) create file relative to innermost root |
<Space>ig |
(fugitive) git commit: record new commit |
<Space>it |
insert new tab |
<Space>It |
insert new tab in first place |
<Space>iw |
split window left |
<Space>Ix |
(scratch) clear scratch buffer and enter insert mode in it |
<Space>ix |
(scratch) enter insert mode in scratch buffer |
<Space>nt |
expose next tab |
<Space>Nt |
expose previous tab |
<Space>o. |
(fzf) reopen file from history |
<Space>ob |
(fzf) open buffer |
<Space>Od |
(unite) open filer in buffer's directory |
<Space>od |
(unite) open filer in working directory |
<Space>Of |
(fzf) open file under buffer's directory |
<Space>of |
(fzf) open file under working directory |
<Space>og |
(fzf) open git file (tracked by git) |
<Space>oG |
(fzf) open git file that has changes |
<Space>Og |
(fzf) open git file under buffer's directory |
<Space>oh |
(fzf) open help topic |
<Space>oH |
(helpful) search for helptags and display Vim version information |
<Space>Ow |
(visual-split) split window above |
<Space>ow |
(visual-split) split window below |
<Space>ox |
(slimux) select target pane interactively |
<Space>Pc |
(NERDCommenter) duplicate above cursor and comment |
<Space>pc |
(NERDCommenter) duplicate below cursor and comment |
<Space>pp |
paste after cursor, adding an extra newline |
<Space>pP |
paste after cursor, surrounding with newlines |
<Space>PP |
paste before cursor, adding an extra newline |
<Space>Pp |
paste before cursor, surrounding with newlines |
<Space>pw |
(windowswap) paste window |
<space>q. |
(coc-fzf) Continue listing |
<space>q<space> |
(coc-fzf) expose Coc functionality |
<Space>qa |
(Coc) Perform codeAction of selected region. |
<space>qa |
(coc-clap) Show actions |
<space>qc |
(coc-fzf) Show commands |
<space>qd |
(coc-fzf) Show all diagnostics |
<space>qD |
(coc-fzf) Show diagnostics for current buffer |
<space>qe |
(coc-fzf) Manage extensions |
<Space>qf |
(Coc) Perform autofix of issue at cursor line. |
<Space>qg |
(fzf) browse git log |
<Space>qG |
(fzf) browse git log for buffer |
<space>qi |
(coc-marketplace) Show available plugins for installation |
<space>qj |
(Coc) Do default action for next item. |
<space>qk |
(Coc) Do default action for previous item. |
<space>ql |
(coc-fzf) expose Coc location |
<Space>qn |
(Coc) Rename the symbol under the cursor. |
<space>qo |
(coc-fzf) Find symbol of current document |
<space>qp |
(Coc) Resume latest coc list |
<space>qq |
(coc-clap) expose Coc services |
<space>qs |
(coc-fzf) Search workspace symbols |
<Space>qt |
(taglist) show tag name at cursor |
<Space>qv |
(Coc) Format the selected region of code. |
<space>qy |
(coc-fzf) Show yank history |
<Space>rB |
(projectionist) replace buffer with "new file" template |
<Space>rb |
reload buffer from file |
<Space>Rb |
reload buffer from file forcefully |
<Space>rd |
(NERDTree) refresh tree from root node |
<Space>Rg |
(fugitive) git checkout -f: revert buffer to repository forcefully |
<Space>rg |
(fugitive) git checkout: revert buffer to repository |
<Space>rh |
(GitGutter) revert git hunk at cursor |
<Space>t# |
(colorizer) toggle hex color code highlighting |
<Space>t> |
(indentLine) toggle indentation lines |
<Space>tc |
(NERDCommenter) invert comment markers |
<Space>tC |
(NERDCommenter) toggle comment markers |
<Space>td |
(NERDTree) toggle tree visibility |
<Space>tg |
(Twiggy) toggle git control panel |
<Space>th |
(GitGutter) toggle git hunk highlighting |
<Space>tH |
(GitGutter) toggle git hunk signs |
<Space>tl |
(ListToggle) toggle location list |
<Space>tq |
(ListToggle) toggle quickfix list |
<Space>tT |
(table-mode) toggle table mode for current buffer |
<Space>tt |
(taglist) toggle tags sidebar |
<Space>tu |
(undotree) toggle undo history tree sidebar |
<Space>tv |
(goyo) toggle distraction-free writing mode |
<Space>tV |
(limelight) toggle enhancement for distraction-free writing mode |
<Space>tx |
(scratch) toggle scratch buffer preview |
<Space>Uw |
(undoclosewin) show history of recently closed windows |
<Space>uw |
(undoclosewin) undo/restore most recently closed window |
<Space>vb |
visually select entire buffer |
<Space>wb |
write buffer to file |
<Space>Wb |
write buffer to file forcefully |
<Space>Wg |
(fugitive) git add -f: stage all changes in buffer forcefully |
<Space>wg |
(fugitive) git add: stage all changes in buffer |
<Space>wh |
(GitGutter) stage git hunk at cursor |
<Space>Wx |
(slimux) send entire buffer to target pane |
<Space>wx |
(slimux) send line or selection to target pane |
<Space>xf |
(Xtract) extract selection into relative file |
<Space>xv |
(ExtractToVariable) extract selection into variable assignment |
<Space>yb |
yank buffer contents |
<Space>yc |
(NERDCommenter) yank then comment |
<Space>yF |
save copy of file as... |
<Space>yf |
save file as... |
<Space>yw |
(windowswap) yank window |
<Space>Yx |
(scratch) clear scratch buffer and yank selection to it |
<Space>yx |
(scratch) yank selection to scratch buffer |
<Space>zR |
(narrow) widen view / disable narrowing |
<Space>zv |
(narrow) narrow view to selection |
<Space>~c |
(NERDCommenter) toggle alternate comment delimiters |
=p |
(unimpaired) Paste after cursor, linewise, reindenting. |
=P |
(unimpaired) Paste before cursor, linewise, reindenting. |
>p |
(unimpaired) Paste after cursor, linewise, increasing indent. |
>P |
(unimpaired) Paste before cursor, linewise, increasing indent. |
[% |
(indentwise) go to starting line of same indent, ascending [count] indents |
[+ |
(indentwise) go to previous line of deeper indent |
[- |
(indentwise) go to previous line of lesser indent |
[<C-L> |
(unimpaired) go to previous file with locations |
[<C-Q> |
(unimpaired) go to previous file with quickfixes |
[<Space> |
(unimpaired) Add [count] blank lines above the cursor. |
[= |
(indentwise) go to previous line of same indent, crossing different indents |
[| |
(table-mode) move cursor to previous table cell |
[_ |
(indentwise) go to previous line of [count] indent |
[A |
(unimpaired) go to first argument |
[a |
(unimpaired) go to previous argument |
[B |
(unimpaired) go to first buffer |
[b |
(unimpaired) go to previous buffer |
[D |
(quickfix) list definitions of word at cursor from top of file |
[e |
(unimpaired) Exchange current line with [count] lines above it. |
[f |
(unimpaired) go to previous file in current file's directory |
[h |
(GitGutter) jump to previous git hunk |
[I |
(quickfix) list occurences of word at cursor from top of file |
[L |
(unimpaired) go to first location |
[l |
(unimpaired) go to previous location |
[n |
(unimpaired) go to previous conflict marker or diff/patch hunk |
[ob |
(unimpaired) enable assuming light background |
[oC |
(HiCterm) enable cterm color code highlighting |
[oc |
(unimpaired) enable highlighting cursor's line |
[od |
(unimpaired) enable diffing with current buffer |
[oh |
(unimpaired) enable highlighting search results |
[oi |
(unimpaired) enable ignoring case sensitivity |
[ol |
(unimpaired) enable listing nonprintable characters |
[on |
(unimpaired) enable absolute line numbering |
[op |
(unimpaired) Paste before cursor, linewise, using paste mode. |
[or |
(unimpaired) enable relative line numbering |
[os |
(unimpaired) enable checking for misspelled words |
[ou |
(unimpaired) enable highlighting cursor's column |
[ov |
(unimpaired) enable constraining cursor to line |
[ow |
(unimpaired) enable wrapping very long lines |
[ox |
(unimpaired) enable highlighting cursor's position |
[P |
(unimpaired) Paste after cursor, linewise. |
[p |
(unimpaired) Paste after cursor, linewise. |
[Q |
(unimpaired) go to first quickfix |
[q |
(unimpaired) go to previous quickfix |
[T |
(unimpaired) go to first ctag |
[t |
(unimpaired) go to previous ctag |
[u |
(unimpaired) URL escape. |
[uu |
(unimpaired) URL escape current line. |
[v |
move cursor up as far as possible inside vertical column |
[w |
(Coc) Go to previous diagnostic callout. |
[x |
(unimpaired) XML escape. |
[xx |
(unimpaired) XML escape current line. |
[y |
(unimpaired) String escape. |
[yy |
(unimpaired) String escape current line. |
|| |
(table-mode) expand borders of table header |
| |
(table-mode) trigger table creation in table mode |
]% |
(indentwise) go to ending line of same indent, descending [count] indents |
]+ |
(indentwise) go to next line of deeper indent |
]- |
(indentwise) go to next line of lesser indent |
]<C-L> |
(unimpaired) go to next file with locations |
]<C-Q> |
(unimpaired) go to next file with quickfixes |
]<Space> |
(unimpaired) Add [count] blank lines below the cursor. |
]= |
(indentwise) go to next line of same indent, crossing different indents |
]| |
(table-mode) move cursor to next table cell |
]_ |
(indentwise) go to next line of [count] indent |
]A |
(unimpaired) go to last argument |
]a |
(unimpaired) go to next argument |
]B |
(unimpaired) go to last buffer |
]b |
(unimpaired) go to next buffer |
]D |
(quickfix) list definitions of word at cursor from here onward |
]e |
(unimpaired) Exchange current line with [count] lines below it. |
]f |
(unimpaired) go to next file in current file's directory |
]h |
(GitGutter) jump to next git hunk |
]I |
(quickfix) list occurences of word at cursor from here onward |
]L |
(unimpaired) go to last location |
]l |
(unimpaired) go to next location |
]n |
(unimpaired) go to next conflict marker or diff/patch hunk |
]ob |
(unimpaired) disable assuming light background |
]oC |
(HiCterm) disable cterm color code highlighting |
]oc |
(unimpaired) disable highlighting cursor's line |
]od |
(unimpaired) disable diffing with current buffer |
]oh |
(unimpaired) disable highlighting search results |
]oi |
(unimpaired) disable ignoring case sensitivity |
]ol |
(unimpaired) disable listing nonprintable characters |
]on |
(unimpaired) disable absolute line numbering |
]op |
(unimpaired) Paste after cursor, linewise, using paste mode. |
]or |
(unimpaired) disable relative line numbering |
]os |
(unimpaired) disable checking for misspelled words |
]ou |
(unimpaired) disable highlighting cursor's column |
]ov |
(unimpaired) disable constraining cursor to line |
]ow |
(unimpaired) disable wrapping very long lines |
]ox |
(unimpaired) disable highlighting cursor's position |
]P |
(unimpaired) Paste before cursor, linewise. |
]p |
(unimpaired) Paste before cursor, linewise. |
]Q |
(unimpaired) go to last quickfix |
]q |
(unimpaired) go to next quickfix |
]T |
(unimpaired) go to last ctag |
]t |
(unimpaired) go to next ctag |
]u |
(unimpaired) URL unescape. |
]uu |
(unimpaired) URL unescape current line. |
]v |
move cursor down as far as possible inside vertical column |
]w |
(Coc) Go to next diagnostic callout. |
]x |
(unimpaired) XML unescape. |
]xx |
(unimpaired) XML unescape current line. |
]y |
(unimpaired) String unescape. |
]yy |
(unimpaired) String unescape current line. |
c<Space> |
change text starting at cursor |
cop |
toggle verbatim paste mode |
coQ |
toggle automatic formatting in buffer |
coz |
toggle code folding in buffer |
cr- |
(abolish) dash-case (not usually reversible) |
cr. |
(abolish) dot.case (not usually reversible) |
cr<space> |
(abolish) space case (not usually reversible) |
cr_ |
(abolish) snake_case |
crc |
(abolish) camelCase |
crk |
(abolish) kebab-case (not usually reversible) |
crm |
(abolish) MixedCase |
crs |
(abolish) snake_case |
crt |
(abolish) Title Case (not usually reversible) |
crU |
(abolish) SNAKE_UPPERCASE |
cru |
(abolish) SNAKE_UPPERCASE |
cS |
(sandwich) change automatic delimiters surrounding specified motion |
cs |
(sandwich) change specified delimiters surrounding specified motion |
dmx |
(signature) Remove mark 'x' where x is a-zA-Z |
dS |
(sandwich) delete automatic delimiters surrounding specified motion |
ds |
(sandwich) delete specified delimiters surrounding specified motion |
F |
(sneak) sneak backward onto {char} |
f |
(sneak) sneak forward onto {char} |
g! |
(scriptease) evaluate motion or selection as VimL and replace |
g< |
(swap) swap delimited item to the left |
g= |
(swap) enter interactive swapping mode |
g> |
(swap) swap delimited item to the right |
gA |
(SyntaxAttr) inspect syntax highlighting group at cursor |
ga |
inspect Unicode for character at cursor |
gF |
open file location (path:line,column) at cursor or in selection |
gG |
inspect function, method, or class name at cursor |
gJ |
(splitjoin) join lines at cursor into a single lines |
gK |
(splitjoin) split line at cursor into multiple lines |
gl |
(lion) left-align {motion} to [count] occurrences of {character} |
gL |
(lion) right-align {motion} to [count] occurrences of {character} |
gr |
Replace {motion} text with the contents of specified register. |
grr |
Replace [count] lines with the contents of specified register. |
gS |
(sandwich) surround inside automatic delimiters with specified delimiters |
gs |
(sandwich) surround selection or specified motion with specified delimiters |
K |
(Coc) Open the documentation of the symbol under the cursor. |
m'[ |
(signature) Jump by alphabetical order to start of prev line having a mark |
m'] |
(signature) Jump by alphabetical order to start of next line having a mark |
m, |
(signature) Place the next available mark |
m- |
(signature) Delete all marks from the current line |
m. |
(signature) If no mark on line, place the next available mark. Otherwise, remove (first) existing mark. |
m/ |
(signature) Open location list and display marks from current buffer |
m<BS> |
(signature) Remove all markers |
m<S-[0-9]> |
(signature) Remove all markers of the same type |
m<Space> |
(signature) Delete all marks from the current buffer |
m? |
(signature) Open location list and display markers from current buffer |
m[' |
(signature) Jump to start of prev line containing a mark |
m[- |
(signature) Jump to prev line having a marker of the same type |
m[0-9] |
(signature) Toggle the corresponding marker !@#$%^&*() |
m[= |
(signature) Jump to prev line having a marker of any type |
m[` |
(signature) Jump to prev mark |
m]' |
(signature) Jump to start of next line containing a mark |
m]- |
(signature) Jump to next line having a marker of the same type |
m]= |
(signature) Jump to next line having a marker of any type |
m]` |
(signature) Jump to next mark |
m`[ |
(signature) Jump by alphabetical order to prev mark |
m`] |
(signature) Jump by alphabetical order to next mark |
mx |
(signature) Toggle mark 'x' and display it in the leftmost column |
S |
(sneak) sneak backward onto {char}{char} |
s |
(sneak) sneak forward onto {char}{char} |
T |
(sneak) sneak backward until {char} |
t |
(sneak) sneak forward until {char} |
va" |
(textobj) select around double quotes |
va' |
(textobj) select around single quotes |
va( |
(textobj) select around () block |
va: |
(textobj) select around Ruby symbol |
va< |
(textobj) select around <> block |
va<Space> |
(textobj) select around whitespace |
va> |
(textobj) select around <> block |
va[ |
(textobj) select around [] block |
va| |
(textobj) select around table cell (table-mode) |
va] |
(textobj) select around [] block |
va` |
(textobj) select around back quotes |
vab |
(textobj) select around () block |
vaB |
(textobj) select around {} block |
vaC |
(textobj) select around comment and leading/trailing whitespace |
vac |
(textobj) select around comment, including comment delimiters |
vad |
(textobj) select around delimited text |
vaD |
(textobj) select around delimited text, per alternate grouping |
vae |
(textobj) select both sides of equation |
vaf |
(textobj) select outer function call |
vah |
(textobj) select around git hunk |
vai |
(textobj) select around indentation level and line above |
vaI |
(textobj) select around indentation level and lines above/below |
vaK |
(textobj) select around vertical WORD column |
vak |
(textobj) select around vertical word column |
val |
(textobj) select around line |
vam |
(textobj) select around merge conflict |
van |
(textobj) select around nearest block of specified delimiter |
vap |
(textobj) select around paragraph |
vaP |
(textobj) select around sentence |
var |
(textobj) select around Ruby/VimL block |
vaS |
(textobj) select around text surrounded by automatic delimiters |
vas |
(textobj) select around text surrounded by specified delimiters |
vat |
(textobj) select around XML tag |
vau |
(textobj) select around URL |
vav |
(textobj) select around variable name |
vaW |
(textobj) select around WORD |
vaw |
(textobj) select around word |
vax |
(textobj) select around XML attribute |
vay |
(textobj) select around syntax element |
va{ |
(textobj) select around {} block |
va} |
(textobj) select around {} block |
vi" |
(textobj) select inside double quotes |
vi' |
(textobj) select inside single quotes |
vi( |
(textobj) select inside () block |
vi: |
(textobj) select inside Ruby symbol |
vi< |
(textobj) select inside <> block |
vi<Space> |
(textobj) select inside whitespace |
vi> |
(textobj) select inside <> block |
vi[ |
(textobj) select inside [] block |
vi| |
(textobj) select inside table cell (table-mode) |
vi] |
(textobj) select inside [] block |
vi` |
(textobj) select inside back quotes |
vib |
(textobj) select inside () block |
viB |
(textobj) select inside {} block |
vic |
(textobj) select inside comment |
vid |
(textobj) select inside delimited text |
viD |
(textobj) select inside delimited text per alternate grouping |
vie |
(textobj) select nearest side of equation |
vif |
(textobj) select inner function call |
vih |
(textobj) select inside git hunk |
vii |
(textobj) select inside indentation level; no line above |
viI |
(textobj) select inside indentation level; no lines above/below |
viK |
(textobj) select inside vertical WORD column |
vik |
(textobj) select inside vertical word column |
vil |
(textobj) select inside line |
vim |
(textobj) select inside merge conflict |
vin |
(textobj) select inside nearest block of specified delimiter |
vip |
(textobj) select inside paragraph |
viP |
(textobj) select inside sentence |
vir |
(textobj) select inside Ruby/VimL block |
viS |
(textobj) select inside text surrounded by automatic delimiters |
vis |
(textobj) select inside text surrounded by specified delimiters |
vit |
(textobj) select inside XML tag |
viu |
(textobj) select inside URL |
viv |
(textobj) select inside variable name |
viw |
(textobj) select inside word |
viW |
(textobj) select inside WORD |
vix |
(textobj) select inside XML attribute |
viy |
(textobj) select inside syntax element |
vi{ |
(textobj) select inside {} block |
vi} |
(textobj) select inside {} block |
yob |
(unimpaired) toggle assuming light background |
yoc |
(unimpaired) toggle highlighting cursor's line |
yod |
(unimpaired) toggle diffing with current buffer |
yoh |
(unimpaired) toggle highlighting search results |
yoi |
(unimpaired) toggle ignoring case sensitivity |
yol |
(unimpaired) toggle listing nonprintable characters |
yon |
(unimpaired) toggle absolute line numbering |
yop |
(unimpaired) Change entire line, using paste mode temporarily. |
yor |
(unimpaired) toggle relative line numbering |
yos |
(unimpaired) toggle checking for misspelled words |
you |
(unimpaired) toggle highlighting cursor's column |
yov |
(unimpaired) toggle constraining cursor to line |
yow |
(unimpaired) toggle wrapping very long lines |
yox |
(unimpaired) toggle highlighting cursor's position |
z0 |
fold up to level 0 |
z1 |
fold up to level 1 |
z2 |
fold up to level 2 |
z3 |
fold up to level 3 |
z4 |
fold up to level 4 |
z5 |
fold up to level 5 |
z6 |
fold up to level 6 |
z7 |
fold up to level 7 |
z8 |
fold up to level 8 |
z9 |
fold up to level 9 |
zS |
(scriptease) show active syntax highlighting groups at cursor |
{| |
(table-mode) move cursor to table cell above |
}| |
(table-mode) move cursor to table cell below |
You can refresh the table above by running the following command in Vim:
call ShortcutsCheatsheetRefresh() " defined in plugin/000/shortcut.vimYou can also automate the above action from the command line by running:
vim README.md -c 'call ShortcutsCheatsheetRefresh() | update | quit'-
Run
stty -ixonbefore starting Vim to use<C-S>and<C-Q>keys. -
<C-S>saves the current buffer after stripping trailing whitespace. -
<C-Q>exits Vim (after confirmation if there are unsaved buffers). -
<C-L>clears search highlighting; recalculates hunks when diffing.
-
;puts Vim into command mode. It is a shift-less alternative to:. -
!puts Vim into shell command mode, for shift-less entrance to:!. -
@;repeats the most recently executed command line, just like@:. -
Qformats the current paragraph or text selection, just likegq.
-repeats last sneak forward_repeats last sneak backwardfsneaks forward onto {char}Fsneaks backward onto {char}tsneaks forward until {char}Tsneaks backward until {char}ssneaks forward onto {char}{char}Ssneaks backward onto {char}{char}<Esc>accepts sneak choice at cursor
<Leader>wis likewbut knows about camel/snake case.<Leader>bis likebbut knows about camel/snake case.<Leader>eis likeebut knows about camel/snake case.
gVvisually selects the most recently pasted text.gnselects the nearest search result after the cursor.gNselects the nearest search result before the cursor.
-
Yyanks from cursor to end of line, like Vim's nativeCandDkeys. -
<Leader>ycopies the current visual selection to the system clipboard.
In insert mode, when the completion menu doesn't appear:
<C-L>forcefully triggers completion menu to appear.
In insert mode, when the completion menu automatically appears:
<Enter>accepts the currently selected completion menu item.<C-J>expands snippet or cycles forward through placeholders.<C-L>forcefully refreshes the entire completion menu.<Tab>cycles forward through completion menu items, just like<C-N>.<S-Tab>cycles forward through chain of completion menu sources.
See MUcomplete.vim and NeoSnippet.vim.
Jump:
<C-Up>jumps to nearest fold above current line.<C-Down>jumps to nearest fold below current line.<C-Left>jumps to nearest section above current line.<C-Right>jumps to nearest section below current line.
Fold:
<A-Up>closes current fold.<A-Down>opens current fold.<A-Left>decreases fold level.<A-Right>increases fold level.
If you use Vim in the URxvt terminal emulator, then load the following snippet into xrdb(1) so you can use all the shortcuts defined in this Vim configuration:
xrdb -merge ~/.vim/urxvt.xrdb
The usage manual for each script is reproduced here, for your convenience.
Deletes untracked *.get files and packages lacking *.get files.
If a REGEX is provided, it will filter the candidates for deletion.
Usage: bin/clean [-f] [OPTIONS_FOR_GREP...] [REGEX]
Usage: bin/clean # asks you for confirmation
Usage: bin/clean -f # no confirmation; force it
Deletes existing packages whose names match the given regular expression.
Usage: bin/delete [OPTIONS_FOR_GREP...] PACKAGE_NAME_REGEXP
Inserts a new package, optionally named PACKAGE_NAME, into the given CATEGORY. You can specify USER/REPO in place of URL to insert from GitHub repositories.
Usage: bin/insert [URL|USER/REPO] CATEGORY/[FILETYPE=][PACKAGE_NAME]
Finds all known and untracked '*.get' files.
Usage: bin/manifest [OPTIONAL_FILTER_REGEXP]
Lists untracked *.get files and packages lacking *.get files.
Usage: bin/orphans
Replays local commits on top of the newest changes from upstream.
Usage: bin/rebase # asks to confirm bin/clean
Usage: bin/rebase -f # no confirmation; force it
Usage: git-rebase-autocon [TARGET] [ARGUMENTS_FOR_GIT_REBASE...]
Rebases the given TARGET while automatically resolving conflicts by substituting empty-tree commits labeled "fixup!" that log all conflicting hunks in their commit messages in git-diff(1) format.
If TARGET is not specified, the upstream tracking branch is used. Optional ARGUMENTS_FOR_GIT_REBASE... are passed to git-rebase(1).
Documented at https://sunaku.github.io/git-rebase-autocon.html
Rebases the main branches, going from conventional to divergent.
Renames existing packages whose names match the given regular expression.
Usage: bin/rename [OPTIONS_FOR_GREP...] PACKAGE_NAME_REGEXP
At the prompt, edit the package location and press ENTER to rename it so. If you no longer wish to rename the package, just press ENTER to skip it. If you made a mistake and want to abort the rename, press Control and C.
Lets you rename all *.get files in one fell swoop, from the comfort of Vim.
Usage: bin/rename-editor
The editor will present you with 3 split windows (left, middle, and right):
- The left window lists the current names for your reference (read-only)
- The middle window lists the current names for you to rename (writable)
- The right window lists the default names for your reference (read-only)
Edit the names in the middle window and then save the file before exiting. To cancel or avoid performing any renames, exit the editor without saving.
Note: DO NOT change the order or amount of lines presented in the editor!
Renames the given *.get file and all associated files to the new name.
Usage: bin/rename-fromto CURRENT_GET_FILE NEW_GET_FILE
Activates the given BRANCH and installs any bundles it defines.
Usage: bin/setup [BRANCH]
Usage: bin/setup origin # template
Usage: bin/setup basics # template + basics
Usage: bin/setup qwerty # template + basics + my flair
Usage: bin/setup dvorak # template + basics + my flair + dvorak
Usage: bin/setup engram # template + basics + my flair + engram
Usage: bin/setup master # template + basics + my flair + engram + new stuff
Lists all shortcuts available in this Vim configuration.
Usage: bin/update [BUNDLE_NAME|DIRECTORY|GET_FILE]...
Usage: env UPDATE_BUNDLES_SEQUENTIALLY=1 bin/update
Clones or updates the Git repositories specified in ./**/*.get files:
optionally matching the given BUNDLE_NAME, DIRECTORY, or GET_FILE path,
starting from the most recently modified file down to the earliest one,
checking out the branch or commit named in related ./**/*.set files.
After that, it runs corresponding ./**/*.run scripts for those repos.
This is done in parallel, at up to half of the maximum process limit,
unless the UPDATE_BUNDLES_SEQUENTIALLY environment variable is set.
Displays help and usage information for this and fellow scripts.
Usage: bin/usage [SCRIPT]
Formats usage information from all scripts for injection into README.
- Plugin Layout in the Dark Ages by Steve Losh.
-
Configuring Vim right by Stephen Bach.
-
Replacing All The Things with Unite.vim by Christopher Sexton.
Like my work? 👍 Please spare a life today as thanks! 🐄🐖🐑🐔🐣🐟✨🙊✌
Why? For 💕 ethics, the 🌎 environment, and 💪 health; see link above. 🙇
(the ISC license)
Copyright 2009 Suraj N. Kurapati https://github.com/sunaku
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.