mcpField
N
neovim

neovim

github.com/julianobarbosaDevelopment14297 installsUpdated 2d ago
Repository

About neovim

This skill documents how to work with a modular Neovim configuration, covering lazy.nvim plugin management, LSP, debugging, and performance troubleshooting. It is for Neovim users extending or diagnosing this Lua setup.

Key features

  1. 01Explain plugin management with lazy.nvim
  2. 02Guide LSP and debugger configuration
  3. 03Document module structure and the setup pattern
  4. 04Describe event-based loading and startup profiling
  5. 05Cover plugins, keybindings, and common troubleshooting

Use cases

  1. 01Add a plugin or LSP server to the configuration
  2. 02Diagnose plugin loading, LSP startup, or keybinding conflicts
  3. 03Investigate slow startup or Treesitter errors

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/julianobarbosa/claude-code-skills --skill neovim

After installing, type/neovimin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
configuration.md
debugging.md
keybindings.md
lsp.md
migration-0.11.md
performance.md
plugin-deepdives.md
plugins.md
tools.md
troubleshooting.md

Details

From the project README

Neovim Configuration Skill

A comprehensive guide for working with this modular, performance-optimized Neovim configuration built on lazy.nvim.

Quick Reference

MetricValue
Plugin Managerlazy.nvim
Total Plugins82
Target Startup<50ms
Module PatternM.setup()
Leader Key<Space>

Architecture Overview

~/.config/nvim/
├── init.lua                  # Entry point
├── lua/
│   ├── config/               # Core configuration (11 modules)
│   │   ├── lazy.lua          # Plugin manager bootstrap
│   │   ├── options.lua       # Vim options
│   │   ├── keymaps.lua       # Key bindings
│   │   ├── autocmds.lua      # Autocommands
│   │   └── performance.lua   # Startup optimization
│   ├── plugins/specs/        # Plugin specs (9 categories)
│   │   ├── core.lua          # Foundation (plenary, nui, devicons)
│   │   ├── ui.lua            # UI (lualine, bufferline, noice)
│   │   ├── editor.lua        # Editor (autopairs, flash, harpoon)
│   │   ├── lsp.lua           # LSP (lspconfig, mason, conform)
│   │   ├── git.lua           # Git (fugitive, gitsigns, diffview)
│   │   ├── ai.lua            # AI (copilot, ChatGPT)
│   │   ├── debug.lua         # DAP (nvim-dap, dap-ui)
│   │   ├── tools.lua         # Tools (telescope, neo-tree)
│   │   └── treesitter.lua    # Syntax (treesitter, textobjects)
│   ├── kickstart/            # Kickstart-derived modules
│   └── utils/                # Utility functions
└── lazy-lock.json            # Plugin version lock

Standard Module Pattern

All configuration modules follow the M.setup() pattern:

local M = {}

M.setup = function()
  -- Configuration logic here
end

return M

Plugin Management (lazy.nvim)

Adding a New Plugin

Add to the appropriate category file in lua/plugins/specs/:

-- lua/plugins/specs/tools.lua
return {
  -- Existing plugins...

  {
    "author/plugin-name",
    event = "VeryLazy",           -- Loading strategy
    dependencies = { "dep/name" }, -- Required plugins
    opts = {
      -- Plugin options
    },
    config = function(_, opts)
      require("plugin-name").setup(opts)
    end,
  },
}
Loading Strategies
StrategyWhen to UseExample
lazy = trueDefault, load on demandMost plugins
event = "VeryLazy"After UI loadsUI enhancements
event = "BufReadPre"When opening filesTreesitter, gitsigns
event = "InsertEnter"When typingCompletion, autopairs
cmd = "CommandName"On command invocationHeavy tools
ft = "filetype"For specific filetypesLanguage plugins
keys = {...}On keypressMotion plugins
Plugin Commands
CommandDescription
:LazyOpen lazy.nvim dashboard
:Lazy syncUpdate and install plugins
:Lazy profileShow startup time analysis
:Lazy cleanRemove unused plugins
:Lazy healthCheck plugin health

LSP Configuration

See references/lsp.md for complete LSP reference.

LSP Stack
mason.nvim (installer)
    ├── mason-lspconfig.nvim → nvim-lspconfig
    ├── mason-tool-installer.nvim (auto-install)
    └── mason-nvim-dap.nvim → nvim-dap

nvim-lspconfig
    ├── blink.cmp (completion)
    ├── conform.nvim (formatting)
    ├── nvim-lint (linting)
    └── trouble.nvim (diagnostics)
Adding an LSP Server
-- In lua/plugins/specs/lsp.lua, add to mason-tool-installer list:
ensure_installed = {
  "lua_ls",
  "pyright",
  "your_new_server",  -- Add here
}

-- Configure in lspconfig setup:
servers = {
  your_new_server = {
    settings = {
      -- Server-specific settings
    },
  },
}
LSP Keybindings
KeyAction
gdGo to definition
grGo to references
gIGo to implementation
gDGo to declaration
KHover documentation
<leader>rnRename symbol
<leader>caCode action
<leader>DType definition
<leader>dsDocument symbols
<leader>wsWorkspace symbols

Keybindings

See references/keybindings.md for complete reference.

Core Navigation
KeyAction
<C-h/j/k/l>Window navigation
<S-h> / <S-l>Previous/next buffer
<leader>sfSearch files
<leader>sgSearch by grep
<leader><space>Search buffers
\\Toggle Neo-tree
Adding Keybindings
-- In lua/config/keymaps.lua M.setup():
vim.keymap.set('n', '<leader>xx', function()
  -- Your action
end, { desc = 'Description for which-key' })

-- Or in a plugin spec:
keys = {
  { "<leader>xx", "<cmd>Command<CR>", desc = "Description" },
}

Debugging (DAP)

See references/debugging.md for complete reference.

DAP Keybindings
KeyAction
<F5>Continue/Start debugging
<F10>Step over
<F11>Step into
<F12>Step out
<leader>bToggle breakpoint
<leader>BConditional breakpoint
Adding a Debug Adapter
-- In lua/plugins/specs/debug.lua
local dap = require("dap")

dap.adapters.your_adapter = {
  type = "executable",
  command = "path/to/adapter",
}

dap.configurations.your_filetype = {
  {
    type = "your_adapter",
    request = "launch",
    name = "Launch",
    program = "${file}",
  },
}

Performance Optimization

Startup Optimization Layers
LayerTechniqueSavings
1vim.loader.enable()~50ms
2Skip vim._defaults~180ms
3Disable providers~10ms
4Disable builtins~20ms
5Deferred config~30ms
6Event-based loadingVariable
Profiling Startup
:Lazy profile
Deferred Loading Pattern
-- In init.lua
vim.defer_fn(function()
  require('config.options').setup()
  require('config.keymaps').setup()
  require('config.autocmds').setup()
end, 0)

Common Tasks

Adding an Autocommand
-- In lua/config/autocmds.lua M.setup():
vim.api.nvim_create_autocmd("FileType", {
  pattern = { "markdown", "text" },
  callback = function()
    vim.opt_local.wrap = true
    vim.opt_local.spell = true
  end,
})
Adding Vim Options
-- In lua/config/options.lua M.setup():
vim.opt.your_option = value
Creating a Utility Function
-- In lua/utils/init.lua
local M = {}

M.your_function = function(args)
  -- Implementation
end

return M

-- Usage: require('utils').your_function(args)

Plugin Categories

Core (4 plugins)

plenary.nvim, nui.nvim, nvim-web-devicons, lazy.nvim

UI (11 plugins)

tokyonight, alpha-nvim, lualine, bufferline, noice, nvim-notify, which-key, indent-blankline, mini.indentscope, fidget, nvim-scrollbar

Editor (13 plugins)

nvim-autopairs, flash.nvim, clever-f, nvim-spectre, grug-far, harpoon, persistence, smartyank, vim-sleuth, vim-illuminate, tabular, todo-comments, toggleterm

LSP (12 plugins)

nvim-lspconfig, mason, mason-lspconfig, mason-tool-installer, lazydev, luvit-meta, SchemaStore, conform, nvim-lint, trouble, blink.cmp/nvim-cmp, LuaSnip

Git (7 plugins)

vim-fugitive, vim-rhubarb, gitsigns, diffview, vim-flog, git-conflict, octo

AI (3 plugins)

copilot.vim, ChatGPT.nvim, mcphub.nvim

Debug (8 plugins)

nvim-dap, nvim-dap-ui, nvim-dap-virtual-text, nvim-dap-python, nvim-dap-go, mason-nvim-dap, telescope-dap, nvim-nio

Tools (14 plugins)

telescope, telescope-fzf-native, telescope-ui-select, neo-tree, oil.nvim, nvim-bqf, rest.nvim, vim-dadbod, vim-dadbod-ui, vim-dadbod-completion, iron.nvim, markdown-preview, nvim-puppeteer, obsidian.nvim

Treesitter (3 plugins)

nvim-treesitter, nvim-treesitter-context, nvim-treesitter-textobjects

Troubleshooting

IssueSolution
Plugins not loading:Lazy sync
LSP not starting:LspInfo, :Mason
Icons missingInstall a Nerd Font
Slow startup:Lazy profile
Treesitter errors:TSUpdate
Keybinding conflicts:verbose map <key>
Health Check
:checkhealth
Debug Logging
-- Temporarily add to plugin config:
log_level = vim.log.levels.DEBUG,

Resources

References


Gotchas

  • LSP attaches on FileType, not BufRead: Buffers opened before plugin spec evaluation get no LSP. :LspInfo shows nothing — open a new buffer of the same filetype or :edit to retrigger the autocommand.
  • lazy-lock.json silently pins everything: :Lazy sync will not update plugins unless the lock entry is removed or :Lazy update is run explicitly. Sync only installs missing plugins and removes orphans.
  • vim.defer_fn(..., 0) runs after UIEnter but before FileType: Config loaded this way misses the first buffer's filetype event. Move keymaps and options out of defer_fn if first-buffer integrations break.
  • Mason installs to ~/.local/share/nvim/mason/bin/, not $PATH: External tools that invoke formatters or linters from the shell will not find Mason-installed binaries unless you prepend that path explicitly.
  • event = "VeryLazy" defers until after UI is ready: Plugins that intercept startup behavior (sessions, dashboards, colorschemes) must use lazy = false with priority = 1000 — VeryLazy is too late.
  • Treesitter parsers compile against the installed Neovim ABI: After a Neovim upgrade, :TSUpdate is mandatory or you will see "Impossible pattern" errors with no obvious cause.

Comments

Markdown supported