<ahref="https://patreon.com/chrisatmachine"title="Donate to this project using Patreon"><imgsrc="https://img.shields.io/badge/patreon-donate-yellow.svg"alt="Patreon donate button"/></a>
<ahref="https://twitter.com/intent/follow?screen_name=chrisatmachine"><imgsrc="https://img.shields.io/twitter/follow/chrisatmachine?style=social&logo=twitter"alt="follow on Twitter"></a>
* This is also a community project, if you would like to see support for a feature or [language](https://github.com/neovim/nvim-lspconfig/blob/master/CONFIG.md) consider making a PR.
* This project will do it's best to include core features you would expect from a modern IDE, while making it easy to add or remove what the user wants.
LunarVim provides neovim configuration files that take advantage of tree-sitter and language server protocol. The configuration is written in lua.
## Why do I want tree-sitter and LSP?
* Normally, an editor uses regular expression parsing for things like highlighting and checking the syntax of your file. Each time you make a change, the editor must re-parse the entire file. Tree-sitter, on the other hand, transforms text into a syntax tree. Each time you make a change, only the parts of the code that change need to be parsed. This greatly improves the speed of parsing. This can make a huge difference when editing large files.
* Neovim 0.5 including language server protocol means your editor can provide: code actions, completions, formatting, navigating to definitions, renaming, etc. The language server only has to be written once and will work on any editor that supports LSP. Any improvements made to the language server will immediately be used by all editors that support LSP.
Some operating systems package versions of Neovim 0.5. You can install those or you can follow the steps below to compile from source. Compiling from source is the recommended method.
First, get the dependencies. For distributions other than Ubuntu or Arch go [here](https://github.com/neovim/neovim/wiki/Building-Neovim#build-prerequisites)
The home screen is a plugin called dashboard. It uses the Telescope plugin to find files or find words within files. The home screen provides a link to load saved Sessions. The home screen links to the settings file located at this path: ~/.config/nvim/lv-settings.lua
## Leader and Whichkey
The default leader key is set to \<Space>. Pressing it will also open up whichkey. Whichkey will help you easily access many of the default keybindings.
## Other key bindings
Other key bindings can be found in ~/.config/nvim/lua/keymappings.lua
If you already have a set of keybindings in vimscript that you prefer, source your vimscript file from ~/.config/nvim/init.lua
Or you can translate your old bindings to lua and keep them in the provided keymappings file. Follow the lua guide available [here](https://github.com/nanotee/nvim-lua-guide)
## Important Configuration files
| Path | Description |
|------|-------------|
|~/.config/nvim/lv-settings.lua | The main settings file |
Whether you plan on using LunarVim as is or as a base to configure your own neovim, the following commands may be useful. Any command that includes the symbol ':' is meant to be typed as a command in neovim. Make sure you're in normal mode not insert mode.
| Command | Description |
|------|-------------|
| :checkhealth | Check the health of your neovim install |
| :checkhealth \<pluginname> | Check the health of a plugin |
| nvim -v | checks your neovim version |
| nvim -V | vebose output when running neovim. Prints out every event |
| :PackerCompile | Must be run when you make plugin changes. (or, alternately run :PackerSync) |
| :PackerInstall | Only install missing plugins|
| :PackerUpdate | Update and install plugins |
|:PackerClean | Remove any disabled or unused plugins |
|:PackerSync | Performs 'PackerClean' then 'PackerUpdate' |
|:PackerStatus | List the status of your plugins |
|:LspInstall \<language> | Install a language server for a specific programming language |
| :LspInfo | List the status of active and configured language servers|
|:LspStart \<language> | Start the requested server name. Will only succesfully start if the command detects a root directory matching the current config. Pass autostart = false to your .setup{} call for a language server if you would like to launch clients solely with this command. Defaults to all servers matching current buffer filetype. |
|:LspStop | Stops all buffer clients|
|:LspRestart | Restarts all buffer clients|
|:map | List keybindings |
|:nmap | List normal mode keybindings |
|:vmap | List visual mode keybindings |
|:imap | List insert mode keybindings |
|:verbose imap \<keybinding> | Print out what a particular keybinding is mapped to|
|:messages | Print error messages. Useful when messages get cut off|