LunarVim

https://www.lunarvim.org/docs/
Admin
LunarVim is a preconfigured Neovim IDE that provides an enhanced editing experience with integrated...
Tokens:27,231
Snippets:458
Trust Score:8.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Manual Language Server Setup Example

Source: https://www.lunarvim.org/docs/configuration/language-features/language-servers

Example of manually setting up the `sumneko_lua` language server with specific options, like disabling hints, within the ftplugin file.

```lua
-- $LUNARVIM_CONFIG_DIR/ftplugin/lua.lua  
local opts = {
  settings = {
    Lua = { hint = { enable = false } },
  },
}
require("lvim.lsp.manager").setup("sumneko_lua", opts)

```

--------------------------------

### Install telescope-project.nvim

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install the telescope-project.nvim plugin for easy project switching. It requires `packadd telescope.nvim` to be called during setup.

```lua
{
  "nvim-telescope/telescope-project.nvim",
  event = "BufWinEnter",
  setup = function()
    vim.cmd [[packadd telescope.nvim]]
  end,
},
```

--------------------------------

### Install lush.nvim

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install lush.nvim, a plugin designed to aid in colorscheme creation.

```lua
{
  "rktjmp/lush.nvim",
},
```

--------------------------------

### Switch to LunarVim Development Setup

Source: https://www.lunarvim.org/docs/dev

Move the current LunarVim installation to a backup and rename your development symlink to the active LunarVim directory. This activates your development environment.

```bash
cd ~/.local/share/lunarvim/  
mv lvim lvim_back  
mv lvim_dev lvim  
```

--------------------------------

### Install Swift Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/swift

Use this command to install the syntax highlighting plugin for Swift files.

```vim
:TSInstall swift  

```

--------------------------------

### Install Scala Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/scala

Use this command to install the syntax highlighting for Scala files.

```vim
:TSInstall scala  

```

--------------------------------

### Install Vim Sanegx Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install the vim-sanegx plugin to open URLs using the 'gx' command.

```lua
{
  "felipec/vim-sanegx",
  event = "BufRead",
},

```

--------------------------------

### Install Java Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/java

Use this command to install the syntax highlighting for Java files.

```vim
:TSInstall java  

```

--------------------------------

### Install telescope-fzy-native.nvim

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install the telescope-fzy-native.nvim plugin, which provides an fzy-style sorter compiled for performance. It is set to build using 'make'.

```lua
{
  "nvim-telescope/telescope-fzy-native.nvim",
  build = "make",
  event = "BufRead",
},
```

--------------------------------

### Install C Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/c_cpp

Use this command to install syntax highlighting for C files.

```vim
:TSInstall c  

```

--------------------------------

### Configure Language Server Settings Example

Source: https://www.lunarvim.org/docs/configuration/language-features/language-servers

Example of setting specific configurations for a language server, such as disabling hints for Lua. This configuration is persistent.

```json
{
  "Lua.hint.enable": false
}

```

--------------------------------

### Manually Install a Language Server

Source: https://www.lunarvim.org/docs/configuration/language-features/language-servers

Use this command to manually install a specific language server. Refer to `mason` for a full list of available servers.

```vim
:LspInstall `<your_language_server>`  

```

--------------------------------

### Copy Sample Configuration

Source: https://www.lunarvim.org/docs/configuration

Copy the example configuration file to your user's config directory to begin customization.

```bash
cp ~/.local/share/lunarvim/lvim/utils/installer/config.example.lua ~/.config/lvim/config.lua  
```

--------------------------------

### Install Vim Repeat Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install the vim-repeat plugin to enable repeating supported plugin maps with the '.' command.

```lua
{ "tpope/vim-repeat" },

```

--------------------------------

### Configure glow.nvim Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install the glow.nvim plugin for previewing markdown files in Neovim. Requires the 'glow' executable to be installed globally.

```lua
-- You must install glow globally
-- https://github.com/charmbracelet/glow
-- yay -S glow
{
  "npxbr/glow.nvim",
  ft = {"markdown"}
  -- build = "yay -S glow"
},
```

--------------------------------

### Install JavaScript Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/javascript

Use this command to install the Tree-sitter parser for JavaScript syntax highlighting. Ensure you have Tree-sitter installed.

```vim
:TSInstall javascript  

```

--------------------------------

### Configure copilot.lua and copilot-cmp

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install and set up copilot.lua and copilot-cmp for AI-assisted coding. Ensure authentication is completed after installation.

```lua
table.insert(lvim.plugins, {
  "zbirenbaum/copilot-cmp",
  event = "InsertEnter",
  dependencies = { "zbirenbaum/copilot.lua" },
  config = function()
    vim.defer_fn(function ()
      require("copilot").setup() -- https://github.com/zbirenbaum/copilot.lua/blob/master/README.md#setup-and-configuration
      require("copilot_cmp").setup() -- https://github.com/zbirenbaum/copilot-cmp/blob/master/README.md#configuration
    end, 100)
  end,
})
```

--------------------------------

### Configure markdown-preview.nvim Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install and configure markdown-preview.nvim to preview markdown files in a web browser. Includes automatic startup.

```lua
{
  "iamcco/markdown-preview.nvim",
  build = "cd app && npm install",
  ft = "markdown",
  config = function()
    vim.g.mkdp_auto_start = 1
  end,
},
```

--------------------------------

### Install SourceKit Language Server

Source: https://www.lunarvim.org/docs/features/supported-languages/swift

Install the 'sourcekit' language server to enable code completion, diagnostics, and other language features for Swift.

```vim
:LspInstall sourcekit  

```

--------------------------------

### Install PowerShell Parser

Source: https://www.lunarvim.org/docs/features/supported-languages/powershell

After configuring the parser, run this command in Neovim to install the PowerShell parser.

```vim
:TSInstall powershell

```

--------------------------------

### Install C++ Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/c_cpp

Use this command to install syntax highlighting for C++ files.

```vim
:TSInstall cpp  

```

--------------------------------

### Install QML Syntax Highlighting Plugin

Source: https://www.lunarvim.org/docs/features/supported-languages/qml

Use this configuration to install the vim-qml plugin for QML syntax highlighting. Ensure the plugin is loaded for QML files.

```lua
{
  "peterhoeg/vim-qml",
  event = "BufRead",
  ft = { "qml" },
}
```

--------------------------------

### Configure codi.vim Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install the codi.vim plugin, an interactive scratchpad for developers.

```lua
{
  "metakirby5/codi.vim",
  cmd = "Codi",
},
```

--------------------------------

### Install Go Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/go

Use this command to install the Go syntax highlighting plugin for LunarVim. Ensure you have the necessary plugin manager configured.

```vim
:TSInstall go  

```

--------------------------------

### Install Lua Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/lua

Use this command to install the Lua syntax highlighting plugin via Treesitter.

```vim
:TSInstall lua  

```

--------------------------------

### Install Vue Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-frameworks/vue

Use this command to install the Tree-sitter grammar for Vue.js syntax highlighting.

```vim
:TSInstall vue  

```

--------------------------------

### Install Rust Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/rust

Use this command to install the Rust syntax highlighting plugin for LunarVim.

```vim
:TSInstall rust  

```

--------------------------------

### Install JSON Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/json

Use this command to install the JSON Treesitter parser for syntax highlighting.

```vim
:TSInstall json  

```

--------------------------------

### Revert to LunarVim Stable Setup

Source: https://www.lunarvim.org/docs/dev

Restore the stable LunarVim installation by moving the development version back to backup and renaming the original stable version back to 'lvim'.

```bash
cd ~/.local/share/lunarvim/  
mv lvim lvim_dev  
mv lvim_back lvim  
```

--------------------------------

### Configure Example Neovim Options

Source: https://www.lunarvim.org/docs/configuration/options

Set common Neovim options for customizing the editor's behavior, such as command line height, font, indentation, line numbering, and line wrapping.

```lua
vim.opt.cmdheight = 2 -- more space in the neovim command line for displaying messages  
vim.opt.guifont = "monospace:h17" -- the font used in graphical neovim applications  
vim.opt.shiftwidth = 2 -- the number of spaces inserted for each indentation  
vim.opt.tabstop = 2 -- insert 2 spaces for a tab  
vim.opt.relativenumber = true -- relative line numbers  
vim.opt.wrap = true -- wrap lines  
  
-- use treesitter folding  
vim.opt.foldmethod = "expr"  
vim.opt.foldexpr = "nvim_treesitter#foldexpr()"  
```

--------------------------------

### Install cmp-tabnine

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install the cmp-tabnine plugin, which provides TabNine completion capabilities for nvim-cmp. It requires a build step and is set to trigger on InsertEnter events.

```lua
{
  "tzachar/cmp-tabnine",
  build = "./install.sh",
  dependencies = "hrsh7th/nvim-cmp",
  event = "InsertEnter",
},
```

--------------------------------

### Install Vim Wakatime Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install the vim-wakatime plugin for automatic metrics, insights, and time tracking based on programming activity. Requires API key configuration via :WakaTimeApiKey.

```lua
{
  "wakatime/vim-wakatime"
}

```

--------------------------------

### Disable Automatic Language Server Installation

Source: https://www.lunarvim.org/docs/configuration/language-features/language-servers

Set this option to `false` to prevent language servers from being automatically installed when opening a supported file type. Manual installation via `:LspInstall` or `:Mason` will be required.

```lua
lvim.lsp.automatic_servers_installation = false  

```

--------------------------------

### Install Julia Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/julia

Use this command to install the syntax highlighting for Julia files within LunarVim.

```vim
:TSInstall julia  

```

--------------------------------

### Configure symbols-outline.nvim Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install and set up the symbols-outline.nvim plugin for a tree-like view of symbols.

```lua
{
  "simrat39/symbols-outline.nvim",
  config = function()
    require('symbols-outline').setup()
  end,
},
```

--------------------------------

### Configure neuron.nvim Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install the neuron.nvim plugin for next-generation note-taking.

```lua
 {
  "oberblastmeister/neuron.nvim"},

```

--------------------------------

### Configure trouble.nvim Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install the trouble.nvim plugin for managing diagnostics, references, and other lists. Keybindings are defined separately.

```lua
{
  "folke/trouble.nvim",
    cmd = "TroubleToggle",
},
```

--------------------------------

### Install Vim Surround Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install the vim-surround plugin for mappings to delete, change, and add surroundings. Note that `timeoutlen` might need adjustment.

```lua
{
  "tpope/vim-surround",

  -- make sure to change the value of `timeoutlen` if it's not triggering correctly, see https://github.com/tpope/vim-surround/issues/117
  -- setup = function()
    --  vim.o.timeoutlen = 500
  -- end
},

```

--------------------------------

### Install Ruby Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/ruby

Use this command to install the syntax highlighting for Ruby files within LunarVim.

```vim
:TSInstall ruby  

```

--------------------------------

### Setup Formatters, Linters, and Code Actions

Source: https://www.lunarvim.org/docs/configuration/language-features/linting-and-formatting

Configure built-in formatters, linters, and code actions using null-ls. Specify formatter names, arguments, and filetypes. Linters can be configured with specific arguments and severity levels.

```lua
local formatters = require "lvim.lsp.null-ls.formatters"  
formatters.setup {  
  { name = "black" },  
  {  
    name = "prettier",  
    ---@usage arguments to pass to the formatter  
    -- these cannot contain whitespace  
    -- options such as `--line-width 80` become either `{"--line-width", "80"}` or `{"--line-width=80"}`  
    args = { "--print-width", "100" },  
    ---@usage only start in these filetypes, by default it will attach to all filetypes it supports  
    filetypes = { "typescript", "typescriptreact" },  
  },  
}  
  
local linters = require "lvim.lsp.null-ls.linters"  
linters.setup {  
  { name = "flake8" },  
  {  
    name = "shellcheck",  
    args = { "--severity", "warning" },  
  },  
}  
  
local code_actions = require "lvim.lsp.null-ls.code_actions"  
code_actions.setup {  
  {  
    name = "proselint",  
  },  
}
```

--------------------------------

### Install Python Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/python

Use this command to install syntax highlighting for Python files within LunarVim.

```vim
:TSInstall python  

```

--------------------------------

### Install Angular Language Server

Source: https://www.lunarvim.org/docs/features/supported-frameworks/angular

Use this command to install the Angular language server (angularls) via LunarVim's LSP manager.

```vim
:LspInstall angularls
```

--------------------------------

### Configure clang-format for Java

Source: https://www.lunarvim.org/docs/features/supported-languages/java

Set up clang-format as a formatter for Java files. This example shows how to specify the command and filetypes.

```lua
local formatters = require "lvim.lsp.null-ls.formatters"
formatters.setup {
  {
    command = "clang-format",
    filetypes = { "java" },
  }
}

```

--------------------------------

### Install Ansible Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/ansible

Use this command to install the Tree-sitter grammar for YAML, which provides syntax highlighting for Ansible files.

```vim
:TSInstall yaml  

```

--------------------------------

### Configure neoscroll.nvim Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install and set up neoscroll.nvim for smooth scrolling animations with customizable options like hiding the cursor and respecting scrolloff.

```lua
{
  "karb94/neoscroll.nvim",
  event = "WinScrolled",
  config = function()
  require('neoscroll').setup({
        -- All these keys will be mapped to their corresponding default scrolling animation
        mappings = {'<C-u>', '<C-d>', '<C-b>', '<C-f>',
        '<C-y>', '<C-e>', 'zt', 'zz', 'zb'},
        hide_cursor = true,          -- Hide cursor while scrolling
        stop_eof = true,             -- Stop at <EOF> when scrolling downwards
        use_local_scrolloff = false, -- Use the local scope of scrolloff instead of the global scope
        respect_scrolloff = false,   -- Stop scrolling when the cursor reaches the scrolloff margin of the file
        cursor_scrolls_alone = true, -- The cursor will keep on scrolling even if the window cannot scroll further
        easing_function = nil,        -- Default easing function
        pre_hook = nil,              -- Function to run before the scrolling animation starts
        post_hook = nil,              -- Function to run after the scrolling animation ends
        })
  end
},
```

--------------------------------

### Install C# Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/csharp

Use this command to install the C# syntax highlighting plugin for LunarVim. Ensure you have the necessary plugin manager configured.

```vim
:TSInstall c_sharp  

```

--------------------------------

### Start Neovide with LunarVim

Source: https://www.lunarvim.org/docs/faq

Use this bash script to launch Neovide with LunarVim. It sets necessary environment variables for LunarVim's runtime, configuration, and cache directories.

```bash
#!/usr/bin/env bash

export LUNARVIM_RUNTIME_DIR="${LUNARVIM_RUNTIME_DIR:-"$HOME/.local/share/lunarvim"}"
export LUNARVIM_CONFIG_DIR="${LUNARVIM_CONFIG_DIR:-"$HOME/.config/lvim"}"
export LUNARVIM_CACHE_DIR="${LUNARVIM_CACHE_DIR:-"$HOME/.cache/lvim"}"
export LUNARVIM_BASE_DIR="${LUNARVIM_BASE_DIR:-"$HOME/.local/share/lunarvim/lvim"}"

exec neovide -- -u "$LUNARVIM_BASE_DIR/init.lua" "$@"

```

--------------------------------

### Install TypeScript Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/typescript

Use these commands to install the necessary plugins for TypeScript and TSX syntax highlighting in LunarVim.

```vimscript
:TSInstall typescript  
:TSInstall tsx  

```

--------------------------------

### Configure Bracey Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Set up the bracey.vim plugin for live editing of HTML, CSS, and JavaScript. This configuration includes commands and a build step for npm installation.

```lua
{
  "turbio/bracey.vim",
  cmd = {"Bracey", "BracyStop", "BraceyReload", "BraceyEval"},
  build = "npm install --prefix server",
},

```

--------------------------------

### Configure lsp-colors.nvim

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install the lsp-colors.nvim plugin to provide LSP diagnostic highlight groups for non-LSP colorschemes. It is configured to load on BufRead events.

```lua
{
  "folke/lsp-colors.nvim",
  event = "BufRead",
},
```

--------------------------------

### Configure auto-save.nvim Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install and configure the auto-save.nvim plugin to automatically save work on changes.

```lua
{
  "Pocco81/auto-save.nvim",
  config = function()
    require("auto-save").setup()
  end,
},
```

--------------------------------

### Install HCL Syntax Highlighting

Source: https://www.lunarvim.org/docs/features/supported-languages/hcl

Use this command to install the HCL syntax highlighting plugin for LunarVim. This enables better code visualization for HCL files.

```vim
:TSInstall hcl  

```

--------------------------------

### Configure Julia Language Server in LunarVim

Source: https://www.lunarvim.org/docs/features/supported-languages/julia

Create this configuration file to automatically start the Julia language server when opening Julia files in LunarVim. It re-uses common LSP configurations for consistency.

```lua
local opts = {}
-- re-use common lsp configurations (keybindings, buffer-highlight and cmp integration)  
opts = require("lvim").get_common_opts()
require('lspconfig').julials.setup(opts)

```

--------------------------------

### Install LunarVim Nightly Version (Windows)

Source: https://www.lunarvim.org/docs/installation

Installs the latest nightly build of LunarVim on Windows using PowerShell. This version may contain bugs.

```powershell
pwsh -c "iwr https://raw.githubusercontent.com/LunarVim/LunarVim/master/utils/installer/install.ps1 -UseBasicParsing | iex"
```

--------------------------------

### Configure nvim-lastplace Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install and configure nvim-lastplace to resume editing from where you left off, with options to ignore specific buffer types and file types.

```lua
 {
  "ethanholz/nvim-lastplace",
  event = "BufRead",
  config = function()
   require("nvim-lastplace").setup({
    lastplace_ignore_buftype = { "quickfix", "nofile", "help" },
    lastplace_ignore_filetype = {
     "gitcommit", "gitrebase", "svn", "hgcommit",
    },
    lastplace_open_folds = true,
   })
  end,
 },
```

--------------------------------

### Install Julia Language Server

Source: https://www.lunarvim.org/docs/features/supported-languages/julia

Manually install the LanguageServer.jl package for Julia within the nvim-lspconfig environment. This ensures that the language server is available for code completion and other LSP features.

```bash
julia --project=~/.julia/environments/nvim-lspconfig -e 'using Pkg; Pkg.add("LanguageServer")'  

```

--------------------------------

### Add User Plugins to LunarVim

Source: https://www.lunarvim.org/docs/configuration/plugins/user-plugins

Install plugins by adding entries to the `lvim.plugins` table in your `config.lua`. Saving the file or running `:LvimReload` will sync the plugins.

```lua
lvim.plugins = {
  { "lunarvim/colorschemes" },
  {
    "stevearc/dressing.nvim",
    config = function()
      require("dressing").setup({
        input = { enabled = false },
      })
    end,
  },
  {
    "nvim-neorg/neorg",
    ft = "norg", -- lazy-load on filetype
    config = true, -- run require("neorg").setup()
  },
}

```

--------------------------------

### Reinstall lvim Binary

Source: https://www.lunarvim.org/docs/troubleshooting

If `lvim` is not found or executable, reinstall the binary. Navigate to the LunarVim repository and run the installation script.

```bash
cd <lunarvim-repo> # this will be in `~/.local/share/lunarvim/lvim` by default
bash utils/installer/install_bin.sh
```

--------------------------------

### Configure uncrustify for Java

Source: https://www.lunarvim.org/docs/features/supported-languages/java

Set up uncrustify as a formatter for Java code. This example includes specifying a custom configuration file.

```lua
formatters = require "lvim.lsp.null-ls.formatters"
formatters.setup {
  {
    command = "uncrustify",
    filetypes = { "java" },
    extra_args = { "-c", "path/to/your.cfg" },
  }
}

```

--------------------------------

### Configure goto-preview

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Set up goto-preview for previewing goto definition calls. This configuration includes options for window dimensions, default mappings, and opacity.

```lua
{
  "rmagatti/goto-preview",
  config = function()
  require('goto-preview').setup {
        width = 120;
        height = 25;
        default_mappings = false;
        debug = false;
        opacity = nil;
        post_open_hook = nil
    }
  end
},
```

--------------------------------

### Configure dial.nvim Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Install and configure the dial.nvim plugin for extended incrementing/decrementing operations, including custom boolean and capitalized boolean types.

```lua
{
  "monaqa/dial.nvim",
  event = "BufRead",
  config = function()
    local dial = require "dial"
    vim.cmd [[  
    nmap <C-a> <Plug>(dial-increment)  
      nmap <C-x> <Plug>(dial-decrement)  
      vmap <C-a> <Plug>(dial-increment)  
      vmap <C-x> <Plug>(dial-decrement)  
      vmap g<C-a> <Plug>(dial-increment-additional)  
      vmap g<C-x> <Plug>(dial-decrement-additional)  
    ]]  
  
    dial.augends["custom#boolean"] = dial.common.enum_cyclic {
      name = "boolean",
      strlist = { "true", "false" },
    }
    table.insert(dial.config.searchlist.normal, "custom#boolean")
  
    -- For Languages which prefer True/False, e.g. python.  
    dial.augends["custom#Boolean"] = dial.common.enum_cyclic {
      name = "Boolean",
      strlist = { "True", "False" },
    }
    table.insert(dial.config.searchlist.normal, "custom#Boolean")
  end,
},
```

--------------------------------

### Install LunarVim Release Version (Linux/macOS)

Source: https://www.lunarvim.org/docs/installation

Installs the release version of LunarVim on Linux or macOS. Ensure you have Neovim v0.9.0+ and other prerequisites installed.

```bash
LV_BRANCH='release-1.4/neovim-0.9' bash <(curl -s https://raw.githubusercontent.com/LunarVim/LunarVim/release-1.4/neovim-0.9/utils/installer/install.sh)
```

--------------------------------

### Install LunarVim Release Version (Windows)

Source: https://www.lunarvim.org/docs/installation

Installs the release version of LunarVim on Windows using PowerShell. Ensure you have Neovim v0.9.0+ and other prerequisites installed.

```powershell
pwsh -c "`$LV_BRANCH='release-1.4/neovim-0.9'; iwr https://raw.githubusercontent.com/LunarVim/LunarVim/release-1.4/neovim-0.9/utils/installer/install.ps1 -UseBasicParsing | iex"
```

--------------------------------

### Install LunarVim Release Version (Docker)

Source: https://www.lunarvim.org/docs/installation

Installs the release version of LunarVim within a Docker container. This is useful for testing without affecting your host system. It installs dependencies and LunarVim.

```bash
docker run -w /tmp -it --rm alpine:edge sh -uelic 'addgroup -S lunaruser && adduser -S lunaruser -G lunaruser --shell /bin/sh && apk add yarn git python3 cargo neovim ripgrep alpine-sdk bash curl --update && LV_BRANCH='release-1.4/neovim-0.9' su -c "bash <(curl -s https://raw.githubusercontent.com/lunarvim/lunarvim/release-1.4/neovim-0.9/utils/installer/install.sh) --no-install-dependencies" lunaruser && su -c /home/lunaruser/.local/bin/lvim lunaruser'
```

--------------------------------

### Configure clang-format with Google Style

Source: https://www.lunarvim.org/docs/features/supported-languages/java

Configure clang-format to use the 'Google' style for Java code formatting. Ensure clang-format is installed and available in your PATH.

```lua
  {
    command = "clang-format",
    filetypes = { "java" },
    extra_args = { "--style", "Google" },
  }

```

--------------------------------

### Configure nvim-bqf for Better Quickfix Window

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Set up nvim-bqf for an improved quickfix window experience. This configuration enables auto-enable, customizes preview window settings, and defines key mappings.

```lua
{
  "kevinhwang91/nvim-bqf",
  event = { "BufRead", "BufNew" },
  config = function()
  require("bqf").setup({
          auto_enable = true,
          preview = {
          win_height = 12,
          win_vheight = 12,
          delay_syntax = 80,
          border_chars = { "┃", "┃", "━", "━", "┏", "┓", "┗", "┛", "█" },
          },
          func_map = {
          vsplit = "",
          ptogglemode = "z,",
          stoggleup = "",
          },
          filter = {
          fzf = {
          action_for = { ["ctrl-s"] = "split" },
          extra_opts = { "--bind", "ctrl-o:toggle-all", "--prompt", "> " },
          },
          },
          })
  end,
}
```

--------------------------------

### Configure lsp-rooter.nvim

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Set up lsp-rooter.nvim to automatically change the current working directory to the project's root directory. This is configured to run on BufRead events.

```lua
{
  "ahmedkhalf/lsp-rooter.nvim",
  event = "BufRead",
  config = function()
    require("lsp-rooter").setup()
  end,
},
```

--------------------------------

### Sample LunarVim Settings

Source: https://www.lunarvim.org/docs/configuration

This is a sample of the settings that can be configured in LunarVim, showing how to set defaults for Telescope.

```lua
lvim.builtin.telescope.defaults.initial_mode = "insert"  
lvim.builtin.telescope.defaults.layout_config.horizontal.mirror = false  
lvim.builtin.telescope.defaults.layout_config.preview_cutoff = 120  
lvim.builtin.telescope.defaults.layout_config.prompt_position = "bottom"  
lvim.builtin.telescope.defaults.layout_config.vertical.mirror = false  
lvim.builtin.telescope.defaults.layout_config.width = 0.75  
lvim.builtin.telescope.defaults.layout_strategy = "horizontal"  

```

--------------------------------

### Get Neovim Options

Source: https://www.lunarvim.org/docs/configuration/options

Retrieve the current value of a Neovim option using the :get() method. This is useful for debugging or conditional logic.

```lua
vim.opt.{option}:get()
```

--------------------------------

### Install LunarVim Nightly Version (Linux/macOS)

Source: https://www.lunarvim.org/docs/installation

Installs the latest nightly build of LunarVim on Linux or macOS. This version may contain bugs.

```bash
bash <(curl -s https://raw.githubusercontent.com/lunarvim/lunarvim/master/utils/installer/install.sh)
```

--------------------------------

### Configure nvim-window-picker for Window Selection

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Set up nvim-window-picker to allow jumping between windows using a selector. Configure filtering rules to exclude specific buffer types or file types.

```lua
{
      "s1n7ax/nvim-window-picker",
      version = "1.*",
      config = function()
        require("window-picker").setup({
          autoselect_one = true,
          include_current = false,
          filter_rules = {
            -- filter using buffer options
            bo = {
              -- if the file type is one of following, the window will be ignored
              filetype = { "neo-tree", "neo-tree-popup", "notify", "quickfix" },

              -- if the buffer type is one of following, the window will be ignored
              buftype = { "terminal" },
            },
          },
          other_win_hl_color = "#e35e4f",
        })
      end,
 }

-- example mappings you can place in some other place
-- An awesome method to jump to windows
local picker = require('window-picker')

vim.keymap.set("n", ",w", function()
  local picked_window_id = picker.pick_window({
    include_current_win = true
  }) or vim.api.nvim_get_current_win()
  vim.api.nvim_set_current_win(picked_window_id)
end, { desc = "Pick a window" })

-- Swap two windows using the awesome window picker
local function swap_windows()
  local window = picker.pick_window({
    include_current_win = false
  })
  local target_buffer = vim.fn.winbufnr(window)
  -- Set the target window to contain current buffer
  vim.api.nvim_win_set_buf(window, 0)
  -- Set current window to contain target buffer
  vim.api.nvim_win_set_buf(0, target_buffer)
end

vim.keymap.set('n', ',W', swap_windows, { desc = 'Swap windows' })

```

--------------------------------

### Configure neo-tree.nvim for File Management

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Set up neo-tree.nvim, a file system and tree structure manager. This configuration includes options for closing if it's the last window, buffer follow, and filesystem filtering.

```lua
{
  "nvim-neo-tree/neo-tree.nvim",
  branch = "v2.x",
  dependencies = {
    "nvim-lua/plenary.nvim",
    "nvim-tree/nvim-web-devicons",
    "MunifTanjim/nui.nvim",
  },
  config = function()
    require("neo-tree").setup({
      close_if_last_window = true,
      window = {
        width = 30,
      },
      buffers = {
        follow_current_file = true,
      },
      filesystem = {
        follow_current_file = true,
        filtered_items = {
          hide_dotfiles = false,
          hide_gitignored = false,
          hide_by_name = {
            "node_modules"
          },
          never_show = {
            ".DS_Store",
            "thumbs.db"
          },
        },
      },
    })
  end
}
```

--------------------------------

### Install LunarVim Nightly Version (Docker)

Source: https://www.lunarvim.org/docs/installation

Installs the latest nightly build of LunarVim within a Docker container. This is useful for testing the newest features and potential bugs.

```bash
docker run -w /root -it --rm alpine:edge sh -uelic 'apk add git neovim ripgrep alpine-sdk bash curl --update && bash <(curl -s https://raw.githubusercontent.com/lunarvim/lunarvim/master/utils/installer/install.sh) --no-install-dependencies && /root/.local/bin/lvim'
```

--------------------------------

### Configure snap for Fast Finder System

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Set up the snap plugin for a fast finder system. This configuration registers commands for finding files, buffers, old files, and live grep using fzy and ripgrep.

```lua
{
  "camspiers/snap",
  rocks = "fzy",
  config = function()
    local snap = require "snap"
    local layout = snap.get("layout").bottom
    local file = snap.config.file:with { consumer = "fzy", layout = layout }
    local vimgrep = snap.config.vimgrep:with { layout = layout }
    snap.register.command("find_files", file { producer = "ripgrep.file" })
    snap.register.command("buffers", file { producer = "vim.buffer" })
    snap.register.command("oldfiles", file { producer = "vim.oldfile" })
    snap.register.command("live_grep", vimgrep {})
  end,
}
```

--------------------------------

### Download and Install DroidSansMNerdFont-Regular

Source: https://www.lunarvim.org/docs/installation/post-install

Use curl to download and install the Droid Sans Mono Nerd Font. This font is required for LunarVim's icon display. Ensure the target directory exists before downloading.

```bash
mkdir -p ~/.local/share/fonts  
cd ~/.local/share/fonts && curl -fLO https://github.com/ryanoasis/nerd-fonts/raw/HEAD/patched-fonts/DroidSansMono/DroidSansMNerdFont-Regular.otf  
```

--------------------------------

### Configure clang-format with Local Style File

Source: https://www.lunarvim.org/docs/features/supported-languages/java

Use a local .clang-format file for code formatting. Specify the path to your format file using the 'file:' prefix in extra_args.

```lua
  {
    command = "clang-format",
    filetypes = { "java" },
    extra_args = { "--style", "file:<format_file_path>" },
  }

```

--------------------------------

### Configure Persistence Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Set up the persistence plugin to save and restore editor sessions. Configure the directory for session files and the options to be saved.

```lua
{
  "folke/persistence.nvim",
    event = "BufReadPre", -- this will only start session saving when an actual file was opened
    module = "persistence",
    config = function()
      require("persistence").setup {
        dir = vim.fn.expand(vim.fn.stdpath "config" .. "/session/"),
        options = { "buffers", "curdir", "tabpages", "winsize" },
      }
  end,
},

```

--------------------------------

### Set up Development Symlink for LunarVim

Source: https://www.lunarvim.org/docs/dev

Create a symbolic link to your LunarVim fork in the local share directory. This allows you to develop on your fork directly.

```bash
cd ~/.local/share/lunarvim/  
ln -s ~/dev/Lunarvim ~/.local/share/lunarvim/lvim_dev  
```

--------------------------------

### Configure lsp_signature.nvim

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Configure lsp_signature.nvim to display LSP signature hints while typing. This involves adding the plugin to the plugins section and calling `on_attach` within the `lvim.lsp.on_attach_callback`.

```lua
{
    "ray-x/lsp_signature.nvim",
    config = function()
      require"lsp_signature".setup({
        -- …
      })
    end,
},

```

```lua
lvim.lsp.on_attach_callback = function(client, bufnr)
  -- …
  require"lsp_signature".on_attach()
  -- …
end

```

--------------------------------

### Set Language Server Settings

Source: https://www.lunarvim.org/docs/configuration/language-features/language-servers

Use `:LspSettings` followed by the server name to configure specific settings for a language server. This creates a persistent configuration file.

```vim
:LspSettings <TAB>  

```

--------------------------------

### Set Neovim Options

Source: https://www.lunarvim.org/docs/configuration/options

Use this syntax to set various configuration options for Neovim. Ensure the option name and value are correctly formatted.

```lua
vim.opt.{option} = {value}
```

--------------------------------

### Manually Configure a Language Server

Source: https://www.lunarvim.org/docs/configuration/language-features/language-servers

Add the server to `skipped_servers` to disable automatic configuration, then set it up manually in your ftplugin file. Changes to `skipped_servers` require `:LvimCacheReset`.

```lua
vim.list_extend(lvim.lsp.automatic_configuration.skipped_servers, { "sumneko_lua" })  

```

--------------------------------

### Inspect LSP Override Configuration

Source: https://www.lunarvim.org/docs/troubleshooting

Check the current LSP override configuration. This is useful for identifying conflicts or outdated syntax in your LSP setup.

```lua
:lua print(vim.inspect(require("lvim.lsp.config").override))
```

--------------------------------

### Configure vim-gist for GitHub Gist Management

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Set up vim-gist to create and edit GitHub gists. It requires mattn/webapi-vim as a dependency.

```lua
{
  "mattn/vim-gist",
  event = "BufRead",
  dependencies = "mattn/webapi-vim",
},

```

--------------------------------

### Configure nvim-spectre for Search and Replace

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Integrate nvim-spectre for powerful search and replace operations within Neovim. This setup enables the plugin with default configurations.

```lua
{
  "nvim-pack/nvim-spectre",
  event = "BufRead",
  config = function()
    require("spectre").setup()
  end,
}
```

--------------------------------

### Configure Vim Bundler Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Configure the vim-bundler plugin for lightweight support of Ruby's Bundler. Includes a list of associated commands.

```lua
{
  "tpope/vim-bundler",
  cmd = {"Bundler", "Bopen", "Bsplit", "Btabedit"}
},

```

--------------------------------

### Inspect Skipped Language Servers

Source: https://www.lunarvim.org/docs/troubleshooting

View the list of language servers that LunarVim has automatically skipped. This helps in debugging why a specific language server might not be starting.

```lua
:lua print(vim.inspect(lvim.lsp.automatic_configuration.skipped_servers))
```

--------------------------------

### Add Server to LSP Override List (New Syntax)

Source: https://www.lunarvim.org/docs/troubleshooting

Add a language server to the `lvim.lsp.override` list using the correct syntax for versions after LunarVim#1813.

```lua
-- this is the correct syntax since 3dd60bd
vim.list_extend(lvim.lsp.override, { "jsonls" })
```

--------------------------------

### Configure minimap.vim for Minimap Functionality

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Set up the minimap.vim plugin, a fast minimap and scrollbar implemented in Rust. This configuration sets the minimap width and enables auto-start behavior.

```lua
{
  'wfxr/minimap.vim',
  build = "cargo install --locked code-minimap",
  -- cmd = {"Minimap", "MinimapClose", "MinimapToggle", "MinimapRefresh", "MinimapUpdateHighlight"},
  config = function ()
    vim.cmd ("let g:minimap_width = 10")
    vim.cmd ("let g:minimap_auto_start = 1")
    vim.cmd ("let g:minimap_auto_start_win_enter = 1")
  end,
}
```

--------------------------------

### Configure Vim Rails Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Configure the vim-rails plugin for editing Ruby on Rails applications. This setup defines a comprehensive list of commands for various Rails tasks.

```lua
{
  "tpope/vim-rails",
  cmd = {
    "Eview",
    "Econtroller",
    "Emodel",
    "Smodel",
    "Sview",
    "Scontroller",
    "Vmodel",
    "Vview",
    "Vcontroller",
    "Tmodel",
    "Tview",
    "Tcontroller",
    "Rails",
    "Generate",
    "Runner",
    "Extract"
  }
},

```

--------------------------------

### Configure hop.nvim for Navigation

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Set up the hop.nvim plugin for enhanced Neovim motions. This configuration maps 's' to HopChar2 and 'S' to HopWord for quick navigation.

```lua
{
  "phaazon/hop.nvim",
  event = "BufRead",
  config = function()
    require("hop").setup()
    vim.api.nvim_set_keymap("n", "s", ":HopChar2<cr>", { silent = true })
    vim.api.nvim_set_keymap("n", "S", ":HopWord<cr>", { silent = true })
  end,
}
```

--------------------------------

### Remove Lazy.nvim Package Root

Source: https://www.lunarvim.org/docs/troubleshooting

Completely remove the Lazy.nvim package root directory to force a fresh installation of plugins. This is a drastic step for resolving persistent Lazy.nvim issues.

```bash
LUNARVIM_RUNTIME_DIR="${LUNARVIM_RUNTIME_DIR:-$HOME/.local/share/lunarvim}"
rm -rf "$LUNARVIM_RUNTIME_DIR/site/pack/lazy"
```

--------------------------------

### Configure Core Plugins

Source: https://www.lunarvim.org/docs/configuration/plugins/core-plugins

Edit options within the `lvim.builtin.<builtin>` table to configure core plugins. Use <TAB> for autocomplete suggestions.

```lua
lvim.builtin.cmp.completion.keyword_length = 2
lvim.builtin.telescope.defaults.layout_config.width = 0.95
lvim.builtin.telescope.defaults.layout_config.preview_cutoff = 75
```

--------------------------------

### Configure Vim Cursorword Plugin

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Configure the vim-cursorword plugin to underline the word currently under the cursor. This setup uses autocommands to manage cursorword highlighting across different file types and modes.

```lua
{
  "itchyny/vim-cursorword",
    event = {"BufEnter", "BufNewFile"},
    config = function()
      vim.api.nvim_command("augroup user_plugin_cursorword")
      vim.api.nvim_command("autocmd!")
      vim.api.nvim_command("autocmd FileType NvimTree,lspsagafinder,dashboard,vista let b:cursorword = 0")
      vim.api.nvim_command("autocmd WinEnter * if &diff || &pvw | let b:cursorword = 0 | endif")
      vim.api.nvim_command("autocmd InsertEnter * let b:cursorword = 0")
      vim.api.nvim_command("autocmd InsertLeave * let b:cursorword = 1")
      vim.api.nvim_command("augroup END")
      end
},

```

--------------------------------

### Configure Metals Language Server for Scala

Source: https://www.lunarvim.org/docs/features/supported-languages/scala

This Lua configuration file sets up the Metals language server for Scala within LunarVim. It defines LSP settings, capabilities, and attach logic, including DAP setup.

```lua
local M = {}
  
M.config = function()
  local lvim_lsp = require("lvim.lsp")
  local metals_config = require("metals").bare_config()
  metals_config.on_init = lvim_lsp.common_on_init
  metals_config.on_exit = lvim_lsp.common_on_exit
  metals_config.capabilities = lvim_lsp.common_capabilities()
  metals_config.on_attach = function(client, bufnr)
    lvim_lsp.common_on_attach(client, bufnr)
    require("metals").setup_dap()
  end
  metals_config.settings = {
    superMethodLensesEnabled = true,
    showImplicitArguments = true,
    showInferredType = true,
    showImplicitConversionsAndClasses = true,
    excludedPackages = {},
  }
  metals_config.init_options.statusBarProvider = false
  vim.api.nvim_create_autocmd("FileType", {
    pattern = { "scala", "sbt", "java" },
    callback = function() require("metals").initialize_or_attach(metals_config) end,
    group = vim.api.nvim_create_augroup("nvim-metals", { clear = true }),
  })
end
  
return M  

```

--------------------------------

### Set Buffer-Local Options for C Files

Source: https://www.lunarvim.org/docs/configuration/ftplugin

Create a file at `$LUNARVIM_CONFIG_DIR/ftplugin/c.lua` to define options that apply only to C file buffers. This ensures settings like `tabstop` and `shiftwidth` are specific to C code.

```lua
vim.cmd("setlocal tabstop=4 shiftwidth=4")
```

--------------------------------

### Configure lightspeed.nvim for Navigation

Source: https://www.lunarvim.org/docs/configuration/plugins/example-configurations

Integrate the lightspeed.nvim plugin for fast codebase navigation. This is a lightweight alternative to other navigation plugins.

```lua
{
  "ggandor/lightspeed.nvim",
  event = "BufRead",
}
```

--------------------------------

### Customize Highlight Groups

Source: https://www.lunarvim.org/docs/configuration/appearance/colorschemes

Override highlight groups using an autocommand triggered by the `ColorScheme` event. Use `:Telescope highlights`, `:TSHighlightCapturesUnderCursor`, or `:Inspect` to find group names. This example changes the `Normal` group's background and style.

```lua
lvim.autocommands = {
  {
    { "ColorScheme" },
    {
      pattern = "*",
      callback = function()
        -- change `Normal` to the group you want to change
        -- and `#ffffff` to the color you want
        -- see `:h nvim_set_hl` for more options
        vim.api.nvim_set_hl(0, "Normal", { bg = "#ffffff", underline = false, bold = true })
      end,
    },
  },
}
```

--------------------------------

### Configure Autocommands with vim.api.nvim_create_autocmd

Source: https://www.lunarvim.org/docs/configuration/autocommands

Directly use the Neovim API `vim.api.nvim_create_autocmd` to set up autocommands. This method allows for fine-grained control over command execution based on events and patterns.

```lua
vim.api.nvim_create_autocmd("BufEnter", {
      pattern = { "*.json", "*.jsonc" },
      -- enable wrap mode for json files only
      command = "setlocal wrap",
})
```

--------------------------------

### Configure Julia Editor in `startup.jl`

Source: https://www.lunarvim.org/docs/features/supported-languages/julia

Leverage LunarVim as your default editor for Julia by defining it in your `~/.julia/config/startup.jl` file. This ensures that commands like `edit()` will open files in LunarVim.

```julia
using InteractiveUtils  
  
ENV["JULIA_EDITOR"] = "lvim"  
  
InteractiveUtils.define_editor(  
    r"lvim", wait=true) do cmd, path, line  
    `$cmd +$line $path`  
end  

```
Tokens:
Raw