Do not use as is, use it as a source of inspiration.
I've customized my ZSH/Tmux/Alacritty too much, so it might not work properly ๐
Table of Contents (๐ Click to expand/collapse)
Themes are automatically changed based on time of the day:
Theme | Time of the day |
---|---|
rose-pine | [1am, 9am) |
tokyonight | [9am, 5pm) |
catppuccin | [5pm, 9pm) |
kanagawa | [9pm, 11:59pm), [0am, 1am] |
You can change this in plugins.lua and theme.lua
Customization (๐ Click to expand/collapse)
- I'm on the
rolling
branch of LunarVim and i'm usingneovim 0.7 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 itlvim.builtin.harpoon = { active = false }
- if you want to try out GitHub copilot, change the following
lvim.builtin.sell_your_soul_to_devil = true
- I'm using a custom dashboard, use the default LunarVim one if you like it better
lvim.builtin.fancy_dashboard = { active = false }
- I use a custom
lualine
disable it if you don't like itlvim.builtin.fancy_statusline = { active = false }
- You can use the fancy wild menu if you want, make sure to do a
:UpdateRemotePlugins
lvim.builtin.fancy_wild_menu = { active = true }
- You can use the
diffview
plugin instead of normalgitsigns 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
lvim.builtin.test_runner = { active = false }
- 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.neoscroll = { active = false }
- if you want an obvious focused window, and you don't get seizures from it
lvim.builtin.nonumber_unfocus = true
- choose between hop and lightspeed as your favorite motion provider
lvim.builtin.motion_provider = "hop"
- 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.async_tasks = { active = true }
- If you wanna see the issues, remove
lvim.lsp.diagnostics.virtual_text = false
- I'm using
skim
forlatex
stuff, change it tozathura
if you are onlinux
- Using tailwinds CSS for markdown, disable it if you want
Prerequisites (๐ Click to expand/collapse)
- Neovim >= v0.6.0
brew install neovim --nightly
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
# install LunarVim
mv ~/.config/lvim ~/.config/lvim_backup
git clone https://github.com/abzcoding/lvim.git ~/.config/lvim
lvim +LvimUpdate +LvimCacheReset +q
lvim # run :PackerSync
- FiraCode Nerd Font: My preferred font
- Any of the Nerd Fonts
On macOS with Homebrew, choose one of the Nerd Fonts, for example, here are some popular fonts:
brew tap homebrew/cask-fonts
brew search nerd-font
brew install --cask font-fira-code-nerd-font
brew install --cask font-victor-mono-nerd-font
brew install --cask font-iosevka-nerd-font-mono
brew install --cask font-hack-nerd-font
Other Stuff (๐ Click to expand/collapse)
To leverage LSP auto-completions and other functionalities, after you open a
file in Neovim, run :LspInstall <server>
to use
nvim-lsp-installer installation feature.
Use Tab
to list available servers.
Here are some common LSP server installations:
:LspInstall html cssls jsonls yamlls
:LspInstall gopls
:LspInstall pylsp
:LspInstall bashls vimls sumneko_lua
:LspInstall diagnosticls
- and moreโฆ
cd ~/.config/lvim
git pull
lvim # run :PackerSync
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
The default is to serve localhost only, on port 8080. For a more advanced (remote server) overview see Deploy a server
:InstantStartServer [host] [port]
: Start the server using:InstantStartSingle [host] [port]
: This only shares the current buffer.:InstantStartSession [host] [port]
:This shares all opened (and newly opened) buffers with the other clients
let g:instant_username="sth"
: Set your preferred username.:InstantJoinSingle [host] [port]
: Use this command if another client already initiated a single share.:InstantJoinSession [host] [port]
: Use this command if another client already initiated a session share
Screenshots (๐ Click to expand/collapse)
code_lens
and inlay_hints
when supported by lang server
peek using gp
rename using <leader>lr
k8s help
lazy git integration
zen mode
Cheat.sh integration
Symbols Outline
Plugins (๐ Click to expand/collapse)
- Tokyonight Theme
- Doom One Theme
- Rose Pine Theme
- LSP Signature
- Todo Comments
- Trouble
- symbols-outline.nvim
- Indent Blankline
- Twilight
- nvim-bqf
- vim match-up
- Markdown Preview for (Neo)vim
- Zen Mode
- rust-tools
- nvim-spectre
- colorizer.lua
- Neogen
- Vimtex
- nvim-lsp-ts-utils
- flutter-tools.nvim
- NeoClip
- Telescope live grep raw
- nvim-lightbulb
- fidget
- clangd_extensions.nvim
- crates.nvim
- Hop
- Lightspeed
- wilder.nvim
- nvim-lastplace
- Tabnine
- Persistence
- Presence
- Orgmode.nvim
- nvim-dap-ui
- LuaDev
- vim-test
- vim-ultest
- nvim-cheat
- alpha-nvim
- vim-dadbod
- vim-dadbod-completion
- vim-dadbod-ui
- Neoscroll
- Copilot
- Harpoon
- Renamer
- vim-log-highlighting
- nvim-cursorline
- nvim-hlslens
- csv.vim
- sidebar.nvim
- asynctasks.vim
- asyncrun.vim
- nvim-metals
- instant.nvim
- SnipRun
- Vista
- editorconfig-vim
Structure (๐ Click to expand/collapse)
- after/ - Stuff that happens after
- 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
- vimscript/ - wilder settings
Note that,
- Leader key set as Space
Key-mappings (๐ Click to expand/collapse)
Modes: ๐=normal ๐=visual ๐=select ๐=insert ๐=commandKey | Mode | Action | Plugin or Mapping |
---|---|---|---|
Space+e | ๐ | Open file tree | NvimTree |
Space+o | ๐ | Open symbols | Symbols-outline |
Space+f | ๐ | Open file finder | Telescope |
Space+h | ๐ | Remove highlight | nohlsearch< |
Space+/ | ๐ | Toggle comment | Comment.nvim |
Space+? | ๐ | Open cheats | cheat.sh |
Space+' | ๐ | Open marks | which-key marks |
Space+z | ๐ | Zen mode | zen-mode.nvim |
Space+P | ๐ | Projects | project.nvim |
Ctrl+</kbd> | ๐ | Open terminal | toggleterm.nvim |
Ctrl+s | ๐ | Show signature help | vim.lsp.buf.signature_help() |
Alt+s | ๐ | Snippet selection | Telescope luasnip extension |
Space+C | ๐ | Command Palette | Telescope command_palette |
Key | Mode | Action | Plugin or Mapping |
---|---|---|---|
f | ๐ | find next character | HopChar1CurrentLineAC or Lightspeed_f |
F | ๐ | find previous character | HopChar1CurrentLineBC or Lightspeed_F |
s | ๐ | find character | HopChar2 or Lightspeed_s |
S | ๐ | find word | HopWord or Lightspeed_S |
Alt+a | ๐ | select all | ggVG |
Alt+a | ๐ | increment number | C-A |
Alt+x | ๐ | decrement number | C-X |
Key | Mode | Action |
---|---|---|
Tab / Shift-Tab | ๐ | Navigate completion-menu |
Enter | ๐ | Select completion or expand snippet |
Upor Down | ๐ | Movement in completion pop-up |
]+d | ๐ | Next diagnostic |
[+d | ๐ | Previous diagnostic |
Space+l+j or Space+l+k | ๐ | Next/previous LSP diagnostic |
Space+l+r | ๐ | replace current word in project |
Ctrl+e | ๐ | Close pop-up |
Tab / Shift-Tab | ๐ ๐ | Navigate snippet placeholders |
Space+l | ๐ | keybindings for lsp |
g+a | ๐ | code actions |
g+A | ๐ | codelens actions |
g+d | ๐ | goto definition |
g+t | ๐ | goto type definition |
g+D | ๐ | goto declaration |
g+I | ๐ | goto implementation |
g+p | ๐ | peek implementation |
g+r | ๐ | goto references |
g+s | ๐ | show signature help |
Key | Mode | Action |
---|---|---|
Space+m+f | ๐ | Build File |
Space+m+p | ๐ | Build Project |
Space+m+e | ๐ | Edit Tasks |
Space+m+l | ๐ | List Tasks |
Space+r+f | ๐ | Run File |
Space+r+p | ๐ | Run Project |
Key | Mode | Action |
---|---|---|
Space+g+j or Space+g+k | ๐ | Next/previous Git hunk |
Space+g+p | ๐ | Preview hunk |
Space+g+l | ๐ | Blame line |
Space+g+s | ๐ ๐ | Stage hunk |
Space+g+u | ๐ | Undo stage hunk |
Space+g+R | ๐ ๐ | Reset hunk |
Key | Mode | Action |
---|---|---|
Space+g+g | ๐ | Open lazy git UI |
Key | Mode | Action |
---|---|---|
Space+f | ๐ | File search |
Space+P | ๐ | Project search |
Space+s+s | ๐ | Grep search |
Space+s+f | ๐ | Telescope find_files |
Space+s+e | ๐ | Telescope file_browser |
Space+F+l | ๐ | Reopen last search |
Space+b+f | ๐ | Buffers |
Space+s+c | ๐ | Colorschemes |
Space+s+C | ๐ | Command history |
Space+s+h | ๐ | Find help |
Space+s+k | ๐ | Keymap search |
Space+s+M | ๐ | Man Pages search |
Space+s+r | ๐ | Register search |
Space+s+t | ๐ | Grep string under cursor |
Space+s+t | ๐ | Grep raw |
Space+F+b | ๐ | Builtin search |
Space+F+f | ๐ | Current buffer search |
Space+F+g | ๐ | Git files search |
Space+F+i | ๐ | Installed plugins |
Space+F+p | ๐ | Project search |
Space+F+i | ๐ | Installed plugins |
in Telescope window | ||
CR | ๐ ๐ | Multi/Single Open |
Ctrl+c | ๐ ๐ | Exit telescope |
Ctrl+v | ๐ ๐ | Open in a vertical split |
Ctrl+s | ๐ ๐ | Open in a split |
Ctrl+t | ๐ ๐ | Open in a tab |
Ctrl+b | ๐ | Go back in Command Palette |
Tab | ๐ ๐ | Toggle Selection + Next |
Shift+Tab | ๐ ๐ | Toggle Selection + Prev |
Key | Mode | Action |
---|---|---|
Space+Space | ๐ | show harpoon shortlist |
Space+a | ๐ | add file to shortlist |
Space+1 | ๐ | jump to first file on shortlist |
Space+2 | ๐ | jump to second file on shortlist |
Space+3 | ๐ | jump to third file on shortlist |
Space+4 | ๐ | jump to forth file on shortlist |
Key | Mode | Action |
---|---|---|
Space+n+c | ๐ | Class documentation |
Space+n+f | ๐ | Function documentation |
Space+n+t | ๐ | Type documentation |
Space+n+F | ๐ | File documentation |
Key | Mode | Action |
---|---|---|
Space+q+d | ๐ | quit without saving session |
Space+q+l | ๐ | restore last session |
Space+q+s | ๐ | restore last session from current dir |
Key | Mode | Action |
---|---|---|
Shift+x | ๐ | close buffer |
Space+b+f | ๐ | find buffer |
Space+b+b | ๐ | toggle buffer groups |
Space+b+p | ๐ | pick buffer |
Space+b+1 | ๐ | goto buffer 1 |
Space+b+h | ๐ | Close all to left |
Space+b+l | ๐ | Close all to right |
Space+b+D | ๐ | Sort by directory |
Space+b+L | ๐ | Sort by language |
Key | Mode | Action |
---|---|---|
Space+T+d | ๐ | diagnostics |
Space+T+f | ๐ | definitions |
Space+T+r | ๐ | references |
Space+T+t | ๐ | todo |
Space+T+w | ๐ | workspace diagnostics |
Key | Mode | Action |
---|---|---|
Space+t+f | ๐ | run all tests in a file |
Space+t+n | ๐ | only run nearest test |
Space+t+s | ๐ | open test summary |
Key | Mode | Action |
---|---|---|
Space+R+p | ๐ | replace word in project |
Space+R+w | ๐ | replace visually selected word |
Space+R+f | ๐ | replace word in current buffer |