vimrc

Configure Vim with autocompletion, keybindings, editorconfig and linting

Overview

• Easy to install and expand with other plugins
• Deterministic configuration, disables any system settings
• Intelligent autocomplete using CoC
• Linting with eslint, tsserver, flake8 and pylint (with config)
• Improved syntax highlighting for JavaScript, React, Vue, SCSS and Pug
• Fuzzy code and file search using FZF and ripgrep
• Vim One theme everywhere in both light and dark shades
• My vimrc to configure all of the above and more

Supported languages

All languages supported by Vim are supported. These are all languages that are (somewhat) enhanced by using this vimrc:

Bash, CSS, Docker, Handlebars, HTML, JavaScript, JSON, Less, Markdown, Python, Pug, Razor, React, Ren'Py, SCSS, Tailwind, TypeScript, Vue, Vim, XML, YAML.

Languages in bold are the main focus of this vimrc project. However, the install script can be easily expanded to change the list of plugins.

Dependencies

These are the system packages that my vimrc depends on, none of which are installed automatically and some of which are optional. Linters and Vim plugins ARE installed by the install.sh script.

Required

• Git
• Vim 8 or higher
• Python3 with Pip3
• NodeJS with Npm

Optional

• bat - for showing FZF previews with syntax colors instead of text-only
• FZF (fzf) - for using any kind of fuzzy search commands, such as :Files
• Ripgrep (rg) - for using the :Rg command to fuzzy search file contents
• ShellCheck (shellcheck) - for linting sh/bash files for common errors

Install

To install my vimrc and related config, use the install.sh script. The script has been tested to work on a variety of Linux distributions, and PRs are encouraged to broaden the support for other platforms. The install script will ask you to install system packages manually, but all linters and plugins will be installed by the script to these locations:

• ~/.vim/ for all Vim configuration, including the vimrc
• ~/.local/ and ~/node_modules/ for pip and npm packages (mostly linters)
• ~/eslint.config.js contains the eslint config
• ~/.config/coc/ for all autocompletion related packages

Optionally you can append ./install.sh with 'clean' or 'config-only', which will wipe the existing .vim folder or only install the config, respectively.

Features and usage

Base

• Distribution independent configuration, system vimrc changes are reset
• User-only installation, see "Install" for a list of locations
• Default to 4 spaces for all files, unless overwritten by local configuration
• Show line numbers, special characters, trailing whitespace and colorcolumn
• Store all vim swap and backup files in ~/.vim/backup
• Enable fenced markdown languages and the matchit plugin
• More direct feedback using search highlighting, wildmenu, showcmd and such
• Leader key is set to the Space, toggle indent-based folding with <leader>t
• Toggle line wrap with W and toggle spellchecker with <leader>ss
• Switch between English, Dutch and combined with <leader>s + e, n or b respectively
• Clear the search with \ and exit insert/terminal modes with kj

See the vimrc file for details and mappings.

Plugins

This is a list of the plugins that are installed to add additional features. Changes to the default usage/bindings are listed as well. Not all plugins are listed, as some of them are merely to improve the syntax, a list of these can be found at the bottom of this readme.

Airline

• Themed statusline with limited extensions loaded, including CoC and venv

CoC

For Conqueror of Completion the following keys are mapped in normal mode:

• gd - jump to definition
• gy - jump to type definition
• gi - list and jump to implementation
• gr - list and jump to references
• gn - rename at cursor position
• <leader>f - autoformat code
• <leader>c - execute automatic diagnostic fix for the code (or selection)
• <leader>d - show a list of diagnostics
• <c-k> - jump to previous diagnostic
• <c-j> - jump to next diagnostic
• K - show CoC documentation or the vim help pages

The signcolumn is also populated by CoC, with all diagnostics displayed as >>, although each level from hint to error has a different color. Git difference is displayed as a single character, such as +, . or ~.

This plugin is also used for autocompletion, which will show automatically in insert mode. Suggestions are never automatically applied, but you can select them with <c-n> and <c-p>. You can then immediately continue typing without needing to press anything else. The only exception is made for snippets, which do need to be expanded with Tab. Unlike other configurations, the Tab key can not be used to modify whitespace, with this vimrc we use Vim's regular <c-d> and <c-t> to do so. Or << and >> to do the same outside of insert mode.

Editorconfig

• Will automatically activate when a config file is present

FZF

• Open the file finder with <leader>e
• Find text in files using ripgreg using <leader>r
• Switch buffers based on filename by pressing <leader>b
• Or use many more commands such as :GFiles or :Commits

Fugitive

• Use many commands such as :Gblame or :Gdiffsplit to access git within Vim

Illuminate

• Automatically highlights the same words in a relatively light gray color

Instant Markdown

• The preview won't open automatically
• Open the preview with the custom :MD command

Vim One

• Theme for code, FZF sub-windows, the statusline, the tabs and even terminals
• Switch between light and dark with D

Snippets

• A collection of snippets that will be suggested by CoC
• Use the Tab key to expand the highlighted snippet

Suda

• Allows you to save files that are owned by root
• Opens a copy and asks for sudo user password confirmation on write

TComment

In normal or visual mode, these keybindings can be used:

• gc - toggle comments (add if missing, remove if already present)
• g> - add comment markers (will add a second marker if already present)
• g< - remove comment markers (will do nothing if missing)

Undotree

• Toggle the Undotree with <leader>u, which automatically shifts the focus there

Context

• Show the context of the current function or path you are editing at the top

Uninstall

When uninstalling, the uninstall.sh script will do the following:

• Delete ~/.vim/, ~/eslint.config.js and ~/.config/coc/
• Ask for each of the installed packages if you want to uninstall them

License

ALL files in this repository are created by Jelmer van Arnhem. You can copy, share and modify them without limitation, see the UNLICENSE file for more details. The referenced projects are covered by different licenses, check them out below.

Links to all referenced projects

Linters

autopep8, bash-language-server, eslint-config, instant-markdown-d, flake8, pylint

Vim plugins

ap/vim-css-color, chaimleib/vim-renpy, editorconfig/editorconfig-vim, digitaltoad/vim-pug, honza/vim-snippets, junegunn/fzf.vim, laggardkernel/vim-one, lambdalisue/suda.vim, MaxMEllon/vim-jsx-pretty, neoclide/coc.nvim, mbbill/undotree, pangloss/vim-javascript, posva/vim-vue, RRethy/vim-illuminate, suan/vim-instant-markdown, tomtom/tcomment_vim, tpope/vim-fugitive, vim-airline/vim-airline, vim-ide/scss-syntax.vim wellle/context.vim

CoC extensions

coc-css, coc-docker, coc-eslint, coc-git, coc-highlight, coc-html, coc-jedi, coc-json, coc-markdownlint, coc-pyright, coc-react-refactor, coc-snippets, coc-sources, coc-syntax, coc-tailwindcss, coc-tsserver, coc-vetur, coc-vimlsp, coc-yaml

Other

bat, fzf, ripgrep, shellcheck