2021-06-30 06:55:40 +02:00
![LunarVim Demo ](./utils/media/lunarvim_logo_dark.png )
2021-05-04 23:55:45 +02:00
2021-06-30 20:28:26 +02:00
< div align = "center" > < p >
< a href = "https://github.com/ChristianChiarulli/LunarVim/releases/latest" >
< img alt = "Latest release" src = "https://img.shields.io/github/v/release/ChristianChiarulli/LunarVim" / >
< / a >
< a href = "https://github.com/ChristianChiarulli/LunarVim/pulse" >
< img alt = "Last commit" src = "https://img.shields.io/github/last-commit/ChristianChiarulli/LunarVim" / >
< / a >
2021-07-06 16:02:40 +02:00
< a href = "https://github.com/ChristianChiarulli/LunarVim/blob/main/LICENSE" >
< img src = "https://img.shields.io/github/license/siduck76/NvChad?style=flat-square&logo=GNU&label=License" alt = "License"
/>
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-07-06 16:02:40 +02:00
< / p >
2021-06-30 20:28:26 +02:00
< / div >
2021-03-27 19:32:45 +01:00
2021-07-03 02:58:53 +02:00
## Install In One Command!
2021-04-29 07:36:13 +02:00
2021-05-04 23:55:45 +02:00
Make sure you have the newest version of Neovim (0.5).
2021-04-29 07:36:13 +02:00
2021-05-04 23:55:45 +02:00
``` bash
2021-07-09 00:40:30 +02:00
bash < (curl -s https://raw.githubusercontent.com/ChristianChiarulli/lunarvim/master/utils/installer/install.sh)
2021-03-15 03:25:28 +01:00
```
2021-05-04 23:55:45 +02:00
2021-07-20 12:12:51 +02:00
### Installing
2021-07-20 14:55:13 +02:00
The following command installs LunarVim. Change `LVBRANCH` to the branch you'd like to install. `master` for the stable branch and `rolling` for the latest changes.
2021-07-11 01:25:35 +02:00
``` bash
2021-07-11 20:44:34 +02:00
LVBRANCH=rolling bash < (curl -s https://raw.githubusercontent.com/ChristianChiarulli/lunarvim/rolling/utils/installer/install.sh)
2021-07-11 01:25:35 +02:00
```
2021-07-20 12:12:51 +02:00
### BREAKING CHANGE on the rolling branch
2021-07-20 16:42:03 +02:00
* The latest changes to LunarVim require you to [remove it completely ](https://github.com/ChristianChiarulli/LunarVim/wiki/Uninstalling-LunarVim ) before upgrading
2021-07-20 14:55:13 +02:00
* Going forward LunarVim will no longer reside in the nvim configuration folder. LunarVim has been moved to `~/.local/share/lunarvim` .
* To launch Lunarvim use the new `lvim` command. `nvim` will only launch standard neovim.
* Your personal configuration file (`lv-config.lua`) can now be found in `~/.config/lvim` . You can initialize this folder as a git repository to track changes to your configuration files.
2021-07-20 12:12:51 +02:00
### Fixing installation problems
2021-07-13 17:27:38 +02:00
If your installation is stuck on `Ok to remove? [y/N]` , it means there are some leftovers, \
2021-07-18 14:09:26 +02:00
you can run the script with `--overwrite` but be warned this will remove the following folders:
2021-07-13 17:27:38 +02:00
- `~/.cache/nvim`
2021-07-20 13:38:00 +02:00
- `~/.config/nvim` #Removed only on Master Branch
- `~/.local/share/nvim/site/pack/packer` #Removed only on Master Branch
- `~/.local/share/lunarvim` #Removed only on Rolling Branch
2021-07-13 17:27:38 +02:00
```bash
2021-07-16 07:39:13 +02:00
curl -s https://raw.githubusercontent.com/ChristianChiarulli/lunarvim/rolling/utils/installer/install.sh | LVBRANCH=rolling bash -s -- --overwrite
2021-07-13 17:27:38 +02:00
```
2021-07-18 19:50:17 +02:00
then run nvim and wait for treesitter to finish the installation
2021-07-13 17:27:38 +02:00
2021-07-11 01:25:35 +02:00
2021-07-03 02:58:53 +02:00
## Installing LSP for your language
2021-04-29 07:36:13 +02:00
2021-07-03 02:58:53 +02:00
Just enter `:LspInstall` followed by `<TAB>` to see your options
2021-05-04 23:55:45 +02:00
2021-07-09 00:40:30 +02:00
**NOTE** I recommend installing `lua` for autocomplete in `lv-config.lua`
2021-04-29 07:36:13 +02:00
2021-07-20 12:12:51 +02:00
For the julia language server look [here ](https://github.com/ChristianChiarulli/LunarVim/wiki/Enabling-a-language-server#julia-support )
2021-07-03 02:58:53 +02:00
## Configuration file
2021-04-29 07:36:13 +02:00
2021-07-20 12:12:51 +02:00
To activate other plugins and language features use the `lv-config.lua` file provided in the `nvim` folder (`~/.config/nvim/lv-config.lua`) in the master branch or (`~/.config/lvim/lv-config.lua`) on rolling
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
-- O is the global options object
2021-06-26 20:22:50 +02:00
2021-07-03 02:58:53 +02:00
-- THESE ARE EXAMPLE CONFIGS FEEL FREE TO CHANGE TO WHATEVER YOU WANT
-- general
2021-07-17 15:30:36 +02:00
-- O.format_on_save = false -- to disbale formatting on save
-- O.lint_on_save = false -- to disable formatting on save
2021-07-10 15:27:55 +02:00
O.completion.autocomplete = true
O.default_options.relativenumber = true
2021-07-03 02:58:53 +02:00
O.colorscheme = 'spacegray'
2021-07-10 15:27:55 +02:00
O.default_options.timeoutlen = 100
2021-07-18 19:49:41 +02:00
-- keymappings
O.keys.leader_key = "space"
-- overwrite the key-mappings provided by LunarVim for any mode, or leave it empty to keep them
O.keys.normal_mode = {
-- Page down/up
{'[d', '< PageUp > '},
{']d', '< PageDown > '},
-- Navigate buffers
{'< Tab > ', ':bnext< CR > '},
{'< S-Tab > ', ':bprevious< CR > '},
}
-- if you just want to augment the existing ones then use the utility function
require("lv-utils").add_keymap_insert_mode({ silent = true }, {
{ "< C-s > ", ":w< cr > " },
{ "< C-c > ", "< ESC > " }
})
-- you can also use the native vim way directly
vim.api.nvim_set_keymap("i", "< C-Space > ", "compe#complete()", { noremap = true, silent = true, expr = true })
2021-04-29 19:28:10 +02:00
2021-07-03 02:58:53 +02:00
-- After changing plugin config it is recommended to run :PackerCompile
2021-07-08 07:36:44 +02:00
O.plugin.dashboard.active = true
2021-07-15 05:15:12 +02:00
O.plugin.terminal.active = true
2021-07-03 02:58:53 +02:00
O.plugin.zen.active = true
2021-06-26 20:22:50 +02:00
2021-07-03 02:58:53 +02:00
-- if you don't want all the parsers change this to a table of the ones you want
O.treesitter.ensure_installed = "all"
O.treesitter.ignore_install = {"haskell"}
O.treesitter.highlight.enabled = true
2021-04-29 19:28:10 +02:00
2021-07-03 02:58:53 +02:00
-- lua
O.lang.lua.autoformat = false
O.lang.lua.formatter = 'lua-format'
2021-06-26 20:22:50 +02:00
2021-07-03 02:58:53 +02:00
-- javascript
O.lang.tsserver.formatter = 'prettier'
O.lang.tsserver.linter = nil
O.lang.tsserver.autoformat = true
2021-04-29 19:28:10 +02:00
2021-07-08 07:36:44 +02:00
-- python
O.lang.python.diagnostics.virtual_text = true
O.lang.python.analysis.use_library_code_types = true
2021-07-12 07:57:38 +02:00
-- to change default formatter from yapf to black
-- O.lang.python.formatter.exe = "black"
-- O.lang.python.formatter.args = {"-"}
2021-07-17 15:30:36 +02:00
-- To change enabled linters
-- https://github.com/mfussenegger/nvim-lint#available-linters
-- O.lang.python.linters = { "flake8", "pylint", "mypy", ... }
2021-07-12 07:57:38 +02:00
-- go
2021-07-12 08:36:39 +02:00
-- to change default formatter from gofmt to goimports
-- O.lang.formatter.go.exe = "goimports"
2021-07-07 08:36:56 +02:00
-- Additional Plugins
2021-07-08 07:36:44 +02:00
-- O.user_plugins = {
2021-07-12 17:54:13 +02:00
-- {"folke/tokyonight.nvim"},
-- {
-- "ray-x/lsp_signature.nvim",
-- config = function()
-- require"lsp_signature".on_attach()
-- end,
-- event = "InsertEnter"
-- },
-- }
2021-07-08 07:36:44 +02:00
-- }
2021-07-07 08:36:56 +02:00
-- Autocommands (https://neovim.io/doc/user/autocmd.html)
-- O.user_autocommands = {{ "BufWinEnter", "*", "echo \"hi again\""}}
-- Additional Leader bindings for WhichKey
-- O.user_which_key = {
-- A = {
-- name = "+Custom Leader Keys",
-- a = { "< cmd > echo 'first custom command'< cr > ", "Description for a" },
-- b = { "< cmd > echo 'second custom command'< cr > ", "Description for b" },
-- },
-- }
2021-07-12 17:54:13 +02:00
-- To link your init.vim (until you find Lua replacements)
-- vim.cmd('source ' .. CONFIG_PATH .. '/lua/lv-user/init.vim')
2021-04-29 19:28:10 +02:00
```
2021-07-18 19:57:05 +02:00
In case you want to see all the settings inside LunarVim, run the following:
```bash
cd ~/.config/nvim
nvim --headless +'lua require("lv-utils").generate_settings()' +qa & & sort -o lv-settings.lua{,}
```
and then inspect `~/.config/nvim/lv-settings.lua` file
2021-07-03 02:58:53 +02:00
## Updating LunarVim
2021-03-26 22:02:27 +01:00
2021-07-03 02:58:53 +02:00
In order to update you should be aware of three things `Plugins` , `LunarVim` and `Neovim`
2021-03-26 05:58:18 +01:00
2021-07-03 02:58:53 +02:00
To update plugins:
2021-05-04 23:55:45 +02:00
2021-05-03 02:13:09 +02:00
```
2021-07-03 02:58:53 +02:00
:PackerUpdate
2021-05-03 02:13:09 +02:00
```
2021-03-23 03:09:11 +01:00
2021-07-03 02:58:53 +02:00
To update LunarVim:
2021-05-03 02:13:09 +02:00
2021-07-08 07:36:44 +02:00
```bash
2021-07-20 12:12:51 +02:00
# Master Branch
2021-07-03 02:58:53 +02:00
cd ~/.config/nvim & & git pull
2021-07-20 12:12:51 +02:00
:PackerSync
# Rolling Branch
cd ~/.local/share/lunarvim & & git pull
:PackerSync
2021-05-03 02:14:39 +02:00
```
2021-04-29 07:36:13 +02:00
2021-07-20 12:12:51 +02:00
To update Neovim use your package manager or [compile from source ](https://github.com/ChristianChiarulli/LunarVim/wiki/Installation#get-the-latest-version-of-neovim )
2021-07-09 00:40:30 +02:00
2021-07-12 14:10:53 +02:00
## Project Goals
1. Provide basic functionalities required from an IDE
2021-07-12 17:54:13 +02:00
- LSP
- Formatting/Linting
- Debugging
- Treesitter
- Colorschemes
2021-07-12 14:10:53 +02:00
2. Be as fast and lean as possible
2021-07-12 17:54:13 +02:00
- Lazy loading
- Not a single extra plugin
- User configurable lang/feature enable/disable
2021-07-12 14:10:53 +02:00
3. Provide a [simple and easy ](https://github.com/LunarVim/LunarVimCommunity ) way for users to share their own configuration or use others.
4. Hot reload of configurations
2021-07-12 17:54:13 +02:00
- Hot install of lsp/treesitter/formatter required upon openning a filetype for the first time
2021-07-12 14:10:53 +02:00
5. Provide a stable & maintainable error free configuration layer over neovim
2021-07-12 17:54:13 +02:00
- With the help of the community behind it
- Github workflow testing
- Freezing plugin versions
2021-07-12 14:10:53 +02:00
6. Provide detailed documentation
2021-07-12 17:54:13 +02:00
- Video series on how to configure LunarVim as an IDE for each lang
2021-07-12 14:10:53 +02:00
7. Valhalla
2021-07-03 02:58:53 +02:00
## Resources
2021-04-04 23:21:57 +02:00
2021-07-03 02:58:53 +02:00
- [YouTube ](https://www.youtube.com/channel/UCS97tchJDq17Qms3cux8wcA )
2021-03-23 03:09:11 +01:00
2021-07-03 02:58:53 +02:00
- [Wiki ](https://github.com/ChristianChiarulli/LunarVim/wiki )
2021-03-27 01:28:08 +01:00
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."
> - @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."
> - @mvllow, Potential LunarVim user.
2021-07-13 03:57:12 +02:00
< div align = "center" id = "madewithlua" >
2021-07-06 15:50:53 +02: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)
2021-07-06 15:50:53 +02:00
< / div >