LunarVim/README.md

219 lines
3.9 KiB
Markdown
Raw Normal View History

2020-08-29 18:31:23 +02:00
# NVCode
2020-04-25 00:50:40 +02:00
2020-08-29 18:31:23 +02:00
![NVCode pic](./utils/images/nvim.png)
2020-05-12 06:12:50 +02:00
2020-05-12 05:52:49 +02:00
## Install in one command
2020-04-28 05:59:39 +02:00
2020-05-12 05:52:49 +02:00
The following will install this config if you have an existing config it will move it to `~/.config/nvim.old`
This script only supports Mac, Ubuntu and Arch
```
bash <(curl -s https://raw.githubusercontent.com/ChristianChiarulli/nvim/master/utils/install.sh)
```
2020-04-28 05:59:39 +02:00
2020-04-25 00:50:40 +02:00
## Install Neovim
2020-08-29 18:31:23 +02:00
- Mac
2020-05-10 19:52:08 +02:00
```
brew install neovim
2020-09-17 17:42:18 +02:00
brew install --HEAD neovim # Latest
2020-10-29 16:09:31 +01:00
brew upgrade neovim --fetch-HEAD # Sometimes you need to update
2020-05-10 19:52:08 +02:00
```
2020-04-25 00:50:40 +02:00
- Ubuntu
2020-05-10 19:52:08 +02:00
```
2020-10-29 16:09:31 +01:00
sudo apt install neovim # This may not provide the newest version
2020-05-10 19:52:08 +02:00
```
2020-04-25 00:50:40 +02:00
- Arch
2020-05-10 19:52:08 +02:00
```
2020-10-29 16:09:31 +01:00
yay -S neovim-nightly-git # Latest
2020-05-10 19:52:08 +02:00
```
2020-04-25 00:50:40 +02:00
2020-04-25 00:55:06 +02:00
## Clone this repo into your config
2020-04-25 00:50:40 +02:00
```
2020-04-29 16:20:41 +02:00
git clone https://github.com/ChristianChiarulli/nvim.git ~/.config/nvim
2020-04-25 00:50:40 +02:00
```
## Install python & node support
```
pip install pynvim
```
```
npm i -g neovim
```
2020-05-12 23:12:38 +02:00
## Install Neovim remote
```
pip install neovim-remote
```
This will install `nvr` to `~/.local/bin` so you will need to add the following to your `bashrc` or `zshrc`
```
export PATH=$HOME/.local/bin:$PATH
```
2020-04-25 00:50:40 +02:00
## Install clipboard support
2020-08-29 18:31:23 +02:00
- On Mac pbcopy should be builtin
2020-04-25 00:50:40 +02:00
2020-08-29 18:31:23 +02:00
- Ubuntu
2020-04-25 00:50:40 +02:00
2020-05-10 19:52:08 +02:00
```
sudo apt install xsel
```
2020-04-25 00:50:40 +02:00
2020-08-29 18:31:23 +02:00
- Arch
2020-04-25 00:50:40 +02:00
2020-05-10 19:52:08 +02:00
```
sudo pacman -S xsel
```
2020-04-25 00:50:40 +02:00
## (Optional) Install python & node support using virtual environments
Make sure to add these paths somewhere in your config
```
let g:python3_host_prog = expand("<path to python with pynvim installed>")
let g:python3_host_prog = expand("~/.miniconda/envs/neovim/bin/python3.8") " <- example
let g:node_host_prog = expand("<path to node with neovim installed>")
2020-05-10 19:52:08 +02:00
let g:node_host_prog = expand("~/.nvm/versions/node/v12.16.1/bin/neovim-node-host") " <- example
2020-04-25 00:50:40 +02:00
```
2020-04-26 20:17:15 +02:00
## List of programs you should install
- ranger
- ueberzug
2020-04-27 07:44:22 +02:00
- ripgrep
- silver_searcher
- fd
- universal-ctags
2020-04-28 05:55:12 +02:00
- lazy git
- lazy docker
2020-04-27 23:50:23 +02:00
2020-05-07 23:07:15 +02:00
Explanations and installation instruction can be found on my blog
2020-04-28 05:55:12 +02:00
2020-05-12 00:48:29 +02:00
## Language Servers
Since CoC doesn't support all languages in there extensions
I recommend installing some language servers from scratch
and adding them to your `coc-settings.json` file
Example:
- bash
`npm i -g bash-language-server`
```
"languageserver": {
"bash": {
"command": "bash-language-server",
"args": ["start"],
"filetypes": ["sh"],
"ignoredRootPaths": ["~"]
}
}
```
2020-08-09 00:53:34 +02:00
## For FAR to work
```
:UpdateRemotePlugins
```
2020-08-08 01:14:45 +02:00
## TabNine
2020-08-29 18:31:23 +02:00
To use TabNine enter the following in a buffer:
2020-08-08 01:14:45 +02:00
```
TabNine::config
```
2020-08-29 18:31:23 +02:00
**NOTE** This extension can take up a ton of memory
2020-08-08 07:47:57 +02:00
## Vim Gists
To use **vim-gists** you will need to configure the following:
```
git config --global github.user <username>
```
2020-08-29 18:31:23 +02:00
## VSCodium & Neo Vim Extension
[VSCodium](https://github.com/VSCodium/vscodium) contains build files to generate free release binaries of Microsoft's VS Code.
You can install it on multiple platforms:
- Mac
```
brew cask install vscodium
```
- Arch
```
yay -s vscodium-bin
```
- Snap
```
snap install codium
```
[The Neo Vim Extension](https://github.com/asvetliakov/vscode-neovim) is available in the VSCode marketplace
I recommend using this alongside the VSCode `which-key` extension
Along with some of my config files you can find in `utils/vscode_config`
2020-05-12 05:52:49 +02:00
## TODO
2020-05-10 19:52:08 +02:00
2020-08-10 22:34:17 +02:00
- Better Documentation
2020-08-29 18:31:23 +02:00
- Improve VSCode which-key config
2020-08-07 17:51:01 +02:00
2020-08-08 03:39:24 +02:00
## CoC extensions to check out
2020-08-07 17:51:01 +02:00
2020-08-07 09:35:14 +02:00
- coc-fzf
- coc-stylelintplus
- coc-floaterm
- coc-actions
- coc-bookmark
2020-08-07 10:06:46 +02:00
## 0.5
- native lsp
- treesitter
2020-05-12 05:52:49 +02:00
2020-08-10 22:34:17 +02:00
## LOW PRIORITY TODO
2020-05-12 05:52:49 +02:00
2020-08-10 22:34:17 +02:00
If anyone reading this has any suggestions about implementing any of the following I will accept a PR, but these are not priority.
- ale
- multiple cursors
- markdown table
- spaceline (add colorscheme for mach2)
- tpope/vim-dadbod
- neovide
- People asked about vimwiki I kinda hate it but maybe I'll add it
- vimspector this is included but I don't plan on using it much
- can be used with jdb, pdb, gdb, etc...
- later manually link pylance
- resize with arrows in addition to meta
- how to support meta key on for macOS?