Rafael Bodill's Neovim Config

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

⚠️ BREAKING CHANGES: The last major update uses lazy.nvim for plugin management, and an entire Lua rewrite. Please read "Extending" to learn how to customize and modify.

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.

Features

• Fast startup time — plugins are almost entirely lazy-loaded!
• Robust, yet light-weight
• Plugin management with folke/lazy.nvim. Use with :Lazy or Space+l
• Install LSP, DAP, linters, and formatters. Use with :Mason or Space+mm
• LSP configuration with nvim-lspconfig
• telescope.nvim centric work-flow with lists (try ;+f…)
• Custom context-menu (try it! ;+c)
• Auto-complete extensive setup with nvim-cmp (try Tab or Ctrl+Space in insert-mode)
• Structure view with simrat39/symbols-outline.nvim
• Git features using lewis6991/gitsigns.nvim, sindrets/diffview.nvim, and more
• Auto-save and restore sessions with olimorris/persisted.nvim
• Unobtrusive, yet informative status & tab lines
• Premium color-schemes
• Remembers last-used colorscheme

Screenshot

Prerequisites

• git ≥ 2.19.0 (brew install git)
• Neovim ≥ v0.8.0 (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 [email protected]: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 meet the requirements.

Enjoy! 😄

Install LSP, DAP, Linters, Formatters

Use :Mason to install and manage LSP servers, DAP servers, linters and formatters. See :h mason.nvim and williamboman/mason.nvim for more information.

Language-Server Protocol (LSP)

You can install LSP servers using :Mason UI, or :MasonInstall <name>, or :LspInstall <name> (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 lua/rafi/plugins/lsp/init.lua for custom key-mappings and configuration for 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 marksman 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 tap homebrew/cask-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 upgrade packages and plugins:

• Neovim plugins: :Lazy update
• Mason packages: :Mason and press U

To update Neovim configuration from my repo:

git pull --ff --ff-only

Structure

• init.lua — Entry-point, plugin initialization.
• neoconf.json — LSP servers options.
• after/ — Language specific custom settings and plugins.
• lua/ — Lua configurations
  • config/ — Custom user configuration
  • plugins/ — Custom user plugins (or lua/plugins.lua)
  • lsp/ — Custom user LSP configurations
  • rafi/
    • config/ — Neovim configurations
      • autocmd.lua — Auto-commands
      • init.lua — initialization
      • keymaps.lua — Key-mappings
      • options.lua — Editor settings
    • lib/ — Libraries
    • plugins/ — Plugins and configurations
• snippets/ — Personal code snippets
• themes/ — Colorscheme overrides

Extending

Extend: Config

There are 2 distinct ways to extend configuration:

1. The first option is to 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
   • lua/config/setup.lua — Override config, see extend defaults.

   Adding plugins or override existing options:

   • lua/plugins/*.lua or lua/plugins.lua — Plugins (See lazy.nvim for syntax)

   This option is recommended if you're not planning on customizing a lot, or you'd like to keep a close look of source-code.

2. Create your own clean ~/.config/nvim, and leverage lazy.nvim to import my configuration specs. You can use LazyVim/starter and just change lua/plugins/example.lua to:

   return {
     {
       "rafi/vim-config",      -- Will load ALL my plugins and config/*
       import = "rafi.plugins",
       opts = true,
     },
     { import = "plugins" },   -- Your local lua/plugins*
   }

   This will import and set up my lua/rafi/config/*, lua/rafi/plugins/* and then yours.

   If you'd rather import only specific plugins or specs, and not the entire plugin catalog, use import and remove opts. For example:

   return {
    {
      "rafi/vim-config",
      import = "rafi.plugins.colorscheme"
    },
    { import = "rafi.plugins.editor" },
    { import = "rafi.plugins.ui" },
   
    { import = "plugins" },  -- Your local lua/plugins*
   }

   This example will NOT load my lua/rafi/config/*, and only install plugins categorically from colorscheme.lua, editor.lua, and ui.lua. At last, it will load all your plugins defined in lua/plugins.lua or lua/plugins/*.

   This option has the advantage of partially importing different "plugin specs" from various sources.

Extend: Plugins

For installing/overriding/disabling plugins, create a lua/plugins/foo.lua file (or lua/plugins/foo/bar.lua or simply lua/plugins.lua) and manage your own plugin collection. You can add or override existing plugins' options, or just disable them all-together. Here's an example:

return {
  -- Import "extras" plugins. See "Extra Plugins" in README
  { import = 'rafi.plugins.extras.ui.incline' },

  -- Disable builtin plugins
  { 'shadmansaleh/lualine.nvim', enabled = false },
  { 'limorris/persisted.nvim', enabled = false },

  -- Change builtin plugins' options
  {
    'nvim-treesitter/nvim-treesitter',
    opts = {
      ensure_installed = {
        'bash', 'comment', 'css', 'diff', 'dockerfile', 'fennel', 'fish',
        'gitcommit', 'gitignore', 'gitattributes', 'git_rebase', 'go', 'gomod',
        'gosum', 'gowork', 'graphql', 'hcl', 'html', 'javascript', 'jsdoc',
        'json', 'json5', 'jsonc', 'jsonnet', 'lua', 'make', 'markdown',
        'markdown_inline', 'nix', 'perl', 'php', 'pug', 'python', 'regex',
        'rst', 'ruby', 'rust', 'scss', 'sql', 'svelte', 'terraform', 'toml',
        'tsx', 'typescript', 'vim', 'vimdoc', 'vue', 'yaml', 'zig',
      },
    },
  },

  -- GitHub plugins

  -- Choose only ONE of these statuslines ;)
  { 'itchyny/lightline.vim' },
  { 'vim-airline/vim-airline' },
  { 'glepnir/galaxyline.nvim' },
  { 'glepnir/spaceline.vim' },
  { 'liuchengxu/eleline.vim' },
}

Extend: Defaults

If you are using this distro as-is, and aren't importing it externally, create lua/config/setup.lua and return any of these functions:

• override()
• lazy_opts()

For example: (Default values are shown)

local M = {}

---@return table
function M.override()
  return {
    defaults = {
      autocmds = true, -- Load lua/rafi/config/autocmds.lua
      keymaps = true,  -- Load lua/rafi/config/keymaps.lua
    },
    features = {
      elite_mode = false,      -- Set arrow-keys to window resize
      window_q_mapping = true, -- Disable regular window closing with 'q'
    },
    icons = {
      -- See lua/rafi/config/init.lua for icon configuration…
    },
  }
end

---@return table
function M.lazy_opts()
  return {}
end

return M

If you are importing this distro via lazy.nvim specs, you can use opts. For example:

return {
  {
    "rafi/vim-config",
    import = "rafi.plugins",
    opts = {
      features = {
        elite_mode = false,
        window_q_mapping = true,
      },
    },
  },
}

Note: rafi.config.options can't be disabled here since it's loaded prematurely. You can disable loading options.lua with the following line at the top of your lua/config/setup.lua or init.lua:

package.loaded['rafi.config.options'] = true

Extend: LSP Settings

To override LSP configurations, you can do either:

1. Customize per project's .neoconf.json

2. Or, override server options with nvim-lspconfig plugin, for example:

   {
     'neovim/nvim-lspconfig',
     opts = {
       servers = {
         yamlls = {
           filetypes = { 'yaml', 'yaml.ansible', 'yaml.docker-compose' },
         },
         lua_ls = {
           settings = {
             Lua = {
               workspace = { checkThirdParty = false },
               completion = { callSnippet = 'Replace' },
             },
           },
         },
       },
     }
   }

3. Or, create a lua/lsp/<server_name>.lua file. Must return a table with config function. For example, create lua/lsp/go.lua:

   local opts = {
     settings = {
       gopls = {
         staticcheck = true
       }
     }
   }
   
   return {
     config = function()
       return opts
     end
   }

Plugin Highlights

• Plugin management with cache and lazy loading for speed
• Auto-completion with Language-Server Protocol (LSP)
• Project-aware tabline
• Extensive syntax highlighting with nvim-treesitter.

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

Plugins Included

Extra Plugins

return {
  { import = 'rafi.plugins.extras.ui.incline' },
  { import = 'rafi.plugins.extras.org.vimwiki' },
}

Custom Key-mappings

Note that,

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