vimfiles

This is my cross-platform, cross-editor ~/.vim folder.

That being said, this repo is now tailored to work best with Onivim.

Description

• Works well on unix, and pretty fine on Windows
• Small set of plugins for general development
• Modular nvim / vim and common configuration. Plugins' configurations are loaded from their respective files.

Here is how it looks with Onivim on Windows 10 and Windows Subsystem for Linux.

Installation

Using Neovim: Clone to ~/.config/nvim.

# osx / nix
$ git clone https://github.com/mklabs/vimfiles.git ~/.config/nvim

Using vim: Clone to ~/vimfiles on windows, clone to ~/.vim everywhere else.

Using onivim: Clone to ~/AppData/Local/nvim on windows, and ignore the following Windows note.

Windows Note: You need to rename the ~/.vimrc to its windows equivalent ~/_vimrc & ~/_gvimrc (a _ instead of .). The colorscheme is left to default and can be configured in _vimrc file.

Fonts note: In order for vim-devicons to work, you'll need to install Droid sans Mono nerd font and run sudo fc-cache -f -v (tested on Ubuntu)

Plugin install

Once vim is started, run :PlugInstall or :PlugUpdate.

Plugins

See config/plugins.vim to configure the list of plugins to install.

Configuration

vimrc

init.vim is just a symlink to vimrc. The first is used by neovim while the latter is used by regular vim.

Common plugin and configurations are loaded with from within ./config folder.

Default themse set to [Oceanic Next][] only for unix terminal or GUI environment.

./config

• plugins.vim - vim-plug initialization and definitions of plugins used
• mappings.vim - contains most of the general keybindings (not plugin specific)
• autocmd.vim - Autocommand stuff to hook certain action on particular Vim events

./plugins

• {pluginName}.vim - contains plugin specific configuration and mappings

Mappings

These mappings have been thought to work alongside Onivim's default one.

Snippets

Snippets are enabled and provided by xptemplate.

The ftplugin/*/*.xpt.vim files are actually snippet definition files for xptemplate. Feel free to browse them or edit them in your own fork.

In this repository, they're written using two-spaces indent with semi-colon. Though it can be easily fixed after being replaced with tools like prettier

Some snippets don't have semi colons as they are designed to be use, in some place, where semi-colons are not desired. Such as () which expands to anonymous arrow functions.

Right now, there's quite a few snippets tailored for JavaScript development using es6 syntax and mocha definitions.

Also, huhe thanks to torgeir/vim for the req snippet, which replace and strip down the basename part of the required module. In addition to that, quite a few snippet (namely for mocha) have been borrowed from his repository.

Templates

Templates are enabled and provided by vim-template.

This is a simple plug-in for Vim (and NeoVim) allowing to have template files per file type, which will be used as starting point when creating new buffers. Template files may contain variables (|template-variables|), which are expanded at the time of buffer creation (see |template-usage|). The main purpose of the templates is to add boilerplate code to new files, like C/C++ header guards, or license disclaimers.

Few templates are defined in this repository, in the ./templates directory.

Credits

It started as a fork of quick-vim, but have diverged quite a bit.

vim/gvim config files based on janus config. A good amount of vim goodies were also taken from Derek's vim-config

Thanks: quick-vim, vim-config, janus, nvie's vimrc