Skip to content

Latest commit

 

History

History
138 lines (105 loc) · 5.7 KB

README.md

File metadata and controls

138 lines (105 loc) · 5.7 KB
Raw

Problem: too many neovim configs on github

Solution: write another one

A neovim config I made for myself. If it works for you, great! No guarantees that it will.

Note: Beta. I've been using this for real world development for close to a year now. Things aren't changing that much, but there are still some things I want to change, so I'll say this is "beta". Will I ever set aside time to implement them? If this message is still here, it clearly means I haven't.

Wait, so if all that exists, why a new one?

The goal of this is to keep neovim simple. Recently with developement and support of the Language Server Protocol, it doesn't make sense to keep the way you deal with your languages wrapped up in your vim settings. As such, first priority of this setup is to rely on the LSP as much as possible.

What's in here?

And that's it. Simple right?

Importantly, this config doesn't make any assumptions of what languages you program in. You can easily configure that yourself (see below for details).

Wow you're pretty clever.

Actually this is just "inspired" from a bunch of places. The following are configs I've used or taken an extended look at in the past and so some of how this works will probably look somewhat familiar.

Setup:

Requirements

Expected to have installed:

  • neovim (I did this in v0.4.3 so no clue how it'll work elsewhere)
  • pyenv and virtualenv

Recommended

Recommend having the following installed

Install

This is designed to run from a completely clean setup on a mac. Having things such as Plug installed or an existing init.vim may or may not cause some issues.

brew install nvim
git clone --depth=1 https://github.com/SamCB/nvim_settings.git ~/.nvim_settings
sh ~/.nvim_settings/setup.sh
nvim +PlugInstall

Customising

After running the setup script, there will be a file ~/.config/nvim/my_config.vim. Add any settings you want into that. This is also where you'll put config for installing your coc scripts. For example:

let g:coc_global_extensions = [
  \ 'coc-tsserver', 'coc-html', 'coc-css', 'coc-python', 'coc-vimlsp'
\ ]

A list of coc extensions can be found here. Restarting vim should make the extensions install. (Recently it has become possible to use vim-plug to install coc extensions. If you'd rather do that see here and my comments on vim-plug below for details.)

If you have and like to use powerline fonts for airline, then you can also set that there.

let g:airline_powerline_fonts = 1

There is also a file: ~/.config/nvim/my_installs.vim which you can use to add your own plugins using the usual vim-plug methods. For example:

Plug 'leafgarland/typescript-vim'
Plug 'peitalin/vim-jsx-typescript'

Note, do not add the plug#begin or plug#end statements to this file. This file is called after all other Plug commands, but before plug#end.

Coc has its own config JSON file. Configuration of that is left as an exercise for the user. Details can be found here. Use the command :CocConfig to open the file.

Some commands and personal shortcuts:

Key Command Key Command
, Leader ,/ Clear last search pattern
,nf Open NERDTree pane :BD Buffer delete without window close
,f Open temporary NERDTree pane :TF Toggle fold mode (indent) on or off
<C-p> Search for file in project :TF s Toggle fold mode (syntax) on or off
<C-b> Search for file in open buffer ,b Next window visited will switch to current buffer
<C-g>g Grep across project
<C-g>G Grep for word under cursor
<C-g>s Grep across project, drawer mode
K Open documentation
g[ goto previous problem
g] goto next problem
gd goto definition
gy goto type definition
gi goto implementation
gr goto references
,cr rename
,cf fix
,ca code action
,l open locationlist
,q open quickfix
,L close locationlist
,Q close quickfix
,o jump into/out of floating coc window