Cool & Modularized vim configurations to work like an IDE

(Sorry for low quality gif, i'v tried to optimize and reduce the demo.gif size. I'll update it later when i have time)

View asciinema version (without nerd font it look not too good)

Currently i'm using coc.nvim. But there's also a version using ncm2, you can try it here.

• Introduction
• Requirements
  • System
  • Neovim
  • Nodejs
  • Providers
• Installation
  • Download
  • Install Plugins
  • Fonts
  • Snippets
  • Others
• Features
  • Support Languages
  • Plugins
    • Colors
    • Toolbar
    • Finder
    • Navigate
    • Syntax Hightlight
    • Faster Code
    • Beautiful Code
    • Utils
    • Autocomplete
    • Autocomplete Source
    • Autocomplete Supporter
• Customize
  • Directory Structure
    • Folders
    • Files
  • Mappings
    • General
    • Plugins
    • Autocomplete
    • Language Server Protocol
• License

This's my efforts to create an IDE like with nvim. With cover a lots of great features for coding: syntax, autocomplete, snippets, language server protocol...but with very simple and modularized scripts, which every one can easy understand and config.

Those configurations is only for Neovim, although most plugins work with Vim too, but i'v built this only for Neovim.

For Vim, i just have some minimal configurations in my dotfiles.

Those configurations work well on almost all OS i'v ever used (OSX, Linux, Window...).

But as it scale, i haven't have times to check it all, for now i just use OSX at home and Linux at work. So i can only make sure it work well on OSX and Linux. If you have any problem with Window please open an issue.

In order to have all the coolest features. You should install lastest release (>= 0.4.0) Nvim. Which support some new great features like float window...

There's a lot of plugins that use external packages (Like language server protocol...). And we do need to install Nvim Node.js provider too. So Nodejs & Npm is needed.

Please download and install it or you can install it via package manager

We have to install python providers (most nvim plugins do need em to work). Python 2 is no actually required. But some plugin may need it, so just install them all 😆

Assume you are using linux:

# Installing python 2.7 and pip for it
sudo apt install python2.7 python-pip
# Installing python-pip for 3.6
sudo apt install python3-pip

# Install neovim for python 2
pip2 install pynvim
# Install neovim for python 3
pip3 install pynvim

Already installed python neovim ? Then upgrade it (Some plugins need latest versions)

# Upgrade neovim for python 2
pip2 install --upgrade pynvim
# Upgrade neovim for python 3
pip3 install --upgrade pynvim

Nvim Node.js client is also needed (for neovim to be able to communicate with plugins). Let install it too:

npm install -g neovim

For clipboard support you must install xclip or xclipboard

Before starting with this step, you must make sure that you'v read and install everything required in above steps.

And make sure there's no ERROR showing when running :checkhealth in nvim.

Download everything in this repo and put em in the nvim folder of yours (Usually it's in ~/.config/nvim).

Or clone it with git (make sure there no file's in ~/.config/nvim or that folder does not exist for git to work):

git clone [email protected]:kyoz/neovim.git ~/path_to_your_nvim_folder --depth 1

" Example
git clone [email protected]:kyoz/neovim.git ~/.config/nvim --depth 1

Open nvim and use :PlugInstall or :PlugI to install all plugins (If there are errors showing when you first running this, just enter to pass them all).

Quit and re-open nvim and now you have nvim with a lots of feature which can be your main IDE.

In order to make everything look cool as it have to (with vim-arline, nerd-tree icons...), we have to using patched fonts. You can view some pathced fonts here.

There's a /fonts folder with patched Iosevka font, which i'm using now. You can use it too.

I'v tried a lots of fonts, but this Iosevka font seem suitable for me, it's easy to read and doesn't make me lose focus when coding.

I'v use neosnippet to provide snippets for Vim. You can view all the snippets i have in snippets/ folder.

Currently i just add some basic snippet with some languages i usually use: html, css, javascript, typescript....

Because i use Angular, Material Components and Flex layout a lots. I also create snippets for em too 😊. It's super useful.

Just view some examples in my snippets and you'll know how to create your own snippets.

It's hard to cover all the cases when install neovim in each machine, os...

Please run :checkhealth in nvim to make sure everything is ok. Follow it's constructions and fix any errors you see.

If there's still error, please open and issue and let me know, i'm happy to help.

• Html
• Css, Scss, Sass, Less
• Javascript, Typescript
• Python
• Vimscript
• C, C++ (Not use so much)
• Other files types like: Bash, Dockerfile, Markdown, Json...

Wait, why there's only a few languages ?

To provide autocomplete feature, i do use coc.nvim. There's a lots of extensions (which support for more languages, frameworks, filetypes...)...you can see it all in coc.nvim's Readme

Why not use other autocomplete plugin like deoplete, ncm2 ?

Actually, i'v used deoplete and ncm2 for a long times. It's all work great. But then i know coc.nvim, i really like the way it manage the extensions. With coc's extensions, i can easily add more languages autocomplete, add more useful extenstions without any fear...

There's also a version which using ncm2, you can try it here.

Note: I use ack.vim to provide global search feature for Vim. If you found the the search is slow. You can use the silver searcher as the search engine for ack.vim.

There's no configurations suitable for everyone. Each one have different tastes.

So, in order to easily customize those configuration. You must understand the structural of configuration files.

/home/kyoz/.config/nvim
├── autoload/
├── colors/
├── configs/
│   ├── init.vim
│   ├── general.vim
│   ├── indent.vim
│   ├── keys.vim
│   ├── plugins.vim
│   ├── autocomplete.vim
│   └── lsp.vim
├── fonts/
├── snippets/
├── init.vim
└── ginit.vim

All general custom mappings is place in configs/keys.vim

Leader key: space
Local leader key: \

All plugins custom mappings is place in configs/plugins.vim

All autocomplete mappings is place in configs/autocomplete.vim

All lsp mappings is place in configs/lsp.vim

MIT © Kyoz