Rafael Bodill's Neovim Config

Lean mean Neovim machine, 30-45ms startup time. Works best with Neovim ≥0.12

(plugins managed by Neovim's built-in vim.pack)

:gear: See Extending for customizing configuration and adding plugins.

I encourage you to fork this repo and create your own experience. Learn how to tweak and change Neovim to the way YOU like it. This is my cultivation of years of tweaking, use it as a git remote and stay in-touch with upstream for reference or cherry-picking.

[!IMPORTANT] LazyVim has been dropped in-favor of vim.pack -- see Upgrade from lazy.nvim

Features

• Native vim.pack for managing plugins
• Fast startup time: plugins are almost entirely lazy-loaded!
• Robust, yet light-weight
• Review plugin updates with :Packman (Space+l), and toggle opt-in extras with :RafiExtras or Space+mx
• Install LSP, DAP, linters, and formatters. Use with :Mason or Space+cm
• LSP configuration with nvim-lspconfig
• folke/snacks.nvim picker centric work-flow with lists (try ;+f…)
• Custom context-menu (try it! ;+c)
• Auto-complete setup with blink.cmp
• Structure view with bassamsdata/namu.nvim
• Git features using lewis6991/gitsigns.nvim, sindrets/diffview.nvim, and more
• Session management with rmagatti/auto-session
• Unobtrusive, yet informative status & tab lines
• Premium color-schemes
• Remembers last-used colorscheme

Screenshot

Prerequisites

• git ≥ 2.19.0 (brew install git)
• Neovim ≥ v0.12 for vim.pack (brew install neovim).

Optional, but highly recommended:

• bat (brew install bat)
• fd (brew install fd)
• fzf (brew install fzf)
• ripgrep (brew install ripgrep)
• zoxide (brew install zoxide)

Install

1. Let's clone this repo! Clone to ~/.config/nvim

   mkdir -p ~/.config
   git clone git@github.com:rafi/vim-config.git ~/.config/nvim
   cd ~/.config/nvim
   

2. Run nvim (will install all plugins the first time).

   It's highly recommended running :checkhealth to ensure your system is healthy and meets the requirements.

3. Inside Neovim, run :RafiExtras and press Enter to toggle extras, then restart Neovim. Choices are saved in rafi.json.

Enjoy! :smile:

Install LSP, DAP, Linters, Formatters

Use :Mason (or Space+cm) to install and manage LSP servers, DAP servers, linters and formatters. See :h mason.nvim and mason-org/mason.nvim for more information.

Language-Server Protocol (LSP)

You can install LSP servers using :Mason UI, or :MasonInstall , or :LspInstall (use Tab to list available servers). See Mason's PACKAGES.md for the official list, and the Language server mapping list. You can also view at :h mason-lspconfig-server-map

You'll need utilities like npm and curl to install some extensions, see requirements (or :h mason-requirements) for more information.

See plugin/lspconfig.lua for custom key-mappings, and after/lsp/ for settings of some language-servers.

Recommended LSP

:MasonInstall ansible-language-server bash-language-server css-lsp
:MasonInstall dockerfile-language-server gopls html-lsp json-lsp
:MasonInstall lua-language-server panache pyright sqlls
:MasonInstall svelte-language-server typescript-language-server
:MasonInstall tailwindcss-language-server
:MasonInstall vim-language-server yaml-language-server

and more…

Recommended Linters

:MasonInstall vint shellcheck editorconfig-checker flake8 gitlint hadolint
:MasonInstall markdownlint mypy selene shellharden write-good yamllint

Recommended Formatters

:MasonInstall black fixjson gofumpt golines isort
:MasonInstall shfmt sql-formatter stylua

Recommended Fonts

• Pragmata Pro (€19-€1,990): 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 search 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
brew install --cask font-fira-code

Upgrade

To update Neovim configuration from my repo, and move plugins to the versions locked in its nvim-pack-lock.json:

make update

To upgrade packages and plugins beyond that:

• Neovim plugins: Use :Packman check to review pending updates first and apply them with U. Or use make update-plugins for a headless update. With Neovim 0.13+, the plugins are checked in the background every hour, and a clickable count appears in statusline. Press Space+l (:Packman) to review updates.
• Mason packages: :Mason and press U

Upgrade from the lazy.nvim version

The first start writes rafi.json from your lazyvim.json extras, and warns about any that have no vim.pack version. Then:

• Plugins that used to be core (blink.cmp, mini.ai, mini.pairs, mini.surround, grug-far, outline, undotree, nvim-treesitter, the neo-hybrid colorscheme, now colorscheme.morrow, and others) are now extras. Pick the ones you want with :RafiExtras.
• lua/plugins/*.lua files that return lazy.nvim specs are ignored, with a warning. Rewrite them as plain vim.pack.add() code, see Extend: Plugins.
• lua/config/setup.lua and lua/config/lazy.lua are no longer read.
• LazyVim.* calls in lua/config/*.lua fail. Use rafi.util.root, rafi.util.pick, rafi.util.format, rafi.util.lsp, rafi.util.lualine, rafi.util.icons and rafi.pack.has().
• Once you're done, delete what lazy.nvim left behind: lazyvim.json, lazy-lock.json, ~/.local/share/nvim/lazy/ and ~/.local/state/nvim/lazy/.

Structure

• after/ - Language specific custom settings and plugins.
  • plugin/extras.lua - Loads enabled extras, then user plugins
• lua/ - Lua configurations
  • config/ - Custom user configuration
  • plugins/ - Custom user plugins
  • rafi/
    • config/ - Neovim configurations
      • autocmds.lua - Auto-commands
      • init.lua - Initialization, rafi.json
      • keymaps.lua - Key-mappings
      • options.lua - Editor settings
    • extras/ - Opt-in plugins ("extras")
    • pack.lua - Lazy-loading helpers for vim.pack
    • util/ - Utility library
• plugin/ - Core plugins, one vim.pack file each
• snippets/ - Personal code snippets
• rafi.json - Enabled extras and disabled core plugins (not tracked)

Extending

Extend: Config

Fork this repository and create a directory lua/config with one or more of these files: (Optional)

• lua/config/autocmds.lua - Custom auto-commands
• lua/config/options.lua - Custom options
• lua/config/keymaps.lua - Custom key-mappings

Each loads right after its Rafi counterpart, so it can override it.

Adding plugins or override existing options:

• lua/plugins/*.lua - Plain Lua files calling vim.pack.add(), sourced after the extras
• lua/plugins/extras//.lua - Your own extras, listed in :RafiExtras next to Rafi's

Extend: Plugins

Toggle "extras" plugins with :RafiExtras (or Space+mx) and Enter, then restart Neovim. This saves choices in rafi.json, which you can also edit manually. extras lists extras by . (their path under lua/rafi/extras/), and disabled turns off core plugins by their path under plugin/:

{
  "extras": [
    "coding.align",
    "editor.dial",
    "lang.docker",
    "lang.go",
    "lang.json",
    "lang.markdown",
    "lang.python",
    "lang.toml",
    "lang.typescript",
    "lang.yaml",
    "ui.bookmarks",
    "ui.deadcolumn"
  ],
  "disabled": ["lualine"]
}

A core plugin listed in disabled doesn't load, so you can replace it with your own file. Files in lua/plugins/*.lua are plain Lua, sourced after the extras. Here's an example, lua/plugins/lightline.lua:

-- Use lightline instead of lualine (add "lualine" to "disabled")
vim.pack.add({ 'https://github.com/itchyny/lightline.vim' })
vim.g.lightline = { colorscheme = 'wombat' }

See plugin/ and lua/rafi/extras/ for examples that lazy-load with lua/rafi/pack.lua.

Extend: Defaults

1. Create lua/config/options.lua and set any Neovim/RafiVim features: (Default values are shown)

   -- Elite-mode (hjkl mode. arrow-keys resize window)
   vim.g.elite_mode = false
   
   -- External file diff program
   vim.g.diffprg = 'bcompare'
   
   --  selects completion items, jumps in snippets and opens
   -- completion (coding.blink). false keeps  for snippet jumps and
   -- AI actions only.
   vim.g.cmp_supertab = true
   

Extend: LSP Settings

Override server options with vim.lsp.config(), for example in lua/plugins/lsp.lua (or an after/lsp/.lua file):

vim.lsp.config('yamlls', {
  filetypes = { 'yaml', 'yaml.ansible', 'yaml.docker-compose' },
})
vim.lsp.config('lua_ls', {
  settings = {
    Lua = {
      workspace = { checkThirdParty = false },
      completion = { callSnippet = 'Replace' },
    },
  },
})

Plugin Highlights

• Plugin management with Neovim's built-in vim.pack, lazy-loaded with small plugin/ files
• Auto-completion with Language-Server Protocol (LSP)
• Project-aware tabline
• Extensive syntax highlighting with nvim-treesitter/nvim-treesitter (treesitter.nvim-treesitter extra)

Note that 95% of the plugins are lazy-loaded.

Plugins Included

Extra Plugins

Custom Key-mappings

Note that,

• Leader key set as Space
• Local-Leader key set as ; and used for navigation and search (Snacks/Telescope and Neo-tree)
• Disable ← ↑ → ↓ in normal mode by enabling vim.g.elite_mode.

License

Apache-2.0, see LICENSE. Parts are derived from LazyVim and lazy.nvim, both Apache-2.0, see NOTICE. Files with derived code name their upstream source in a header comment.