GitHubHelp

marcelomaia/Neovim

★ 0Forks 0LuaGitHub ↗Compare

README

Neovim Configuration

A modern, productive Neovim setup powered by LazyVim and a curated set of plugins for code navigation, Git integration, and more.

Table of Contents

✨ Features

  • Fast startup and plugin management with LazyVim
  • Powerful LSP integration and code navigation
  • AI-powered code completion and assistance
  • Git integration with handy shortcuts
  • Fuzzy search and file explorer
  • Easy commenting and table formatting
  • Customizable keymaps for productivity

⚡ Requirements

🚀 Installation

# Clone the repository
git clone https://github.com/yourusername/neovim-config.git ~/.config/nvim

# Run setup script
cd ~/.config/nvim
scripts/setup.sh

After installation, open Neovim to automatically install plugins:

nvim

🛠️ First Steps

When you first open Neovim, you'll want to:

  • :Lazy — Manage plugins
  • :Mason — Manage LSP servers and tools
  • :checkhealth — Diagnose common issues
  • :LazyExtras — Enable optional plugins

Understanding the Leader Key

The leader key is set to <Space>. When you see <leader> in a keybinding, press Space followed by the specified key(s).

🤖 AI Features

This configuration includes AI-powered assistance to supercharge your coding workflow and productivity.

GitHub Copilot Integration

GitHub Copilot is an AI pair programmer that offers real-time code suggestions directly in your editor.

Key Features

  • Real-time Suggestions: Receive context-aware code suggestions as you type
  • Multilingual Support: Works across dozens of programming languages
  • Complete Function Suggestions: Generates entire function implementations based on comments or function names

Essential Keyboard Shortcuts

  • <M-CR> (Alt+Enter) — Access the completion panel with alternative suggestions
  • <C-l> (Ctrl+l) — Accept current suggestion
  • <M-[> / <M-]> — Navigate between suggestions (previous/next)
  • <C-]> — Dismiss current suggestion
  • <C-x><C-o> — Trigger manual completion in case automatic suggestions don't appear

Configuration

Copilot is configured through the copilot.lua plugin in lua/plugins/avante_ai.lua:

{
  "zbirenbaum/copilot.lua",
  event = "VeryLazy",
  opts = {
    enabled = true,
    filetypes = {
      markdown = true,
      help = true,
      -- Add other filetypes as needed
    },
    panel = {
      enabled = true,
      layout = {
        position = "right",
        ratio = 0.4,
      },
    },
    suggestion = {
      enabled = true,
      auto_trigger = true,
      debounce = 75,
    },
  },
}

Avante.nvim

Avante.nvim is an AI-assisted coding experience enhancer that works alongside Copilot.

Key Features

  • Context-Aware Suggestions: Provides intelligent suggestions based on project context
  • Semantic Understanding: Understands your codebase at a semantic level
  • Seamless Integration: Works harmoniously with GitHub Copilot

Usage Tips

  • Avante works best when your project has consistent coding conventions
  • It learns from your coding patterns over time
  • For best results, maintain well-structured and documented code

Troubleshooting AI Features

  • Missing Icons: Ensure you have a Nerd Font properly installed and configured
  • Slow Suggestions: Check your internet connection and GitHub Copilot status
  • No Suggestions: Verify your Copilot authentication with :Copilot auth
  • Icons Not Displaying: Reload your configuration after ensuring Nerd Font is active

To get the most out of these AI features, ensure your GitHub Copilot subscription is active and authenticated with :Copilot auth.

🔥 Git Shortcuts

  • <leader>gp — Preview Git hunk
  • <leader>gr — Reset Git hunk
  • <leader>gR — Reset Git buffer
  • <leader>gg — Open Neogit (commit/push/etc)
  • <leader>g — More Git commands

Additional Git Commands

  • <leader>gb — Blame line
  • <leader>gd — Diff file
  • <leader>gl — View log

🧭 Navigation Shortcuts

  • [g / ]g — Previous/Next Git hunk
  • [w / ]w — Previous/Next warning
  • [e / ]e — Previous/Next error
  • [d / ]d — Previous/Next diagnostic
  • [m / ]m — Previous/Next mark
  • [f / ]f — Previous/Next function
  • gd — Go to definition
  • gr — Go to references
  • gg — Go to top of file
  • G — Go to end of file

Window Navigation

  • <C-h> / <C-j> / <C-k> / <C-l> — Navigate between windows
  • <C-w>v — Split window vertically
  • <C-w>s — Split window horizontally
  • <C-w>c — Close current window

🔍 Search & File Shortcuts

  • <leader>ff — Find file
  • <leader>sg — Grep content in files
  • <leader>ss — LSP symbol search
  • <leader>sr — Search and replace
  • <leader>s — More search options

Advanced Search Options

  • <leader>sw — Search word under cursor
  • <leader>sb — Search in open buffers
  • <leader>sh — Search help tags
  • <leader>sH — Search command history

🗂️ Explorer Shortcuts

  • <leader>e — Toggle file explorer
  • d — Delete file
  • y — Yank file path
  • c — Copy file
  • a — Add file
  • r — Rename file
  • <M-h> — Toggle hidden files
  • [g / ]g — Previous/Next changed Git file

🧑‍💻 LSP & Code Navigation

  • gd — Go to definition
  • gD — Go to declaration
  • gI — Go to implementation
  • gr — Show references
  • K — Show documentation (hover)
  • <leader>ca — Code actions
  • <leader>cr — Rename symbol
  • <leader>cf — Format buffer or selection
  • <leader>x — Diagnostics/Quick fix
  • <leader>ss — Show LSP symbols

💬 Commenting

  • gcc — Toggle comment (line)
  • gc — Toggle comment (selection in visual mode)
  • gcO — Add comment on line above
  • gco — Add comment on line below
  • gcA — Add comment at end of line

📊 Table Formatting

Align tables easily using Tabularize:

Before:

|start| eat| left |
| 12   | 5 | 7         |
| 20| 5  | 15   |

After running :Tabularize /| or <leader>t|:

| start | eat | left |
| 12    | 5   | 7    |
| 20    | 5   | 15   |

💡 Other Useful Shortcuts

  • q — Quit (mapped to q1)
  • w — Save file (mapped to w2)
  • wq — Save and quit (mapped to wq1)
  • <leader>qq — Quit all
  • <leader>n — Notification history
  • :vs file_path — Open file vertically
  • :sp file_path — Open file horizontally
  • gf — Open file under cursor
  • zz — Center cursor
  • zb — Cursor at bottom
  • zt — Cursor at top

🛟 Troubleshooting

Common Issues

  1. Icons not displaying correctly

    • Ensure you have installed a Nerd Font and configured your terminal to use it
    • Check if your terminal supports Unicode characters

  2. LSP not working

    • Verify the language server is installed via :Mason
    • Check for errors with :LspInfo and :LspLog
    • Make sure necessary dependencies are installed for your language server

  3. Plugin errors

    • Run :Lazy and check for any plugin errors
    • Use :checkhealth for diagnostics
    • Check :messages for error details

Fixing Configuration Issues

If you encounter configuration issues:

  1. Try resetting your configuration: rm -rf ~/.local/share/nvim/lazy
  2. Start Neovim with minimal settings: nvim -u NONE
  3. Check for conflicting plugins in lua/plugins/

🎨 Customization

Adding Your Own Plugins

Create a new file in the lua/plugins/ directory:

-- lua/plugins/my_plugins.lua
return {
  {
    "plugin-author/plugin-name",
    config = function()
      -- your config here
    end,
  },
}

Modifying Key Mappings

Edit your keymaps in lua/config/keymaps.lua:

-- lua/config/keymaps.lua
local keymap = vim.keymap.set

-- Add your custom keymaps
keymap("n", "<leader>x", "<cmd>YourCommand<cr>", { desc = "Your Command" })

Changing Theme

Add or modify theme configuration in lua/plugins/colorscheme.lua.

🙏 Credits

Contributors

marcelomaiamarcelo-ssc

Issues