apicgg/neovim-ide

Neovim config for a web development IDE.

Neovim Setup

IMPORTANT: Don’t blindly use my settings unless you know what that entails. Proceed at your own risk!

Inspirations

My inspirations for this project are devaslife and Josean Martinez with some extra plugins and keybinds of my personal choice.

Neovim Setup

Requires

• True Color Terminal Like (macOS) : iTerm2 - Terminal for macOS.
• True Color terminal Like (Linux) : Alacritty Terminal - Terminal for Linux written in Rust.
• True Color terminal Like (WSL) : Windows Terminal - Terminal for WSL.
• Neovim (Version 0.8 or Later)
• Nerd Font - I use Hack Nerd Font. Check the link for more nerd fonts.
• Ripgrep - For Telescope Fuzzy Finder.
• Tree-sitter - Treesitter cli for tree-sitter plugin.

If you're on mac, linux or WSL, you can install iTerm2 (macOS only), Neovim and Ripgrep with homebrew. Check out the homebrew on how to install.

brew install --cask iterm2

brew install neovim

brew install ripgrep

brew install tree-sitter

Relevant Files

• Copy the nvim directory into your ~/.config.

Basic Keybinds

• The leader prefix key is assigned to space.
• To escape into normal mode use esc or jj.
• Open Telescope file explorer - <leader>e.
• Open nvim-tree file explorer - <leader>b.

Basic Setup

The leader key is bind to space.
Check ~/.config/nvim/lua/user/core/keymaps.lua

Some plugins might be disabled as they are commented.

Uncomment the plugins and save the ~/.config/nvim/lua/user/plugins-setup.lua to install via packer.

Check ~/.config/nvim/init.lua for commented plugins.

Install LSP

Enter :LspInstall followed by the name of the server you want to install. Check neovim/nvim-lspconfig documentation.
Example: :LspInstall javascript
Or mason can be used to install lsp, dap etc.
Mason has been configured in such a way that it will automatically install lsp servers from the lsp config file - ~/.config/nvim/lua/user/plugins/lsp/lspconfig.lua
Enter :Mason to install, update and delete lsp, dap etc.
For more check mason docs - mason.nvim

Install language parser

Enter :TSInstall followed by the name of the language you want to install
Example: :TSInstall typescript
Check the file ~/.config/nvim/lua/user/plugins/treesitter.lua to install language parsers with :TSUpdate

Manage plugins

Run :PackerClean to remove any disabled or unused plugins
Run :PackerSync to update and clean plugins

Also manually saving the ~/.config/nvim/lua/user/plugins-setup.lua file updates the plugins to it's latest version.

Plugins

Plugin Manager

• wbthomason/packer - Popular plugin manager

Dependency For Other Plugins

• nvim-lua/plenary - Useful lua functions other plugins use

Preferred Colorscheme (use any one of the below)

• bluz71/vim-nightfly-guicolors - Dark Colorscheme
• svrana/neosolarized.nvim - Neosolarized theme for Neovim

Navigating Between Neovim Windows and Tmux

• christoomey/vim-tmux-navigator

Essentials

• tpope/vim-surround - manipulate surroundings with "ys", "ds", and "cs"
• inkarkat/vim-ReplaceWithRegister - replace things with register with "gr"
• numToStr/Comment.nvim - toggle comments with "gc"

File Explorer

• nvim-tree/nvim-tree.lua

VS Code Like Icons

• nvim-tree/nvim-web-devicons

Status Line

• nvim-lualine/lualine.nvim

Fuzzy Finder

• nvim-telescope/telescope-fzf-native.nvim - Dependency for better performance
• nvim-telescope/telescope.nvim - Fuzzy Finder

Autocompletion

• hrsh7th/nvim-cmp - Completion plugin
• hrsh7th/cmp-buffer - Completion source for text in current buffer
• hrsh7th/cmp-path - Completion source for file system paths

Snippets

• L3MON4D3/LuaSnip - Snippet engine
• rafamadriz/friendly-snippets - Useful snippets for different languages
• saadparwaiz1/cmp_luasnip - Completion source for snippet autocomplete

Managing & Installing Language Servers, Linters & Formatters

• williamboman/mason.nvim

LSP Configuration

• williamboman/mason-lspconfig.nvim - Bridges gap b/w mason & lspconfig
• neovim/nvim-lspconfig - Easy way to configure lsp servers
• hrsh7th/cmp-nvim-lsp - Smart code autocompletion with lsp
• glepnir/lspsaga.nvim - Enhanced uis for lsp
• jose-elias-alvarez/typescript.nvim - Additional functionality for typescript server
• onsails/lspkind.nvim - Vs Code Like Icons for autocompletion

Formatting & Linting

• jose-elias-alvarez/null-ls.nvim - Easy way to configure formatters & linters
• jayp0521/mason-null-ls.nvim - Bridges gap b/w mason & null-ls

Syntax Highlighting & Autoclosing Things

• nvim-treesitter/nvim-treesitter - Treesitter configuration
• windwp/nvim-autopairs - Autoclose brackets, parens, quotes, etc...
• windwp/nvim-ts-autotag - Autoclose tags

Git

• lewis6991/gitsigns.nvim - Show line modifications on left hand side

Colorizer

• NvChad/nvim-colorizer.lua - A high-performance color highlighter for Neovim which has no external dependencies!

Markdown Preview

• iamcco/markdown-preview.nvim - Preview markdown on your modern browser with synchronised scrolling and flexible configuration. Check out the instructions below or on GitHub page to set it up.
  After setup open a .md file and use :MarkdownPreview to see a live preview inside your default browser.

cd ~/.local/share/nvim/site/pack/packer/start/
cd markdown-preview.nvim
yarn install
yarn build

Integrated Terminal

• akinsho/toggleterm.nvim - A neovim plugin to persist and toggle multiple terminals during an editing session.

Indent Highlight

• lukas-reineke/indent-blankline.nvim - This plugin adds indentation guides to all lines.

Discord Presence

• andweeb/presence.nvim - This is to show your Neovim status inside Discord.

TODO

• Configure debugger for JavaScript and TypeScript with DAP.

License

MIT

Contributors

This project follows the all-contributors specification. Contributions of any kind welcome!