/vim-indentguides

๐Ÿ“ Simple indentation guides for your buffers

Primary LanguageVim ScriptApache License 2.0Apache-2.0

- Note: This plugin is no longer being maintained.
" Since Vim v8.2.5066 (2022-06-07), you could use `leadmultispace` in listchars for equivalent behaviour
" feel free to use this conceal-less alternative supporting varying buffer shift widths (use BufEnter if needed):
set list
autocmd OptionSet shiftwidth execute 'setlocal listchars=trail:ยท,tab:โ”‚\ ,multispace:โ”†' . repeat('\ ', &sw - 1)

Features

Space indents are visually identified by the "โ”†" character, while tabs are distinguished by "|". Manually calling the command IndentGuidesToggle will toggle indent guides scoped to a specific buffer.

If there are any files you would like to not add indent guides for, add the filetype to the ignore list:

let g:indentguides_ignorelist = ['text']

If you'd like to change the default space and tab indent characters, modify the following in your vimrc:

let g:indentguides_spacechar = 'โ”†'
let g:indentguides_tabchar = '|'

The plugin will set the conceallevel to '2 if' except if it is already set to '1' or '2'. If concealcursor it not modifed it will be set to inc, to disable this set it to an nonempty value or set let g:indentguides_concealcursor_unaltered to any nonempty value.

Installation

Using Plug

Paste the following in your ~/.vimrc file:

if empty(glob('~/.vim/autoload/plug.vim'))
  silent execute "!curl -fLo ~/.vim/autoload/plug.vim --create-dirs https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim"
  autocmd VimEnter * PlugInstall | source $MYVIMRC
endif

call plug#begin('~/.vim/plugged')
Plug 'thaerkh/vim-indentguides'
call plug#end()

If you don't already have Plug, this will auto-download Plug for you and install the indentguides plugin.

If you already have Plug, simply paste Plug 'thaerkh/vim-indentguides' and call :PlugInstall to install the plugin.

Remember to :PlugUpdate often to get all the latest features and bug fixes!

Using Vundle

Paste this in your ~./vimrc:

Plugin 'thaerkh/vim-indentguides'

Using Pathogen

cd into your bundle path and clone the repo:

cd ~/.vim/bundle
git clone https://github.com/thaerkh/vim-indentguides

License

License