Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/optixal/neovim-init.vim
:izakaya_lantern: A hybrid Neovim configuration for productive developers who want a functional yet aesthetic Vim experience :izakaya_lantern:
https://github.com/optixal/neovim-init.vim
autocomplete best clean configuration custom customizable init-lua init-vim lua minimal neovim neovim-config nvim plugins productive productivity theme tools vim vimrc
Last synced: 25 days ago
JSON representation
:izakaya_lantern: A hybrid Neovim configuration for productive developers who want a functional yet aesthetic Vim experience :izakaya_lantern:
- Host: GitHub
- URL: https://github.com/optixal/neovim-init.vim
- Owner: Optixal
- Created: 2017-10-14T10:28:43.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-21T11:07:43.000Z (over 1 year ago)
- Last Synced: 2024-09-29T06:04:27.984Z (about 1 month ago)
- Topics: autocomplete, best, clean, configuration, custom, customizable, init-lua, init-vim, lua, minimal, neovim, neovim-config, nvim, plugins, productive, productivity, theme, tools, vim, vimrc
- Language: Lua
- Homepage:
- Size: 1.19 MB
- Stars: 1,003
- Watchers: 15
- Forks: 202
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Optixal's Neovim init.vim
_Windows 10, Ubuntu WSL - Windows Terminal_
_Ubuntu 22.04 - Kitty Terminal_
Just like how a 🔪 is undoubtedly the most important tool of a sushi chef, a text editor (and perhaps a good mechanical keyboard) is undoubtedly the most important tool of a developer. It has to be robust, versatile, extensible, performant and powerful. Occasionally, it requires sharpening in order to produce quality work one is proud of. Also, it has to look and feel good in hand so that one will enjoy using it on every use.
My neovim config has been updated for neovim 0.7.0. It is now a hybrid init.vim with lua support. It features core plugins including [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter), [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig), [nvim-cmp](https://github.com/hrsh7th/nvim-cmp), [telescope](https://github.com/nvim-telescope/telescope.nvim), [lualine](https://github.com/nvim-lualine/lualine.nvim) and [nvim-tree](https://github.com/kyazdani42/nvim-tree.lua).
The colorsheme used is my favorite, [Dracula](https://github.com/dracula/vim), and the font used is my favorite too, [Iosevka](https://github.com/be5invis/Iosevka).
## Installing and Updating
### Automated Installation
```sh
git clone https://github.com/Optixal/neovim-init.vim.git
cd neovim-init.vim/convenience
./install.sh
```
Automatically installs my configuration along with dependencies into your system. Tested on Ubuntu 22.04. I highly suggest reading and understanding each line of the installation script before running it, especially if you are using other Linux distros, or macOS. For macOS, manually run the commands, and use `homebrew` instead of `apt`.
### Manual Installation
The following are high-level steps to install my neovim config:
1. Download this repo
2. Install dependencies: wget, curl, git, gcc, ripgrep and python3 (along with pip and venv)
3. Install [neovim 0.7.0+](https://github.com/neovim/neovim)
4. Add neovim to your PATH
5. Install node (with nvm or n) (along with npm)
6. Install [language servers](https://github.com/nvim-treesitter/nvim-treesitter#supported-languages) with npm
7. Set up a virtual environment for Python dependencies with venv, and install Python dependencies while in it with pip
8. Install [vim-plug](https://github.com/junegunn/vim-plug)
9. Make a copy of this repo's `init.vim` and place it in `~/.config/nvim/`. Delete everything after `call plug#end()`
10. Install plugins by entering neovim and running the command `:PlugInstall`
11. Copy this repo's full version of `init.vim` and the directory `lua/` to `~/.config/nvim/`
12. Done!
For exact commands to run, refer to `convenience/install.sh`.
### Post Installation
#### Download and install a Nerd Font
nvim-cmp, telescope, lualine and nvim-tree require a patched font to display icons properly. [Nerd Fonts](https://github.com/ryanoasis/nerd-fonts) are recommended. Run `./font_install.sh` to download and install Iosevka Term Nerd Font into your `~/.fonts` directory, or run the command manually:
```sh
curl -fLo ~/.fonts/Iosevka\ Term\ Nerd\ Font\ Complete\ Mono.ttf --create-dirs https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/Iosevka/Regular/complete/Iosevka%20Term%20Nerd%20Font%20Complete%20Mono.ttf
fc-cache -rv
```
Once downloaded, open your terminal's preferences and change the font to "Iosevka Term Mono". If your terminal allows to differentiate the regular, bold, italics and bold-italics, make sure to download the other variations as well.
If the font does not appear in your terminal settings, try restarting your terminal. If it's still not appearing, your OS' font directory may not be `~/.fonts`. Find out which directory your fonts are stored in, and place the downloaded font file in that directory instead. Or, install the font normally using your OS' GUI.
If you are using a GPU-accelerated terminal like kitty, or if the font starts to look weird in your terminal, it could be better to [avoid using a Nerd Font and use the original font instead](https://sw.kovidgoyal.net/kitty/faq/?highlight=nerd#kitty-is-not-able-to-use-my-favorite-font), while still using a single Nerd Font as the fallback for the symbols.
So, instead of installing:
* Iosevka Term Nerd Font Mono (Regular, Bold, Italics, Bold-Italics) (Characters & symbols will be used)
Install this:
* Iosevka (Regular, Bold, Italics, Bold-Italics) (Characters will be used)
* Iosevka Term Nerd Font Mono (Regular) (Symbols will be used)
Your terminal should pick up the symbols automatically from the single nerd font as the fallback font.
#### Install grammars and language servers
##### Grammar (for nvim-treesitter highlighting)
As I focus on Python development, I ensured installation of python grammar within `treesitter-config.lua` to get proper highlighting when editing Python files. To install additional grammars (e.g. TypeScript), run the following in nvim:
```
:TSInstall typescript
```
For other languages, refer to [this list](https://github.com/nvim-treesitter/nvim-treesitter#supported-languages).
##### Language server (for nvim-lspconfig and nvim-cmp completion)
As I focus on Python development, the installation script installs Python language server (pyright) by default. To install additional language servers (e.g. TypeScript):
```sh
npm install -g typescript-language-server
```
Then append it to the array of servers in the lua section of `init.vim`:
```lua
local servers = {
'pyright',
'tsserver',
}
```
For other language servers, refer to [this list](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md) to see the packages you need to install.
#### Alias vim
It may be easier for you to type `vim` instead of `nvim` everytime you edit a file, so aliasing it could save you some trouble. Add an alias to your bashrc/zshrc/somerc or aliases file to alias nvim to vim:
```sh
echo "alias vim='nvim'" >> ~/.zshrc
```
#### Fix nvim + tmux issues
Running nvim within a tmux session may cause certain unwanted issues like escape key lag, or displaying wrong colors. Run `cat .tmux.conf >> ~/.tmux.conf` or manually add these to your `~/.tmux.conf` configuration file to address the issues:
```sh
set -sg escape-time 5 # fix vim esc delay
set -g default-terminal "screen-256color" # ensures vim uses right $TERM color, default is "screen"
set -ga terminal-overrides ",*256col*:Tc" # fixes vim reproducing slightly wrong colors in tmux
```
#### Install and update plugins
Run these to install new plugins, update or delete existing plugins, or upgrade vim-plug itself.
* Install plugins: `:PlugInstall` in nvim. Run this after adding new plugins (e.g. `Plug 'username/repo'`) to init.vim
* Update plugins: `:PlugUpdate` in nvim
* Delete unused plugins: `:PlugClean` in nvim
* Update vim-plug itself: `:PlugUpgrade` in nvim
## Custom Mapped Commands in Normal Mode
Core:
* `,` - Map leader, nearly all my custom mappings starts with pressing the comma key
* `,q` or `\\` - Toggle sidebar filetree viewer (nvim-tree.lua)
* `,r` - Refresh/source ~/.config/nvim/init.vim
* `,t` - Trim all trailing whitespaces
* `,a` - Auto align variables (vim-easy-align), eg. do `,a=` while your cursor is on a bunch of variables to align their equal signs
* `,h` - Toggle rainbow parentheses highlighting (rainbow-parentheses.vim)
* `,j` - Set filetype to "journal" which makes the syntax highlighting beautiful when working on regular text files and markdown
* `,k` - Toggle coloring of hex colors
* `,l` - Toggle Limelight mode, highlight the lines near cursor only (Limelight)
* `,,` - Remove highlights (after searching with `/`)
* `` - Next buffer
* `` - Previous buffer
* `,$s` - New terminal in horizontal split
* `,$v` - New terminal in vertical split
Python:
* `,d` - Automatically generate Python docstrings while cursor is hovering above a Python function or class (vim-pydocstring and doq)
* `,x` - Auto format Python scripts (yapf)
Telescope:
* `,ff` - Find files
* `,fg` - Live grep from files
* `,fb` - Buffers
* `,fh` - Help tags
* `,fc` - Change colorscheme
* `,f/` - Fuzzy find current buffer
Other mappings:
* `,c` - Toggle comment for current line (Nerd Commenter)
* `` - Toggle RGB color picker (vCoolor) (uses GTK+, requires yad or zenity)
* [nvim-lspconfig mappings](https://github.com/neovim/nvim-lspconfig#suggested-configuration)