Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wuelnerdotexe/nvim
My personal Neovim setup.
https://github.com/wuelnerdotexe/nvim
dotfiles hacktoberfest neovim wuelnerdotexe
Last synced: about 1 month ago
JSON representation
My personal Neovim setup.
- Host: GitHub
- URL: https://github.com/wuelnerdotexe/nvim
- Owner: wuelnerdotexe
- License: gpl-3.0
- Created: 2022-09-12T22:39:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-30T20:48:31.000Z (about 1 year ago)
- Last Synced: 2023-11-30T21:33:23.176Z (about 1 year ago)
- Topics: dotfiles, hacktoberfest, neovim, wuelnerdotexe
- Language: Lua
- Homepage:
- Size: 3.37 MB
- Stars: 35
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# My Neovim Setup
My personal Neovim setup written in Lua.
## Table of Contents
- [Features](#features)
- [Philosophy](#philosophy)
- [Requirements](#requirements)
- [Installation](#installation)
- [Keymaps](#keymaps)
- [General](#general)
- [Explorer](#explorer)
- [Folders Explorer](#folders-explorer)
- [Git Explorer](#git-explorer)
- [Windows](#windows)
- [Buffers](#buffers)
- [Tabs](#tabs)
- [Snippets](#snippets)
- [Selection](#selection)
- [Commenting](#commenting)
- [Moving text](#moving-text)
- [Git](#git)
- [Language servers](#language-servers)
- [Debugging](#debugging)
- [Recommendations](#recommendations)
- [Fonts](#fonts)
- [Maintainer](#maintainer)
- [License](#license)
## Features
The main features and plugins provided by this setup are as follows:
- 🧠 Smooth times based on scientific research.
- 🫴 Lazy loading of plugins with [lazy.nvim](https://github.com/folke/lazy.nvim).
- ⚡ Modern Vim's native options by [human.vim](https://github.com/wuelnerdotexe/human.vim).
- 📂 Robust folders explorer with [neo-tree.nvim](https://github.com/nvim-neo-tree/neo-tree.nvim).
- 🔭 Powerful fuzzy finder with [nvim-telescope](https://github.com/nvim-telescope/telescope.nvim).
- 🌳 Advanced syntax recognition with [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter).
- 💡 Neovim native language server protocol.
- 🔗 Multiple cursors with [vim-visual-multi](https://github.com/mg979/vim-visual-multi).
- 📜 [Friendly snippets](https://github.com/rafamadriz/friendly-snippets) with [LuaSnip](https://github.com/L3MON4D3/LuaSnip).
- 🤖 Autocomplete with [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) powered by [Tabnine](https://www.tabnine.com/) Machine Learning.
- 👷 Git status of files with [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim).
- 🐛 Code debugging with [nvim-dap](https://github.com/mfussenegger/nvim-dap).
- 👀 Markdown previewer with [markdown-preview.nvim](https://github.com/iamcco/markdown-preview.nvim).
- 🐱 Useful and smart status bar with [feline.nvim](https://github.com/feline-nvim/feline.nvim).
- 👁 Harmonic and consistent theme by [Enfocado](https://wuelnerdotexe.github.io/enfocado).
- 💅 Modern and nice user interface with [bufferline.nvim](https://github.com/akinsho/bufferline.nvim), [edgy.nvim](https://github.com/folke/edgy.nvim), [noice.nvim](https://github.com/folke/noice.nvim), [nvim-notify](https://github.com/rcarriga/nvim-notify), and [dressing.nvim](https://github.com/stevearc/dressing.nvim).
- 🟩 Tmux integration with [smart-splits.nvim](https://github.com/mrjones2014/smart-splits.nvim).
- 💫 Smooth UI animations with [mini.animate](https://github.com/echasnovski/mini.animate).
- 😎 Last but not least, announce your presence on Discord with funny messages (in Spanish) by [presence.nvim](https://github.com/andweeb/presence.nvim).
## Philosophy
> My Neovim setup, **unlike many others**, has and follows a **well-defined philosophy**, governed by **coherence** and **minimalism**. You won't find any unnecessary plugins or redundant plugins here, and **every little aspect** is tweaked to keep everything consistent as a whole; for example, all the icons used are the standard ones and all floating windows have a rounded edge. As it should be...
**DISCLAIMER:** due to this you will see that I make many commits perfecting aspects that seem insignificant, I apologize for my sick perfectionism.
## Requirements
- [Nerd Fonts](https://www.nerdfonts.com/) patched with [codicons.ttf](https://github.com/microsoft/vscode-codicons) - to show nice icons.
- [Neovim](https://neovim.io/) Nightly - obviously.
- [Git](https://git-scm.com/) - to install nvim plugins with [lazy.nvim](https://github.com/folke/lazy.nvim).
- [Node](https://nodejs.org/) and [NPM](https://www.npmjs.com/package/npm) - to install language servers and debug adapters with [mason.nvim](https://github.com/williamboman/mason.nvim).
- [ripgrep (rg)](https://github.com/BurntSushi/ripgrep) - to search patterns with [nvim-telescope](https://github.com/nvim-telescope/telescope.nvim).
- [fd](https://github.com/sharkdp/fd) - to find files with [nvim-telescope](https://github.com/nvim-telescope/telescope.nvim).
- [cargo](https://github.com/rust-lang/cargo) - to replace the enemy with [nvim-spectre](https://github.com/nvim-pack/nvim-spectre) (optional).
- [sqlite](https://www.sqlite.org/index.html) - to storage yank history with [yanky.nvim](https://github.com/gbprod/yanky.nvim) (optional).
## Installation
First, if you have a previous Neovim config, make sure to make a backup before installing this setup in case something goes wrong in the process. This is done by backing up the `~/.config/nvim/` folder and its contents.
To install this configuration, you just need to clone this repository to the Neovim user config runtime directory for your operating system, which you can find [here](https://neovim.io/doc/user/starting.html#config), or by running the `:help config` help command within Neovim. For a clean install, make sure you have all Neovim runtime folders `~/.local/share/nvim` (Linux/MacOS) and `$LOCALAPPDATA/nvim-data` (Windows) clean.
For example, to install on Linux/MacOS:
```bash
git clone https://github.com/wuelnerdotexe/nvim ~/.config/nvim --depth 1
```
## Keymaps
The keymaps created by this config are very well thought out to be intuitive, meaningful, and most of all, to stick to the essence of Vim without conflicting with it. Keymaps are normally assigned two letters, which signify an action, for example: `d` + `p` = `d`iagnostic `p`review. Keep in mind that the functionality will always come first and then the action. This is the standard created and used by this configuration for unique consistency.
**IMPORTANT:** the `\` (backslash) remains as the `` key, and the `|` (pipe) remains as the `` key.
### General
| VI Mode | Keymap | Description |
| :---------------: | :--------------------: | ------------------------------------------------------ |
| Normal | `` + `f` + `t` | Toggle the folders explorer |
| Normal | `` + `f` + `f` | Find files in the current directory |
| Normal | `` + `p` + `f` | Find the workspace projects |
| Normal | `` + `o` + `f` | Find recently opened files |
| Normal | `` + `m` + `f` | Find Vim files marks |
| Normal and visual | `` + `w` + `f` | Find word in the current directory |
| Normal and visual | `` + `w` + `r` | Replace word in the current directory |
| Normal and visual | `` + `s` + `r` | Structural search and replace in the current directory |
| Normal | `` + `g` + `t` | Toggle the git explorer |
| Normal | `` + `g` + `f` | Find files from git status |
| Normal | `` + `b` + `f` | Find opened buffers |
| Normal | `` + `r` + `f` | Find resume |
| Normal | `` + `s` + `t` | Toggle document symbols |
| Normal | `` + `t` + `o` | Open the terminal in a new buffer |
### Explorer
| VI Mode | Keymap | Description |
| :-----: | :---------------------: | ---------------------------- |
| Normal | Double left mouse click | Expand/open or collapse node |
| Normal | `ENTER` | Expand/open or collapse node |
| Normal | `CTRL` + `t` | Open in a new tab |
| Normal | `CTRL` + `s` | Open in a new split |
| Normal | `CTRL` + `v` | Open to the side |
| Normal | `a` | Add node |
| Normal | `r` | Rename node |
| Normal | `m` | Move node |
| Normal | `c` | Copy node |
| Normal | `d` | Delete node |
| Normal | `y` | Copy node to clipboard |
| Normal | `x` | Cut node to clipboard |
| Normal | `p` | Paste node from clipboard |
| Normal | `` + `pt` | Toggle preview |
| Normal | `q` | Exit |
| Normal | `` | Refresh the explorer |
#### Folders Explorer
| VI Mode | Keymap | Description |
| :-----: | :----------: | -------------------------------- |
| Normal | `>` | Enter directory |
| Normal | `<` | Leave directory |
| Normal | `/` | Fuzzy finder |
| Normal | `CTRL` + `f` | Filter nodes |
| Normal | `` | Clear filter |
| Normal | `[` + `g` | Go to previous git modified node |
| Normal | `]` + `g` | Go to next git modified node |
#### Git Explorer
| VI Mode | Keymap | Description |
| :-----: | :-------: | ---------------- |
| Normal | `g` + `s` | Git stage file |
| Normal | `g` + `u` | Git unstage file |
| Normal | `g` + `r` | Git revert file |
| Normal | `g` + `A` | Git add all |
| Normal | `g` + `c` | Git commit |
### Windows
| VI Mode | Keymap | Description |
| :---------------: | :----------------: | ---------------------------------------- |
| Normal and visual | `CTRL` + `h` | Move to the left window |
| Normal and visual | `CTRL` + `j` | Move to the down window |
| Normal and visual | `CTRL` + `k` | Move to the up window |
| Normal and visual | `CTRL` + `l` | Move to the right window |
| Normal and visual | `Alt` + `h` | Resize the window on the left |
| Normal and visual | `Alt` + `j` | Resize the window on the down |
| Normal and visual | `Alt` + `k` | Resize the window on the up |
| Normal and visual | `Alt` + `l` | Resize the window on the right |
| Normal and visual | `CTRL` + `w` + `h` | Swap window to left |
| Normal and visual | `CTRL` + `w` + `j` | Swap window to down |
| Normal and visual | `CTRL` + `w` + `k` | Swap window to up |
| Normal and visual | `CTRL` + `w` + `l` | Swap window to right |
| Normal and visual | `CTRL` + `w` + `o` | Close all windows except the current one |
| Normal and visual | `CTRL` + `w` + `t` | Open the current file in a new tab |
| Normal and visual | `CTRL` + `w` + `s` | Split horizontally the current file |
| Normal and visual | `CTRL` + `w` + `v` | Split vertically the current file |
### Buffers
| VI Mode | Keymap | Description |
| :-----: | :-------------------: | --------------------- |
| Normal | `g` + `B` | Go to previous buffer |
| Insert | `SHIFT` + `PAGE UP` | Go to previous buffer |
| Normal | `g` + `b` | Go to next buffer |
| Insert | `SHIFT` + `PAGE DOWN` | Go to next buffer |
| Normal | `SHIFT` + `Home` | Move buffer left |
| Normal | `SHIFT` + `End` | Move buffer right |
### Tabs
| VI Mode | Keymap | Description |
| :-----: | :------------------: | ---------------------- |
| Normal | `g` + `T` | Go to the previous tab |
| Insert | `CTRL` + `PAGE UP` | Go to the previous tab |
| Normal | `g` + `t` | Go to the next tab |
| Insert | `CTRL` + `PAGE DOWN` | Go to the next tab |
### Snippets
| VI Mode | Keymap | Description |
| :---------------: | :-------------: | ----------------------------------------------- |
| Insert | `TAB` | Expand snippet or jump to the next snippet node |
| Insert and select | `SHIFT` + `TAB` | Jump to the previous snippet node |
| select | `TAB` | Jump to the next snippet node |
### Selection
| VI Mode | Keymap | Description |
| :-------------------------: | :--------------: | ----------------------------- |
| Normal | `Space` | Init incremental selection |
| Visual | `Space` | Increment the node selection |
| Visual | `CTRL` + `Space` | Increment the scope selection |
| Visual | `Backspace` | Decrement the node selection |
| Visual and operator pending | `a` + `f` | Select arround function |
| Visual and operator pending | `i` + `f` | Select inner function |
| Visual and operator pending | `a` + `c` | Select arround condition |
| Visual and operator pending | `i` + `c` | Select inner condition |
| Visual and operator pending | `a` + `l` | Select arround loop |
| Visual and operator pending | `i` + `l` | Select inner loop |
### Commenting
| VI Mode | Keymap | Description |
| :-------------------------: | :-------------: | ------------------------- |
| Normal | `g` + `c` + `c` | Comment the current line |
| Visual and operator pending | `g` + `c` | Comment current selection |
### Moving text
| VI Mode | Keymap | Description |
| :---------------: | :-------------: | --------------- |
| Normal and visual | `Alt` + `Left` | Move char left |
| Normal and visual | `Alt` + `Down` | Move line down |
| Normal and visual | `Alt` + `Up` | Move line up |
| Normal and visual | `Alt` + `Right` | Move char right |
### Git
| VI Mode | Keymap | Description |
| :---------------: | :-------------------------: | ----------------------------------------------------------- |
| Normal | `` + `g` + `d` | Split git diffs |
| Normal | `` + `d` + `t` | Toggle show deleted lines |
| Normal | `[` + `h` | Go to the previous hunk (can be repetable with `,` and `;`) |
| Normal | `]` + `h` | Go to the next hunk (can be repetable with `,` and `;`) |
| Normal | `` + `h` + `p` | Preview the current hunk |
| Normal | `` + `b` + `p` | Preview the current line blame |
| Normal and Visual | `` + `h` + `s` | Stage the current hunk |
| Normal | `` + `h` + `r` | Reset the current hunk |
### Language servers
| VI Mode | Keymap | Description |
| :---------------: | :-------------------------: | ------------------------------------------------------------- |
| Normal | `` + `l` + `t` | Toggle lines diagnostics |
| Normal | `` + `h` + `t` | Toggle inlay hints |
| Normal | `` + `d` + `p` | Preview of the current diagnostic |
| Normal | `` + `d` + `l` | Show list of diagnostics |
| Normal | `[` + `d` | Go to previous diagnostic (can be repetable with `,` and `;`) |
| Normal | `]` + `d` | Go to next diagnostic (can be repetable with `,` and `;`) |
| Insert | `CTRL` + `b` | Scroll up in the documentation |
| Insert | `CTRL` + `f` | Scroll down in the documentation |
| Normal | `K` | Show hover documentation |
| Insert | `CTRL` + `k` | Show signature help |
| Normal | `` + `s` + `r` | Rename the current symbol |
| Normal | `` + `r` + `l` | Show list of references |
| Normal | `g` + `d` | Go to definition |
| Normal | `g` + `D` | Peek definition |
| Normal | `g` + `i` | Go to implementation |
| Normal | `` + `c` + `a` | Show current code actions |
| Normal and Visual | `` + `c` + `f` | Format the code |
### Debugging
| VI Mode | Keymap | Description |
| :-----: | :-----------------------: | --------------------------------------- |
| Normal | `` | Toggle breakpoint on the current line |
| Normal | `` | Run and debug |
| Normal | `SHIFT` + `` | Terminate the current debugging session |
| Normal | `SHIFT` + `CTRL` + `` | Restart the current debugging session |
| Normal | `` | Debug pause |
| Normal | `` | Debug step over |
| Normal | `` | Debug step into |
| Normal | `CTRL` + `` | Debug step into targets |
| Normal | `SHIFT` + `` | Debug step out |
**NOTE:** only custom keymaps unique to this configuration are documented here. There are many more keymaps available by default in each installed plugin, in addition to the hundreds that come with Vim by default.
## Recommendations
### Fonts
In order for the **[Enfocado](https://wuelnerdotexe.github.io/enfocado)'s Human Writing** feature work as it should, I recommend that you use either of these three beautiful fonts, which align with the **"Mankind and Machine"** concept.
- [IBM Plex Mono](https://www.ibm.com/plex/).
- [Victor Mono](https://rubjo.github.io/victor-mono/).
## Maintainer
> Hi 👋, I'm **[Wuelner](https://linktr.ee/wuelnerdotexe)**, a **software developer from Guatemala**, passionate about creating minimalist solutions using solid fundamentals focused on **"how things should be"**.
## License
[GPL-3.0 © Wuelner Martínez.](https://github.com/wuelnerdotexe/nvim/blob/main/LICENSE)
With 💖 from LATAM to the world!
.png)
.png)