Nvim configuration

🚀 Getting Started

• Make a backup of your current Neovim files:

mv ~/.config/nvim ~/.config/nvim.bak
mv ~/.local/share/nvim ~/.local/share/nvim.bak

• Clone nvimrc

git clone https://github.com/ueaner/nvimrc ~/.config/nvim

• Remove the .git folder, so you can add it to your own repo later

rm -rf ~/.config/nvim/.git

• Start Neovim!

nvim

⚡️ Requirements

• Neovim nightly or latest version. See here and here
• a Nerd Font (optional). See here
• a C compiler, curl, and tree-sitter CLI 0.26.1 or later for nvim-treesitter. See here
• use standard proxy environment variables such as HTTPS_PROXY or ALL_PROXY for Tree-sitter parser/query downloads

⌨️ Keymaps

See keymaps.md.

✨ Features

• LazyVim for Neovim setup powered by 💤 lazy.nvim plugin management
• Package management with mason.nvim
• Syntax Highlighting with Treesitter
• Language Server Protocol with Native LSP
• Debug Adapter Protocol with nvim-dap
• Tests with neotest
• Formatting with conform.nvim
• Linting with nvim-lint
• Code Action previews with actions-preview.nvim
• Auto Completion with nvim-cmp
• Snippets with nvim-snippets and friendly-snippets
• Fuzzy Finding with telescope.nvim
• File Explorer with neo-tree.nvim
• Code Outline with aerial.nvim and outline.nvim
• Live prompt for keymaps with which-key.nvim
• Quickly Jump with flash.nvim and nvim-treehopper
• Colorscheme with tokyonight.nvim and catppuccin
• Statusline with lualine.nvim
• Tabline with bufferline.nvim
• Floating Winbar with incline.nvim
• Scrollbar with satellite.nvim
• Indent guides with indent-blankline.nvim
• Git integration with gitsigns.nvim
• Terminal with nvterm
• Database Explorer with vim-dadbod
• Http Client with kulala.nvim
• gRPC Client with grpc-nvim
• icons with mini.icons and vscode-codicons

Supported Programming Languages:

• Go
• Rust
• Python
• PHP
• TypeScript/JavaScript
• Bash/Zsh Script
• etc.

📁 File Structure

lua
├── config
│   ├── init.lua         -- configure of icons, close_with_q list, etc.
│   ├── lazy.lua         -- configure lazy.nvim
│   ├── autocmds.lua
│   ├── keymaps          -- general and plugin-specific keymaps
│   └── options.lua
├── plugins
│   ├── ui              -- UI Appearance
│   ├── editor          -- Editor Features
│   ├── coding          -- Coding Features
│   ├── lsp.lua
│   ├── dap.lua
│   ├── test.lua
│   ├── treesitter.lua
│   └── extras
│       ├── langspec.lua -- language spec generator
│       ├── tools
│       │   ├── database.lua
│       │   ├── plantuml.lua
│       │   ├── rest.lua
│       │   └── ...
│       └── lang         -- language specific extension modules
│           ├── yaml.lua
│           ├── python.lua
│           ├── go.lua
│           └── ...
└── util                -- shared utilities exposed through _G.U

Contents of ui, editor and coding directories:

• UI Appearance: statusline, tabline, winbar, scrollbar, indent, icons, notify, messages, cmdline, popupmenu, etc.
• Editor Features: which-key, fuzzy finder, file explorer, outline, jump, git signs, todo comments, auto-resize windows, etc.
• Coding Features: auto completion, snippets, comments, refactoring, auto pairs, etc.