Why does this repo exist?
This config attempts to provide a rock solid fully featured starting point for someone new to Neovim, or just tired of maintaining the basic IDE components of their config.
What makes it "rock solid"?
All the included plugins are pinned to a version that ensures they are compatible and will not update potentially introducing errors into your config. For every Neovim release I will update this repo along with the community to keep it up to date with the newest versions.
As I mentioned, this config is meant as a starting point for people new to Neovim who want a familiar IDE experience. The config has a very simple structure that makes it easy to add new plugins.
You can install Neovim with your package manager e.g. brew, apt, pacman etc.. but remember that when you update your packages Neovim may be upgraded to a newer version.
If you would like to make sure Neovim only updates when you want it to than I recommend installing from source:
NOTE Verify the required build prerequisites for your system.
git clone https://github.com/neovim/neovim.git
cd neovim
git checkout release-0.9
make CMAKE_BUILD_TYPE=Release
sudo make install
Make sure to remove or backup your current nvim
directory
git clone https://github.com/LunarVim/nvim-basic-ide.git ~/.config/nvim
Run nvim
and wait for the plugins to be installed
NOTE (You will notice treesitter pulling in a bunch of parsers the next time you open Neovim)
NOTE Checkout this file for some predefined keymaps: keymaps
Open nvim
and enter the following:
:checkhealth
You'll probably notice you don't have support for copy/paste also that python and node haven't been setup
So let's fix that
First we'll fix copy/paste
-
On mac
pbcopy
should be builtin -
On Ubuntu
sudo apt install xsel # for X11 sudo apt install wl-clipboard # for wayland
Next we need to install python support (node is optional)
-
Neovim python support
pip install pynvim
-
Neovim node support
npm i -g neovim
We will also need ripgrep
for Telescope to work:
-
Ripgrep
sudo apt install ripgrep
NOTE make sure you have node installed, I recommend a node manager like fnm.
I recommend using the following repo to get a "Nerd Font" (Font that supports icons)
To add a new LSP
First Enter:
:Mason
and press i
on the Language Server you wish to install
Next you will need to add the server to this list: servers Note: Builtin LSP doesn't contain all lsps from nvim-lspconfig.
If you want to install any from there, for example terraform_lsp(which adds more functionality than terraformls, like complete resource listing),
- You can add the lsp name in mason lsp block
-- lua/utils/init.lua
M.servers = {
"lua_ls",
"cssls",
"html",
"tsserver",
"pyright",
"bashls",
"jsonls",
"yamlls",
"terraform_lsp" -- New LSP
}
- Manually install the binary of the lsp and put it in your path by downloading the binary or through your package manager. For terraform_lsp example
Make sure the formatter or linter is installed and add it to this setup function: null-ls
NOTE Some are already setup as examples, remove them if you want
You can install new plugins here: plugins
Just make a new file with your plugin and the configuration in it, Which-key file is a very good example of how you would do it.
- lazy
- plenary
- nvim-autopairs
- Comment.nvim
- nvim-ts-context-commentstring
- nvim-web-devicons
- nvim-tree.lua
- bufferline.nvim
- bufdelete.nvim
- lualine.nvim
- toggleterm.nvim
- project.nvim
- impatient.nvim
- indent-blankline.nvim
- alpha-nvim
- tokyonight.nvim
- nvim-cmp
- cmp-buffer
- cmp-path
- cmp_luasnip
- cmp-nvim-lsp
- cmp-nvim-lua
- LuaSnip
- friendly-snippets
- mason.nvim
- nvim-lspconfig
- mason-lspconfig.nvim
- null-ls.nvim
- vim-illuminate
- telescope.nvim
- nvim-treesitter
- gitsigns.nvim
- nvim-dap
- nvim-dap-ui
- DAPInstall.nvim
- which-key.nvim
The computing scientist's main challenge is not to get confused by the complexities of his own making.
- Edsger W. Dijkstra