Plugins.md

Plug-ins

This lists, justifies and briefly documents each plug-in included in this distribution. Separating them in categories. You can find full documentation on the plug-in's github page or by accessing its help (usually at :h <plugin-name>). Most user configuration should be put in your user/after.vim unless otherwise stated on the docs for the plug-in or here.

Table of Contents

• Plug-ins
• Table of Contents
  • Color schemes
    • chriskempson/base16-vim
    • joshdick/onedark.vim
  • UI - User interface additions
    • mhinz/vim-startify
    • bronson/vim-trailing-whitespace
    • kshenoy/vim-signature
    • itchyny/lightline.vim
    • hecal3/vim-leader-guide
  • Editing - Text manipulation
    • tpope/vim-commentary
    • terryma/vim-multiple-cursors
    • pelodelfuego/vim-swoop
    • terryma/vim-expand-region
    • dropofwill/auto-pairs
    • tpope/vim-endwise
    • machakann/vim-swap
    • AndrewRadev/splitjoin.vim
    • sk1418/Join
    • tpope/vim-surround
    • tpope/vim-repeat
    • maxbrunsfeld/vim-emacs-bindings
    • matze/vim-move
    • junegunn/vim-easy-align
    • tpope/vim-speeddating
    • tommcdo/vim-exchange
  • General -- Helpful generic tools with no dependencies
    • tpope/vim-projectionist
    • tpope/vim-sleuth
    • tpope/vim-abolish
    • tpope/vim-unimpaired
    • tpope/vim-eunuch
    • kopischke/vim-stay
    • kopischke/vim-fetch
    • mbbill/undotree
    • Konfekt/FastFold
    • mhinz/vim-sayonara
    • junegunn/goyo.vim
    • junegunn/limelight.vim
    • benmills/vimux
    • tpope/vim-dispatch
    • kassio/neoterm
    • romainl/vim-qf

Color schemes

These merely add color schemes (a.k.a. themes) for us to chose from. We'll have a default configured on colorscheme.vim but users can easily swap them on their local configurations.

chriskempson/base16-vim

A great collection of schemes ported as 16 color palettes for great portability.

joshdick/onedark.vim

Atom's text editor color scheme ported to vim (currently the default scheme of the distribution).

UI - User interface additions

Plug-ins that add UI elements, these should require no to little interaction to activate and are ideally disable-able.

mhinz/vim-startify

A better start page for vim. Customized to show the current version and most recently used files in the current directory. Our local configuration for it lives in include/startify.vim. This can be disabled with the following snippet:

let g:startify_disable_at_vimenter = 0

bronson/vim-trailing-whitespace

Show trailing whitespace in red. Can only be disabled by preventing loading of the plug-in. This needs to go on your user/before.vim:

let g:loaded_trailing_whitespace_plugin = 1

kshenoy/vim-signature

Shows marks on the gutter. Disable with:

let g:SignatureEnabledAtStartup = 0

itchyny/lightline.vim

Fast, simple and lightweight status line. Requires a powerline patched font to show properly. Our local configuration for it lives in include/lightline.vim. This can be disabled with the following snippet:

let g:lightline.enable = {
  \ 'statusline': 0,
  \ 'tabline': 0
  \ }
" You may also want to enable showmode again to see -- INSERT --/etc
set showmode

You can also change it's colorscheme, and enable tabline!

let g:lightline.colorscheme = 'wombat'
let g:lightline.enable = {
      \ 'statusline': 1,
      \ 'tabline': 1
      \ }

More advanced configuration is documented in :h lightline

hecal3/vim-leader-guide

Shows a guide to key mappings. This is meant to make our custom key mappings more discoverable. Will automatically show when hitting the leader key. Disable with:

unmap <leader>

Editing - Text manipulation

Plug-ins providing commands or helpers that directly impact how you edit text passively or actively.

tpope/vim-commentary

(Un-)comment code. Default binding is the operator gc, allowing you to do gc<motion>, see documentation for more details. We have a local binding at <c-_> (or Control-/) to toggle comments on the current line or visual selection.

terryma/vim-multiple-cursors

Provides multiple cursor functionality like the one in Atom or Sublime. Activate with <c-n> in either normal or visual mode for current word or selection respectively. Then:

• <c-n>: find next occurrence and create cursor
• <c-p>: go back to previous cursor (removing current)
• <c-x>: skip current occurrence. Like <c-n> but without creating a cursor for the current.

Or use :MultipleCursorsFind to create cursors from a search.

pelodelfuego/vim-swoop

Visual context when bulk editing buffers. Start with :Swoop for current buffer only or :Swoop! for all open buffers. First line in the newly opened window is a search pattern (that can also be passed as argument to the :Swoop[!] commands). Editing on the swoop buffer will propagate to the real files automatically.

terryma/vim-expand-region

Select regions incrementally. Simply hit + to expand your selection or _ to reduce it.

tpope/vim-endwise

Automatically add 'end' when opening a block.

machakann/vim-swap

Move parameters around (delimited by a separator such as ,). gs To enter "swap-mode" or g>/g< to move parameters around in normal mode.

AndrewRadev/splitjoin.vim

Simplifies the transition between multi-line and single-line code. gS splits and gJ joins.

sk1418/Join

:Join command. Allows you to join lines with a separator, for example :J ', ' will join lines with a , in between them.

Before	command & description	After
	:J ', ' 3 Join with: sep count
	:J '-' 3 r Join with: sep count reverse
	:J '-' 3 k Join with: sep count keep
	:J '-' 3 kr Join with: sep count keep reverse
	:J -3 Join with: negative count
	:J -3 r Join with: negative count reverse
	:J -3 kr Join with: negative count reverse keep
	:2,5J "'\"\t" k Join with: range special sep keep
	:2,5J "# " rk Join with: range sep keep reverse
	:5,7J 3 Join with: range count
	:5,7J -3 Join with: range negative count

tpope/vim-surround

Quoting/parenthesizing made simple; e.g. ysiw) to wrap word in parens.

tpope/vim-repeat

Enable repeating supported plug-in maps with .

maxbrunsfeld/vim-emacs-bindings

Add emacs/bash/cocoa key bindings to vim, in insert and command-line modes.

matze/vim-move

Plugin to move lines and selections up and down. <a-k>/<a-j>.

junegunn/vim-easy-align

A Vim alignment plug-in. See readme for examples. ga gets you in "align mode".

tpope/vim-speeddating

Use CTRL-A/CTRL-X to increment dates, times, and more.

tommcdo/vim-exchange

Easy text exchange operator for Vim. cx<motion> in normal mode or X in visual mode. Running again after making a selection (which will be visually highlighted) will swap the two regions.

General -- Helpful generic tools with no dependencies

tpope/vim-projectionist

Project configuration via 'projections'.

tpope/vim-sleuth

Automatically adjusts 'shiftwidth' and 'expandtab' heuristically based on the current file.

tpope/vim-abolish

Easily search for, substitute, and abbreviate multiple variants of a word. :Subvert, :Abolish and coercion.

:Subert: case-aware search/replace

This will replace blog with post or Blog with Post:

:Subvert/blog{,s}/post{,s}/g

Coercion: change casing of text, from the docs:

Want to turn fooBar into foo_bar? Press crs (coerce to snake_case). MixedCase (crm), camelCase (crc), snake_case (crs), UPPER_CASE (cru), dash-case (cr-), dot.case (cr.), space case (cr<space>), and Title Case (crt) are all just 3 keystrokes away. These commands support repeat.vim.

tpope/vim-unimpaired

Pairs of handy bracket mappings; e.g. [ and ] add newlines before and after the cursor line. See docs for more commands or :help unimpaired

tpope/vim-eunuch

Vim sugar for the UNIX shell commands that need it the most; e.g. :Find, :Wall

kopischke/vim-stay

Make Vim persist editing state without fuss.

kopischke/vim-fetch

Make Vim handle line and column numbers in file names with a minimum of fuss.

mbbill/undotree

The ultimate undo history visualizer for VIM. Activate with :UndotreeToggle

Konfekt/FastFold

Speed up Vim by updating folds only when called-for.

mhinz/vim-sayonara

Sane buffer/window deletion. Kill a buffer with <M-q>.

junegunn/goyo.vim

Distraction-free writing in Vim. Activate with :Goyo.

junegunn/limelight.vim

All the world's indeed a stage and we are merely players.

benmills/vimux

Interact with tmux. Used by vim-test or usable on its own. See docs for details or :help vimux.

tpope/vim-dispatch

Asynchronous build and test dispatcher. Used by vim-test or usable on its own. See docs for details or :help dispatch.

kassio/neoterm

Wrapper of some vim/neovim's :terminal functions.

romainl/vim-qf

Tame the quickfix window. :Reject to filter out lines, :Keep to filter in and :Restore to revert to the original contents.