Rafael Bodill's Neo/vim Config

Lean mean Neo/vim machine, 30-45ms startup time.

Best with Neovim 0.5.x or Vim 8.x and python3 enabled.

I encourage you to fork this repo and create your own experience. Learn how to tweak and change Neo/vim to the way YOU like it. This is my cultivation of years of tweaking, use it as a git remote and stay in-touch with upstream for reference or cherry-picking.

Features

• Fast startup time
• Robust, yet light-weight
• Lazy-load 95% of plugins with [Shougo/dein.vim]
• Custom side-menu (try it out! Space+l)
• Custom context-menu (try it! ;+c)
• Modular configuration (see structure)
• Auto-complete [prabirshrestha/asyncomplete.vim] extensive setup
• [Shougo/denite.nvim] centric work-flow (lists)
• Structure view with [liuchengxu/vista.vim]
• Open SCM detailed URL in OS browser
• Light-weight but informative status/tabline
• Easy customizable theme
• Premium color-schemes
• Central location for tags and sessions

Screenshot

Prerequisites

• Python 3 (brew install python)
• Neovim or Vim (brew install neovim and/or brew install vim)

Caveat: You must have one of these tools installed: yj, yq, yaml2json, Ruby, or Python with PyYAML in-order for the YAML configuration to be parsed.

Install

1. Let's clone this repo! Clone to ~/.config/nvim, we'll also symlink it for regular Vim:

mkdir ~/.config
git clone git://github.com/PegasusWang/vim-config.git ~/.config/nvim
cd ~/.config/nvim
ln -s ~/.config/nvim ~/.vim  # For "regular" Vim

• Note: If you set a custom $XDG_CONFIG_HOME, use that instead of ~/.config in the commands above. Neovim follows the XDG base-directories convention, Vim doesn't.

2. Install the Python 3 pynvim library. This is also needed for Vim 8 if you want to use Denite and Defx.

Neovim: ./venv.sh or pip3 install --user pynvim

Vim: pip3 install --user pynvim

3. Run make test to test your nvim/vim version and capabilities.

4. Run make to install all plugins.

5. If you are experiencing problems, run and read nvim -c checkhealth

Test Python 3 availability with :py3 print(sys.version_info)

Enjoy! :smile:

Language-Server Protocol (LSP)

To leverage LSP auto-completions and other functionalities, once you open a file in Neo/vim, run :LspInstallServer <name> to use [mattn/vim-lsp-settings] installation feature, use Tab to list available servers.

Here are a few useful commands:

• For example, open a .go file, and run: :LspInstallServer gopls
• In a go file, use action :LspCodeAction source.organizeImports
• See config/plugins/lsp.vim for special code intellisense mappings

Upgrade

cd ~/.config/nvim
make update

This will run git pull --ff --ff-only and update all plugins using [Shougo/dein.vim] package-manager (:call dein#update()).

Recommended Fonts

• Pragmata Pro (€19 – €1,990): My preferred font
• Any of the Nerd Fonts

On macOS with Homebrew, choose one of the Nerd Fonts, for example, to install the Hack font:

brew tap homebrew/cask-fonts
brew search nerd-font
brew cask install font-hack-nerd-font
brew cask install font-iosevka-nerd-font-mono
brew cask install font-jetbrains-mono
brew cask install font-fira-code

Recommended Linters

• macOS with Homebrew:

brew install shellcheck jsonlint yamllint tflint ansible-lint
brew install tidy-html5 proselint write-good

• Node.js based linters:

yarn global add eslint jshint jsxhint stylelint sass-lint
yarn global add markdownlint-cli raml-cop

• Python based linters:

pip3 install --user vim-vint pycodestyle pyflakes flake8

Recommended Tools

• ag ggreer/the_silver_searcher (macOS: brew install the_silver_searcher)
  • and/or ripgrep: BurntSushi/ripgrep (macOS: brew install rg)
• Jump around with z: rupa/z (macOS: brew install z)
  • or z.lua: acme/zlua
• Universal ctags for syntax tokenization (macOS: brew install universal-ctags/universal-ctags/universal-ctags)
• Fuzzy file finders: fzf, fzy, or peco (macOS: brew install fzf)

User Custom Config

If you want to add your own configuration, create the config/local.vim file and add your personal vimscript there. If you'd like to install plugins by yourself, create a config/local.plugins.yaml file and manage your own plugin collection.

If you want to disable some of the plugins I use, you can overwrite them, e.g.:

- { repo: mattn/vim-lsp-settings, if: 0 }

Disable built-in statusline & tabline

You can use your local config/local.vim to disable status and tab lines:

let g:tabline_plugin_enable = 0
let g:statusline_plugin_enable = 0

Now, using config/local.plugins.yaml you can install any line plugin you want, e.g.:

# Use only one!
- repo: itchyny/lightline.vim
- repo: vim-airline/vim-airline
- repo: glepnir/galaxyline.nvim
- repo: glepnir/spaceline.vim
- repo: liuchengxu/eleline.vim

Structure

• config/ - Configuration
  • plugins/ - Plugin configurations
  • all.vim - Plugin mappings
  • …
  • filetype.vim - Language behavior
  • general.vim - General configuration
  • local.plugins.yaml - Custom user plugins
  • local.vim - Custom user settings
  • mappings.vim - Key-mappings
  • plugins.yaml - My favorite Plugins!
  • terminal.vim - Terminal configuration
  • vimrc - Initialization
• ftplugin/ - Language specific custom settings
• plugin/ - Customized small plugins
• snippets/ - Personal code snippets
• themes/ - Colorscheme overrides
• filetype.vim - Custom filetype detection

Plugin Highlights

• Plugin management with cache and lazy loading for speed
• Auto-completion with Language-Server Protocol (LSP)
• Project-aware tabs and labels
• Defx as file-manager + Git status icons
• Extensive language extensions library

Note that 95% of the plugins are lazy-loaded.

Plugins Included

Custom Key-mappings

Note that,

• Leader key set as ,
• Local-Leader key set as ; and used for navigation and search (Denite and Defx)
• Disable ← ↑ → ↓ in normal mode by enabling g:elite_mode in .vault.vim

Credits & Contribution

Big thanks to the dark knight Shougo.

解决 mac tmux 下 neovim 无法复制到剪贴板的问题

# https://github.com/tmux/tmux/issues/543
brew install reattach-to-user-namespace
# then edit your .tmux.conf
set -g default-shell $SHELL
set -g default-command "reattach-to-user-namespace -l ${SHELL}"
# In .vimrc or ~/.config/nvim/init.vim (I use Neovim):
set clipboard=unnamed
# reload tmux config
tmux source-file ~/.tmux.conf

解决 vim gutter 使用 emoji 文本渲染问题

See this Vim text rendering off by one issue

如果你使用了 Iterm2 + neovim，并且在 gutter 栏使用了 emoji 表情，比如 vim-gitgutter, vim-ale 等插件的提示是 emoji。 请勾选 Iterm2->Profiles->Text->Use Unicode versoin 9 widths

See this issue https://stackoverflow.com/questions/43107435/emoji-display-issue-in-vim-with-tmux/52142277#52142277

ag (The Silver Searcher) ignore file 搜索忽略文件

最好在你的根目录或者项目目录加上 ag 搜索需要忽略的文件，防止 denite 搜索占用太大内存，并且加速筛选内容

add ~/.agignore file:

node_modules
.git
.ropeproject

gen-py/
gen-go/
eggs/
.tmp/
vendor/

*.swp
*.pyc

fzf.vim :Ag 搜索结果发送到 quickfix 窗口

使用 fzf.vim 有个 :Ag 命令搜索的时候可以把结果发送到 quickfix 窗口。通常搜索结果可以使用 ctrl+n/p 来选择

使用方式：

• :Ag 搜索需要的单词。:Ag word
• alt-a 全选 (注意 MacOS iterm2: Settings -> Profiles -> Keys Left Option choose Esc+)
• alt-d 可以取消选择
• Enter 即可，这时候就可以把搜索结果发送到 quickfix 窗口

ref: https://github.com/junegunn/fzf.vim/issues/586

Coc.Nvim

If you want to use coc.nvim for Golang completion, please see this article 《vim as a go ide》. Now you can use coc branch for go completion(use gopls). If you use python, type CocInstall coc-python install python coc plugin.

(注意笔者基于开源配置代码修改，笔者的 leader 是 "," 而不是文档中的 Space)