2022-03-24 15:45:40 +01:00
![lunarvim_logo_dark ](https://user-images.githubusercontent.com/59826753/159940098-54284f26-f1da-4481-8b03-1deb34c57533.png )
2021-05-04 23:55:45 +02:00
2021-06-30 20:28:26 +02:00
< div align = "center" > < p >
2021-08-04 21:20:09 +02:00
< a href = "https://github.com/lunarvim/LunarVim/releases/latest" >
< img alt = "Latest release" src = "https://img.shields.io/github/v/release/lunarvim/LunarVim" / >
2021-06-30 20:28:26 +02:00
< / a >
2021-08-04 21:20:09 +02:00
< a href = "https://github.com/lunarvim/LunarVim/pulse" >
< img alt = "Last commit" src = "https://img.shields.io/github/last-commit/lunarvim/LunarVim" / >
2021-06-30 20:28:26 +02:00
< / a >
2021-08-04 21:20:09 +02:00
< a href = "https://github.com/lunarvim/LunarVim/blob/main/LICENSE" >
< img src = "https://img.shields.io/github/license/lunarvim/lunarvim?style=flat-square&logo=GNU&label=License" alt = "License"
2021-07-06 16:02:40 +02:00
/>
2021-06-30 20:28:26 +02:00
< a href = "https://patreon.com/chrisatmachine" title = "Donate to this project using Patreon" >
< img src = "https://img.shields.io/badge/patreon-donate-yellow.svg" alt = "Patreon donate button" / >
< / a >
< a href = "https://twitter.com/intent/follow?screen_name=chrisatmachine" >
< img src = "https://img.shields.io/twitter/follow/chrisatmachine?style=social&logo=twitter" alt = "follow on Twitter" >
< / a >
2021-10-01 13:27:06 +02:00
< / p >
2021-07-06 16:02:40 +02:00
2021-06-30 20:28:26 +02:00
< / div >
2021-03-27 19:32:45 +01:00
2022-03-24 15:45:40 +01:00
## Showcase
![intro1 ](https://user-images.githubusercontent.com/59826753/159939936-3a9a8e94-05ea-48fa-8c46-69378276451b.png )
![info ](https://user-images.githubusercontent.com/59826753/159939984-ac0190d7-a3fb-46c0-95ca-a6fec626bbac.png )
2021-05-04 23:55:45 +02:00
2022-03-24 15:45:40 +01:00
![demo1 ](https://user-images.githubusercontent.com/59826753/159940004-84975294-5703-4bf1-aa98-2cc97cb38d96.png )
![demo2 ](https://user-images.githubusercontent.com/59826753/159940040-375a0a28-4c81-4fdf-80f2-62853edf9b4f.png )
2021-08-23 17:18:42 +02:00
2021-09-02 17:22:51 +02:00
## Install In One Command!
2021-08-23 17:18:42 +02:00
2022-04-27 17:37:27 +02:00
Make sure you have the release version of Neovim (0.7+).
2021-08-23 17:18:42 +02:00
2022-03-02 15:57:14 +01:00
### Linux:
2021-10-01 13:27:06 +02:00
```bash
2021-09-02 17:22:51 +02:00
bash < (curl -s https://raw.githubusercontent.com/lunarvim/lunarvim/master/utils/installer/install.sh)
2021-07-13 17:27:38 +02:00
```
2022-03-02 15:57:14 +01:00
To run the install script without any interaction you can pass the `-y` flag to automatically install all dependencies and have no prompts. This is particularly useful in automated installations.
2022-08-19 11:53:38 +02:00
In the same way, you can use `--no-install-dependencies` to skip the dependency installation.
2022-03-02 15:57:14 +01:00
2022-03-25 15:21:32 +01:00
### Windows (Powershell 7+):
Powershell v7+ is required for this script. For instructions on how to install, [click here. ](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2 )
2022-03-02 15:57:14 +01:00
2022-02-03 08:57:59 +01:00
```powershell
Invoke-WebRequest https://raw.githubusercontent.com/LunarVim/LunarVim/master/utils/installer/install.ps1 -UseBasicParsing | Invoke-Expression
```
2022-03-24 15:45:40 +01:00
## Automatic LSP support
2021-07-11 01:25:35 +02:00
2022-08-19 11:53:38 +02:00
By default, most supported language servers will get automatically installed once you open the supported file type, e.g, opening a Python file for the first time will install `Pyright` and configure it automatically for you.
2021-09-14 18:17:31 +02:00
2021-07-03 02:58:53 +02:00
## Configuration file
2021-04-29 07:36:13 +02:00
2021-09-02 17:28:16 +02:00
To install plugins configure LunarVim use the `config.lua` located here: `~/.config/lvim/config.lua`
2021-04-29 07:36:13 +02:00
Example:
2021-05-04 23:55:45 +02:00
2021-06-26 20:22:50 +02:00
```lua
2021-07-03 02:58:53 +02:00
-- general
2021-07-25 06:42:38 +02:00
lvim.format_on_save = true
2021-08-30 07:00:58 +02:00
lvim.colorscheme = "onedarker"
2021-07-18 19:49:41 +02:00
2021-07-25 06:42:38 +02:00
lvim.leader = "space"
2021-08-02 23:42:56 +02:00
-- add your own keymapping
lvim.keys.normal_mode["< C-s > "] = ":w< cr > "
-- unmap a default keymapping
-- lvim.keys.normal_mode["< C-Up > "] = ""
-- edit a default keymapping
-- lvim.keys.normal_mode["< C-q > "] = ":q< cr > "
2021-08-03 07:04:51 +02:00
-- set keymap with custom opts
-- lvim.keys.insert_mode["po"] = {'< ESC > ', { noremap = true }}
2021-08-02 23:42:56 +02:00
-- Use which-key to add extra bindings with the leader-key prefix
2021-08-23 05:50:36 +02:00
-- lvim.builtin.which_key.mappings["P"] = { "< cmd > Telescope projects< CR > ", "Projects" }
2021-07-25 06:42:38 +02:00
2021-09-02 17:28:16 +02:00
-- Configure builtin plugins
2022-03-25 15:21:14 +01:00
lvim.builtin.alpha.active = true
2022-01-02 10:25:20 +01:00
lvim.builtin.notify.active = true
2021-07-25 06:42:38 +02:00
lvim.builtin.terminal.active = true
2021-06-26 20:22:50 +02:00
2021-09-02 17:28:16 +02:00
-- Treesitter parsers change this to a table of the languages you want i.e. {"java", "python", javascript}
2021-07-25 06:42:38 +02:00
lvim.builtin.treesitter.ensure_installed = "maintained"
lvim.builtin.treesitter.ignore_install = { "haskell" }
2021-09-02 17:28:16 +02:00
-- Disable virtual text
2021-07-25 06:42:38 +02:00
lvim.lsp.diagnostics.virtual_text = false
2021-07-07 08:36:56 +02:00
2022-03-07 10:19:25 +01:00
-- Select which servers should be configured manually. Requires `:LvimCacheReset` to take effect.
2021-10-24 12:56:56 +02:00
-- See the full default list `:lua print(vim.inspect(lvim.lsp.override))`
2022-04-14 20:49:43 +02:00
vim.list_extend(lvim.lsp.automatic_configuration.skipped_servers, { "pyright" })
2021-10-24 12:56:56 +02:00
-- set a formatter, this will override the language server formatting capabilities (if it exists)
local formatters = require "lvim.lsp.null-ls.formatters"
formatters.setup {
2022-01-08 14:24:05 +01:00
{ command = "black" },
2021-07-31 06:06:08 +02:00
{
2022-01-08 14:24:05 +01:00
command = "prettier",
2022-08-19 11:53:38 +02:00
---@usage specify which filetypes to enable. By default, providers will attach to all the filetypes it supports.
2021-10-24 12:56:56 +02:00
filetypes = { "typescript", "typescriptreact" },
},
2021-07-31 06:06:08 +02:00
}
2021-10-24 12:56:56 +02:00
-- set additional linters
local linters = require "lvim.lsp.null-ls.linters"
linters.setup {
2021-07-31 06:06:08 +02:00
{
2022-01-08 14:24:05 +01:00
command = "eslint_d",
2022-08-19 11:53:38 +02:00
---@usage specify which filetypes to enable. By default, providers will attach to all the filetypes it supports.
2021-10-24 12:56:56 +02:00
filetypes = { "javascript", "javascriptreact" },
},
2021-07-31 06:06:08 +02:00
}
2021-07-07 08:36:56 +02:00
-- Additional Plugins
2021-07-25 06:42:38 +02:00
lvim.plugins = {
{"lunarvim/colorschemes"},
{"folke/tokyonight.nvim"}, {
"ray-x/lsp_signature.nvim",
config = function() require"lsp_signature".on_attach() end,
2021-09-21 09:53:02 +02:00
event = "BufRead"
2021-07-25 06:42:38 +02:00
}
}
2021-07-18 19:57:05 +02:00
```
2021-07-03 02:58:53 +02:00
## Updating LunarVim
2021-03-26 22:02:27 +01:00
2021-10-01 13:27:06 +02:00
- inside LunarVim `:LvimUpdate`
- from the command-line `lvim +LvimUpdate +q`
2021-05-03 02:13:09 +02:00
2021-10-01 13:27:06 +02:00
### Update the plugins
2021-09-14 14:37:09 +02:00
2021-10-01 13:27:06 +02:00
- inside LunarVim `:PackerUpdate`
2021-04-29 07:36:13 +02:00
2021-10-03 22:23:13 +02:00
## Breaking changes
2021-11-06 09:23:59 +01:00
- `lvim.lang.FOO` is no longer supported. Refer to < https: // www . lunarvim . org / languages > for up-to-date instructions.
2021-12-23 10:03:15 +01:00
- `lvim.lsp.popup_border` has been deprecated in favor of `lvim.lsp.float.border` and `lvim.lsp.diagnostics.float.border` .
2022-03-19 20:02:45 +01:00
- `lvim.builtin.dashboard` has been replaced with `lvim.builtin.alpha` , see < https: // github . com / LunarVim / LunarVim / pull / 1906 >
2021-10-03 22:23:13 +02:00
2021-07-03 02:58:53 +02:00
## Resources
2021-04-04 23:21:57 +02:00
2021-07-29 14:10:21 +02:00
- [Documentation ](https://www.lunarvim.org )
2021-03-27 01:28:08 +01:00
2021-09-02 17:22:51 +02:00
- [YouTube ](https://www.youtube.com/channel/UCS97tchJDq17Qms3cux8wcA )
2021-07-03 02:58:53 +02:00
- [Discord ](https://discord.gg/Xb9B4Ny )
2021-03-22 01:59:02 +01:00
2021-07-03 02:58:53 +02:00
- [Twitter ](https://twitter.com/chrisatmachine )
2021-06-30 20:28:26 +02:00
2021-07-05 21:32:45 +02:00
## Testimonials
> "I have the processing power of a potato with 4 gb of ram and LunarVim runs perfectly."
2021-10-01 13:27:06 +02:00
>
2021-07-05 21:32:45 +02:00
> - @juanCortelezzi, LunarVim user.
2021-06-30 20:28:26 +02:00
2021-07-10 05:02:42 +02:00
> "My minimal config with a good amount less code than LunarVim loads 40ms slower. Time to switch."
2021-10-01 13:27:06 +02:00
>
2021-07-10 05:02:42 +02:00
> - @mvllow, Potential LunarVim user.
2021-07-13 03:57:12 +02:00
< div align = "center" id = "madewithlua" >
2022-03-02 15:57:14 +01:00
2021-07-13 03:57:12 +02:00
[![Lua ](https://img.shields.io/badge/Made%20with%20Lua-blue.svg?style=for-the-badge&logo=lua )](#madewithlua)
2022-03-02 15:57:14 +01:00
2021-07-06 15:50:53 +02:00
< / div >