• Theme
• Customization
• Install
• Collaborative Editing
• Java
• Recommended Fonts
• Screenshot
• Structure
• Plugins Included
  • Optional Plugins
• Custom Key-mappings
  • Editor UI
  • Motions
  • LSP
  • Plugin: AsyncTasks
  • Plugin: Gitsigns
  • Plugin: LazyGit
  • Plugin: Telescope
  • Plugin: Harpoon
  • Plugin: Neogen
  • Plugin: Persistence
  • Plugin: Bufferline
  • Plugin: Trouble
  • Plugin: Ultest
  • Plugin: Neotest
  • Plugin: Spectre
  • Plugin: Copilot
  • Plugin: Lsp_Lines
  • Plugin: Overseer
  • Plugin: NeoTree
• Troubleshooting

• I'm on this PR of LunarVim and i am using neovim 0.9 head
• Do not use as is, too much bloated! Also do not use on a potato PC!!
• i have a auto command to disable syntax,etc when you open files larger than 1MB
• if you don't want to use harpoon, disable it
  • lvim.builtin.harpoon = { active = false }
• if you want to try out GitHub copilot, change the following
  • lvim.builtin.sell_your_soul_to_devil = { active = true, prada = false }
  • in case you want to use cmp-copilot, set prada=true after copilot installation
• I use a custom lualine disable it if you don't like it
  • lvim.builtin.fancy_statusline = { active = false }
• You can use the diffview plugin instead of normal gitsigns diff
  • lvim.builtin.fancy_diff = { active = true }
• if you want to use debugging, change the following line to true, also install codelldb:
  • lvim.builtin.dap.active = true
• sometimes instead of saving you jump trough jumplist 😢 just disable nvim-lastplace
  • lvim.builtin.lastplace = { active = false }
• sometimes compe-tabnine doesn't play nice, you can disable it :)
  • lvim.builtin.tabnine = { active = false }
• if you don't need testing, just disable it (use ultest or neotest)
  • lvim.builtin.test_runner = { active = false, runner = "ultest" }
• if you don't want cheat.sh integration, disable it
  • lvim.builtin.cheat = { active = false }
• if you don't want the SQL integration, disable it
  • lvim.builtin.sql_integration = { active = false }
• if you don't like smooth scrolling, disable it
  • lvim.builtin.smooth_scroll= ""
• if you want an obvious focused window, and you don't get seizures from it
  • lvim.builtin.nonumber_unfocus = true
• choose between hop and leap as your favorite motion provider
  • lvim.builtin.motion_provider = "hop"
• choose between filename->incline and treesitter->winbar or navic as your winbar provider
  • lvim.builtin.winbar_provider = "treesitter"
• if you don't need CSV support, disable it
  • lvim.builtin.csv_support = false
• if you want to use the cool make and run system, enable it
  • lvim.builtin.task_runner = "async_tasks"
• you can choose between nvimtree and neo-tree as your file tree viewer
  • lvim.builtin.tree_provider = "neo-tree"
• you can use noice.nvim if you want
  • lvim.builtin.noice = { active = true }
• If you wanna see the issues, remove lvim.lsp.diagnostics.virtual_text = false
• I'm using skim for latex stuff, change it to zathura if you are on linux

Prerequisites

• Neovim >= v0.8.0

  brew install neovim --nightly

• Rust and telescope stuff:
  • ripgrep
  • fd

curl --proto '=https' --tlsv1.2 -sSf "https://sh.rustup.rs" | sh
cargo install ripgrep fd-find

• NodeJS >= v16.13.0 most language servers need this

brew install node

Language-Server Protocol (LSP)

To leverage LSP auto-completions and other functionalities, after you open a file in Neovim, run :MasonInstall <server> to use mason installation feature. Use Tab to list available servers.

Upgrade

cd ~/.config/lvim
git pull
lvim # run :PackerSync

Recommended Linters

You can use mason to install these:

brew install luarocks
luarocks install luacheck  # if you want to use luacheck
cargo install selene  # if you want to use selene instead of luacheck
brew install hadolint  # if you want to lint dockerfiles
pip install vim-vint  # for vim linting
# install llvm and clang_format for clang stuff
npm install -g @fsouza/prettierd # if you want to use prettierd
pip install yapf flake8 black  # for python stuff
# if you want to use the markdown thingy
brew install vale markdownlint-cli
cp -r ~/.config/lvim/.vale ~/.config/vale
# fix the address inside .vale.ini
cp ~/.config/lvim/vale_config.ini ~/.vale.ini
# if you want the latex stuff
# brew install --cask mactex-no-gui # for mac
# or install zathura and chktex on linux

In case you want a better tex support in mac, check this out

if you want the custom gostructhelper, first get the pkg:

cd /tmp
git clone https://github.com/vanhtuan0409/gostructhelper.git
cd gostructhelper/cmds/gostructhelper
go build -o /usr/local/bin/gostructhelper && chmod 0755 /usr/local/bin/gostructhelper

BufferLine

StatusLine

Dashboard

lsp_signature

Tabnine

Lang Server

completion

diagnostics using gl

code_actions using ga

code_lens and inlay_hints when supported by lang server

references in qf

treesitter backed folding

peek using gp

rename using <leader>lr

Builtin Terminal

Test

ETC

k8s help

lazy git integration

zen mode

Cheat.sh integration

use <leader>?

Symbols Outline

• Doom One Theme
• Rose Pine Theme
• LSP Signature
• Todo Comments
• Trouble
• symbols-outline.nvim
• Twilight
• nvim-bqf
• vim match-up
• Markdown Preview for (Neo)vim
• Zen Mode
• rust-tools
• nvim-spectre
• colorizer.lua
• Neogen
• Vimtex
• typescript.nvim
• flutter-tools.nvim
• NeoClip
• Telescope live grep args
• fidget
• clangd_extensions.nvim
• crates.nvim
• refactoring.nvim

Optional Plugins

• Hop
• Leap
• remember.nvim
• Tabnine
• Persistence
• Presence
• Orgmode.nvim
• nvim-dap-ui
• LuaDev
• vim-test
• vim-ultest
• nvim-cheat
• vim-dadbod
• vim-dadbod-completion
• vim-dadbod-ui
• Neoscroll
• Cinnamon scroll
• Copilot
• Harpoon
• vim-log-highlighting
• nvim-cursorline
• nvim-hlslens
• csv.vim
• sidebar.nvim
• asynctasks.vim
• asyncrun.vim
• nvim-metals
• instant.nvim
• SnipRun
• Vista
• editorconfig-vim
• dressing.nvim
• incline.nvim
• winbar.nvim
• lsp_lines.nvim
• neotest
• legendary.nvim
• overseer.nvim
• neo-tree.nvim
• noice.nvim
• nvim-dap-vscode-js
• inc-rename
• hlargs.nvim

• after/ - Stuff that happens after
  • ftplugin/ - Language specific settings
  • syntax/ - Custom syntax for languages
• ftdetect/ - Let neovim identify custom filetypes
• ftplugin/ - Language specific custom settings
• lsp-settings - Custom lang server settings
• lua/ - Lua plugin configurations
  • telescope/ - Telescope extensions
  • user/ - User specific settings
    • null_ls - list of configured linters/formatters
    • autocommands.lua - user defined autocommands
    • builtin.lua - change internal lunarvim settings
    • keybindings.lua - user defined keybindings
    • plugins.lua - list of installed plugins
    • lsp_kind.lua - all the icons and lsp ui goodies are here
    • theme.lua - customized themes
• config.lua - Main customization point for settings
• snippets/ - Personal code snippets

UI

Motion

LSP

Plugin: AsyncTasks

Plugin: Gitsigns

Plugin: LazyGit

Plugin: Telescope

Plugin: Harpoon

Plugin: Neogen

Plugin: Persistence

Plugin: Bufferline

Plugin: Trouble

Plugin: Ultest

Plugin: Neotest

Plugin: Spectre

Plugin: Copilot

Plugin: Lsp_Lines

Plugin: Overseer

Plugin: NeoTree