mirror of
https://github.com/LunarVim/LunarVim.git
synced 2024-09-21 02:55:09 +02:00
518b1d4167
* fix: make navim-navic configurable * fix: make sure vim-illuminate is configurable * fix: make sure theme is configurable * fix(ci): don't verify uninstalled plugins * refactor(lsp): add setup_document_symbols util * revert: keep onedarker on freeze branch * refactor(lsp): avoid duplicate hl autocmds Co-authored-by: kylo252 <59826753+kylo252@users.noreply.github.com>
169 lines
5.9 KiB
Markdown
169 lines
5.9 KiB
Markdown
![lunarvim_logo_dark](https://user-images.githubusercontent.com/59826753/159940098-54284f26-f1da-4481-8b03-1deb34c57533.png)
|
|
|
|
<div align="center"><p>
|
|
<a href="https://github.com/lunarvim/LunarVim/releases/latest">
|
|
<img alt="Latest release" src="https://img.shields.io/github/v/release/lunarvim/LunarVim" />
|
|
</a>
|
|
<a href="https://github.com/lunarvim/LunarVim/pulse">
|
|
<img alt="Last commit" src="https://img.shields.io/github/last-commit/lunarvim/LunarVim"/>
|
|
</a>
|
|
<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"
|
|
/>
|
|
<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>
|
|
</p>
|
|
|
|
</div>
|
|
|
|
## 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)
|
|
|
|
![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)
|
|
|
|
## Install In One Command!
|
|
|
|
Make sure you have the release version of Neovim (0.7+).
|
|
|
|
### Linux/MacOS:
|
|
|
|
If you are running Neovim 0.7+
|
|
|
|
```bash
|
|
bash <(curl -s https://raw.githubusercontent.com/lunarvim/lunarvim/master/utils/installer/install.sh)
|
|
```
|
|
|
|
If you are running Neovim 0.8+
|
|
|
|
```bash
|
|
bash <(curl -s https://raw.githubusercontent.com/lunarvim/lunarvim/rolling/utils/installer/install.sh)
|
|
```
|
|
|
|
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.
|
|
|
|
In the same way, you can use `--no-install-dependencies` to skip the dependency installation.
|
|
|
|
### 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)
|
|
|
|
```powershell
|
|
Invoke-WebRequest https://raw.githubusercontent.com/LunarVim/LunarVim/master/utils/installer/install.ps1 -UseBasicParsing | Invoke-Expression
|
|
```
|
|
|
|
## Automatic LSP support
|
|
|
|
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.
|
|
|
|
## Configuration file
|
|
|
|
To install plugins configure LunarVim use the `config.lua` located here: `~/.config/lvim/config.lua`
|
|
|
|
Example:
|
|
|
|
```lua
|
|
-- general
|
|
lvim.format_on_save = true
|
|
lvim.colorscheme = "tokyonight"
|
|
|
|
lvim.leader = "space"
|
|
-- 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>"
|
|
-- set keymap with custom opts
|
|
-- lvim.keys.insert_mode["po"] = {'<ESC>', { noremap = true }}
|
|
|
|
-- Use which-key to add extra bindings with the leader-key prefix
|
|
-- lvim.builtin.which_key.mappings["P"] = { "<cmd>Telescope projects<CR>", "Projects" }
|
|
|
|
-- Configure builtin plugins
|
|
lvim.builtin.alpha.active = true
|
|
lvim.builtin.notify.active = true
|
|
lvim.builtin.terminal.active = true
|
|
|
|
-- Treesitter parsers change this to a table of the languages you want i.e. {"java", "python", javascript}
|
|
lvim.builtin.treesitter.ensure_installed = "maintained"
|
|
lvim.builtin.treesitter.ignore_install = { "haskell" }
|
|
|
|
-- Disable virtual text
|
|
lvim.lsp.diagnostics.virtual_text = false
|
|
|
|
-- Select which servers should be configured manually. Requires `:LvimCacheReset` to take effect.
|
|
-- See the full default list `:lua print(vim.inspect(lvim.lsp.override))`
|
|
vim.list_extend(lvim.lsp.automatic_configuration.skipped_servers, { "pyright" })
|
|
|
|
-- set a formatter, this will override the language server formatting capabilities (if it exists)
|
|
local formatters = require "lvim.lsp.null-ls.formatters"
|
|
formatters.setup {
|
|
{ command = "black" },
|
|
{
|
|
command = "prettier",
|
|
---@usage specify which filetypes to enable. By default, providers will attach to all the filetypes it supports.
|
|
filetypes = { "typescript", "typescriptreact" },
|
|
},
|
|
}
|
|
|
|
-- set additional linters
|
|
local linters = require "lvim.lsp.null-ls.linters"
|
|
linters.setup {
|
|
{
|
|
command = "eslint_d",
|
|
---@usage specify which filetypes to enable. By default, providers will attach to all the filetypes it supports.
|
|
filetypes = { "javascript", "javascriptreact" },
|
|
},
|
|
}
|
|
|
|
-- Additional Plugins
|
|
lvim.plugins = {
|
|
{"lunarvim/colorschemes"},
|
|
{
|
|
"ray-x/lsp_signature.nvim",
|
|
config = function() require"lsp_signature".on_attach() end,
|
|
event = "BufRead"
|
|
}
|
|
}
|
|
```
|
|
|
|
## Updating LunarVim
|
|
|
|
- inside LunarVim `:LvimUpdate`
|
|
- from the command-line `lvim +LvimUpdate +q`
|
|
|
|
### Update the plugins
|
|
|
|
- inside LunarVim `:PackerUpdate`
|
|
|
|
## Resources
|
|
|
|
- [Documentation](https://www.lunarvim.org)
|
|
|
|
- [YouTube](https://www.youtube.com/channel/UCS97tchJDq17Qms3cux8wcA)
|
|
|
|
- [Discord](https://discord.gg/Xb9B4Ny)
|
|
|
|
- [Twitter](https://twitter.com/chrisatmachine)
|
|
|
|
## Testimonials
|
|
|
|
> "I have the processing power of a potato with 4 gb of ram and LunarVim runs perfectly."
|
|
>
|
|
> - @juanCortelezzi, LunarVim user.
|
|
|
|
> "My minimal config with a good amount less code than LunarVim loads 40ms slower. Time to switch."
|
|
>
|
|
> - @mvllow, Potential LunarVim user.
|
|
|
|
<div align="center" id="madewithlua">
|
|
|
|
[![Lua](https://img.shields.io/badge/Made%20with%20Lua-blue.svg?style=for-the-badge&logo=lua)](#madewithlua)
|
|
|
|
</div>
|