Neovim Configuration

Features • Requirements • Font • Installation • Folder structure • Configuration • Plugins • Wiki

🌟 Preview

Find files with Telescope

Show keybindings with which-key

File browser with Telescope

Neo-tree file browser

Lazy.nvim

Mason.nvim

Autocompletion with nvim-cmp

✨ Features

• File explorer with neo-tree
• Autocompletion with CMP
• Git integration with Gitsigns and Neogit
• Fuzzy finding with Telescope
• Formatting with conform.nvim and Linting nvim-lint
• Language Server Protocol with Native LSP
• Debug Adapter Protocol with Nvim DAP
• Beautiful UI with Catppuccin and Noice.nvim
• Fast code navigation with flash.nvim

⚡️ Requirements

• Neovim >= 0.8.0
• Git >= 2.19.0
• a Nerd Font (optional)

🔠 Used Font

• Caskaydia Cove Nerd Font - A new monospaced font that includes programming ligatures and is designed to enhance the modern look and feel of the Terminal.

🛠️ Installation

Linux / macOS

Make a backup of your current nvim and shared folder

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

Go to your .config folder

cd ~/.config

Clone the Repository

git clone https://github.com/ilias777/nvim.git

Remove .git folder and add your own repo if you want

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

Navigate to nvim folder and open init.lua with Neovim

cd nvim
nvim init.lua

📁 Folder and File Structure

~/.config/nvim
│
├── lua                         # LUA FOLDER
│   ├── core
│   │   ├── autocommands.lua    # File to store all the autocommands
│   │   ├── usercommands.lua    # File to store all the usercommands
│   │   ├── keymaps.lua         # Keybindings
│   │   └── options.lua         # All Neovim options
│   └── plugins
│       ├── init.lua            # Many plugins in one file
│       ├── plugin_1.lua        # One or more plugins in one file
│       ├── plugin_2.lua        # One or more plugins in one file
│       ├── **
│       └── plugin_xx.lua
├── snippets
│   ├── javaspript.lua          # JavaScript snippets
│   └── lua.lua                 # Lua snippets
├── ftplugin
│   └── java.lua                # Java configuration
│── init.lua                    # Main file
└── cheatsheet.txt              # File for cheatsheet.nvim

⚙ Configuration

How to configure Neovim is explained in the Wiki

🔌 Plugins

• Over 90 Plugins preinstalled
• Startuptime ~40ms - ~59ms

Plugins List

Package Manager

• lazy.nvim - A modern plugin manager.

File Explorer

• neo-tree - Manage and browse the file system.

Plugins for LSP

• nvim-lspconfig - Configurations for the LSP client.
• mason - Install and manage LSP servers.
• mason-lspconfig - Bridge between mason and lsp-ocnfig.
• trouble.nvim - A pretty diagnostics, references, telescope results, quickfix and location list.
• glance.nvim - A pretty window for previewing, navigating and editing your LSP locations.
• inc-rename.nvim - Incremental LSP rename command.
• outline.nvim - Code outline sidebar powered by LSP.
• nvim-jdtls - Extensions for the built-in LSP support for eclipse.jdt.ls.

Autocompletion

• nvim-cmp - Completion plugin.

Formatter

• conform.nvim - Lightweight yet powerful formatter plugin for Neovim.

Linter

• nvim-lint - An asynchronous linter plugin for Neovim.

Colorscheme

• Catppuccin - Warm mid-tone dark theme.

Snippet Engine

• Luasnip - A snippet engine.
• friendly-snippets - Snippets collection for a set of different programming languages.

Tabline and Statusline

• bufferline.nvim - A snazzy buffer line.
• feline.nvim - A minimal, stylish and customizable statusline.

Motion

• cinnamon.nvim - Smooth scrolling for any movement command.
• flash.nvim - Navigate your code with search labels.
• hop.nvim - Jump anywhere in a document.
• nvim-spider - Use the w, e, b motions like a spider.

Git integration

• advanced-git-search - Search your git history by commit message, content and author with Telescope.
• diffview.nvim - Interface for easily cycling through diffs.
• gitsigns - Git integration: signs, hunk actions, blame, etc.
• neogit - A Magit clone for Neovim

Utils

• align.nvim - Aligning lines.
• indent-blankline - IndentLine replacement.
• live-command.nvim - Text editing with immediate visual feedback.
• noice.nvim - Replaces the UI for messages, cmdline and the popupmenu.
• nvim-autopairs - A minimalist autopairs.
• nvim-colorizer - A high-performance color highlighter.
• nvim-notify - A fancy, configurable, notification manager.
• nvim-surround - A plugin for adding/changing/deleting surrounding delimiter pairs.
• nvim-toggler - Invert text.
• nvim-ufo - Ultra fold with modern looking and performance boosting.
• nvim-web-devicons - Show dev icons.
• rainbow-delimiters - Rainbow delimiters for Neovim with Treesitter.
• ssr.nvim - Treesitter based structural search and replace plugin.
• statuscol.nvim - Configurable 'statuscolumn' with builtin segments and click handlers.
• toggleterm.nvim - A neovim lua plugin to help easily manage multiple terminal windows.
• vim-visual-multi - Multiple cursors.
• which-key.nvim - Popup of keybindings.
• yanky.nvim - Improved Yank and Put functionalities.
• zen-mode.nvim - Distraction-free coding.

Treesitter

• nvim-treesitter - Neovim Treesitter configurations and abstraction layer.
• nvim-treehopper - Region selection using hints on the abstract syntax tree of a document.
• nvim-treesitter-context - Shows the context of the currently visible buffer contents.
• nvim-treesitter-textobjects - Syntax aware text-objects, select, move, swap, and peek support.
• nvim-treesitter-textsubjects - Location and syntax aware text objects which do what you mean.
• ts-node-action - A framework for executing functional transformations on Tree-sitter nodes.
• ts-playground - View treesitter information directly in Neovim.

Telescope

• telescope.nvim - An extendable fuzzy finder. Find files, Filter, Preview, Pick. All in one!
• telescope-emoji.nvim - An extension for telescope.nvim that allows you to search emojis 😃.
• telescope-file-browser.nvim - A file browser extension for telescope.nvim.
• telescope-symbols.nvim - Ability of picking symbols and insert them at point.
• telescope-undo.nvim - Visualize your undo tree and fuzzy-search changes in it.
• telescope-zoxide - An extension for telescope.nvim that allows you operate zoxide within Neovim.

Comments

• Comment.nvim - Smart and powerful comment plugin.
• comment-box.nvim - Clarify and beautify your comments using boxes and lines.
• nvim-comment-frame - Detects the language using treesitter and adds a comment block.
• todo-comments.nvim - Highlight, list and search todo comments in your projects.

Degub Adapter Protocol

• nvim-dap - Debug Adapter Protocol client implementation for Neovim.
• nvim-dap-ui - A UI for nvim-dap.
• nvim-dap-vscode-js - nvim-dap adapter for vscode-js-debug.

Writing

• vimtex - A modern Vim and Neovim filetype and syntax plugin for LaTeX files.
• markdown-preview - Preview markdown on your browser.

Preinstalled Language Servers