Awesome

Rafael Bodill's Neovim Config

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

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

:triangular_flag_on_post: git tag vim tracks the last revision using Dein.nvim and plugins.yaml. Since then, the entire configuration has been rewritten to use lazy.nvim and Lua.

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
• Screenshot
• Prerequisites
• Install
• Install LSP, DAP, Linters, Formatters
  • Language-Server Protocol (LSP)
  • Recommended LSP
  • Recommended Linters
  • Recommended Formatters
• Recommended Fonts
• Upgrade
• Structure
• Extending
  • Extend: Config
  • Extend: Plugins
  • Extend: Defaults
  • Extend: LSP Settings
• Plugin Highlights
• Plugins Included
  • Completion & Code-Analysis
  • Editor Plugins
  • Coding Plugins
  • Colorscheme Plugins
  • Git Plugins
  • Misc Plugins
  • Treesitter & Syntax
  • UI Plugins
• Extra Plugins
  • Extra Plugins: Coding
  • Extra Plugins: Colorscheme
  • Extra Plugins: Editor
  • Extra Plugins: Git
  • Extra Plugins: Lang
  • Extra Plugins: LSP
  • Extra Plugins: Org
  • Extra Plugins: Treesitter
  • Extra Plugins: UI
  • LazyVim Extras
    • Language
    • DAP (Debugging)
    • Test
• Custom Key-mappings
  • Navigation
  • Selection
  • Jump To
  • Buffers
  • Clipboard
  • Auto-Completion
  • LSP
  • Diagnostics
  • Coding
  • Search, Substitute, Diff
  • Command & History
  • File Operations
  • Editor UI
  • Window Management
  • Plugins
    • Plugin: Mini.Surround
    • Plugin: Gitsigns
    • Plugin: Diffview
    • Plugin: Telescope
    • Plugin: Neo-Tree
    • Plugin: Marks
    • Plugin: Zk

Features

• Fast startup time — plugins are almost entirely lazy-loaded!
• Robust, yet light-weight
• Plugin management with folke/lazy.nvim. Use with :Lazy or <kbd>Space</kbd>+<kbd>l</kbd>
• Install LSP, DAP, linters, and formatters. Use with :Mason or <kbd>Space</kbd>+<kbd>mm</kbd>
• LSP configuration with nvim-lspconfig
• telescope.nvim centric work-flow with lists (try <kbd>;</kbd>+<kbd>f</kbd>…)
• Custom context-menu (try it! <kbd>;</kbd>+<kbd>c</kbd>)
• Auto-complete extensive setup with nvim-cmp (try <kbd>Tab</kbd> or <kbd>Ctrl</kbd>+<kbd>Space</kbd> in insert-mode)
• Structure view with [hedyhli/outline.nvim]
• Git features using lewis6991/gitsigns.nvim, sindrets/diffview.nvim, and more
• Session management with folke/persistence.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.10.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 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 meet the requirements.

3. Inside Neovim, run :LazyExtras and use <kbd>x</kbd> to install extras.

Enjoy! :smile:

Install LSP, DAP, Linters, Formatters

Use :Mason (or <kbd>Space</kbd>+<kbd>mm</kbd>) 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 <kbd>Tab</kbd> 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 <kbd>U</kbd>

To update Neovim configuration from my repo:

git pull --ff --ff-only

Structure

• after/ — Language specific custom settings and plugins.
• lua/ — Lua configurations
  • config/ — Custom user configuration
  • plugins/ — Custom user plugins (or lua/plugins.lua)
  • rafi/
    • config/ — Neovim configurations
      • autocmd.lua — Auto-commands
      • init.lua — Initialization
      • keymaps.lua — Key-mappings
      • lazy.lua — Entry-point initialization
      • options.lua — Editor settings
    • plugins/ — Plugins and configurations
    • util/ — Utility library
• snippets/ — Personal code snippets

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
• 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 specs for syntax)

Extend: Plugins

Install "extras" plugins using :LazyExtras and installing with <kbd>x</kbd>. This saves choices in lazyvim.json which you can also edit manually, here's a recommended starting point:

{
  "extras": [
    "lazyvim.plugins.extras.coding.copilot",
    "lazyvim.plugins.extras.dap.core",
    "lazyvim.plugins.extras.dap.nlua",
    "lazyvim.plugins.extras.lang.docker",
    "lazyvim.plugins.extras.lang.json",
    "lazyvim.plugins.extras.lang.typescript",
    "lazyvim.plugins.extras.lang.yaml",
    "lazyvim.plugins.extras.test.core",
    "rafi.plugins.extras.coding.align",
    "rafi.plugins.extras.editor.harpoon2",
    "rafi.plugins.extras.git.cmp-git",
    "rafi.plugins.extras.lang.ansible",
    "rafi.plugins.extras.lang.go",
    "rafi.plugins.extras.lang.helm",
    "rafi.plugins.extras.lang.markdown",
    "rafi.plugins.extras.lang.python",
    "rafi.plugins.extras.lang.tmux",
    "rafi.plugins.extras.ui.deadcolumn"
  ],
  "news": [],
  "version": 2
}

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 {

  -- Disable default tabline
  { 'akinsho/bufferline.nvim', enabled = false },

  -- And choose a different one!
  -- { 'itchyny/lightline.vim' },
  -- { 'vim-airline/vim-airline' },
  -- { 'glepnir/galaxyline.nvim' },
  -- { 'glepnir/spaceline.vim' },
  -- { 'liuchengxu/eleline.vim' },

  -- Enable GitHub's Copilot
  { import = 'lazyvim.plugins.extras.coding.copilot' },

  -- Enable incline, displaying filenames on each window
  { import = 'rafi.plugins.extras.ui.incline' },

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

  -- Change built-in 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',
      },
    },
  },

}

Extend: Defaults

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

   -- Auto format on-save
   vim.g.autoformat = false
   
   -- Elite-mode (hjkl mode. arrow-keys resize window)
   vim.g.elite_mode = false
   
   -- When enabled, 'q' closes any window
   vim.g.window_q_mapping = true
   

2. You can override LazyVim options. For example in lua/plugins/core.lua:

   return {
     {
       'LazyVim/LazyVim',
       opts = {
         icons = {
           diagnostics = {
             Error = '',
             Warn  = '',
             Info  = '',
           },
           status = {
             diagnostics = {
               error = 'E',
               warn  = 'W',
               info  = 'I',
               hint  = 'H',
             },
           },
         },
       },
     },
   }
   

3. You can override lazy.nvim (package-manager) global options. Create lua/config/setup.lua and return this function:

   • lazy_opts() — override LazyVim setup options

   For example:

   local M = {}
   
   ---@return table
   function M.lazy_opts()
     return {
       -- See https://github.com/folke/lazy.nvim/#%EF%B8%8F-configuration
       concurrency = jit.os:find('Windows') and (vim.uv.available_parallelism() * 2) or nil,
     }
   end
   
   return M
   

4. You can completely override lazy.nvim setup by creating lua/config/lazy.lua to replace lua/rafi/config/lazy.lua with your own procedure.

Extend: LSP Settings

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' },
          },
        },
      },
    },
  }
}

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

Completion & Code-Analysis

Editor Plugins

Coding Plugins

Colorscheme Plugins

Git Plugins

Misc Plugins

Treesitter & Syntax

UI Plugins

Extra Plugins

You can view all LazyVim's extras at www.lazyvim.org/extras.

These plugins aren't enabled by default. You'll have to install them using :LazyExtras and installing with <kbd>x</kbd>. (Or import them using specs) See Extend: Plugins on how to add plugins and examples.

Following are extra-extras available with Rafi's Neovim on-top of LazyVim's:

Extra Plugins: Coding

Spec: rafi.plugins.extras.coding.<name>

Extra Plugins: Colorscheme

Spec: rafi.plugins.extras.colorscheme.<name>

Extra Plugins: Editor

Spec: rafi.plugins.extras.editor.<name>

Extra Plugins: Git

Spec: rafi.plugins.extras.git.<name>

Extra Plugins: Lang

Spec: rafi.plugins.extras.lang.<name>

Extra Plugins: LSP

Spec: rafi.plugins.extras.lsp.<name>

Extra Plugins: Org

Spec: rafi.plugins.extras.org.<name>

Extra Plugins: Treesitter

Spec: rafi.plugins.extras.treesitter.<name>

Extra Plugins: UI

Spec: rafi.plugins.extras.ui.<name>

LazyVim Extras

LazyVim is imported in specs (see lua/rafi/config/lazy.lua) Therefore, you can import any of the "Extras" plugins defined at LazyVim/LazyVim and documented in lazyvim.org.

These are only highlights:

Language

• lazyvim.plugins.extras.lang.json
• lazyvim.plugins.extras.lang.markdown
• lazyvim.plugins.extras.lang.terraform
• lazyvim.plugins.extras.lang.typescript

DAP (Debugging)

• Spec: lazyvim.plugins.extras.dap.<name>
• See lazyvim/plugins/extras/dap

Test

• Spec: lazyvim.plugins.extras.test.<name>
• See lazyvim/plugins/extras/test

Custom Key-mappings

Note that,

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

Navigation

Selection

Jump To

Buffers

Clipboard

Auto-Completion

LSP

Diagnostics

Coding

Search, Substitute, Diff

Command & History

File Operations

Editor UI

Window Management

Plugins

Plugin: Mini.Surround

See echasnovski/mini.surround for more mappings and usage information.

Plugin: Gitsigns

See lewis6991/gitsigns.nvim for more mappings and usage information.

Plugin: Diffview

See sindrets/diffview.nvim for more mappings and usage information.

Plugin: Telescope

See telescope.nvim for more mappings and usage information.

Plugin: Neo-Tree

See nvim-neo-tree/neo-tree.nvim for more mappings and usage information.

Plugin: Marks

See chentau/marks.nvim for more mappings and usage information.

Plugin: Zk

See zk-org/zk-nvim and zk for more mappings and usage information.