nvim
nvim copied to clipboard
Allaman
Straightforward and pure Lua based Neovim configuration for my work as DevOps/Cloud Engineer with batteries included for Python, Golang, and, of course, YAML
My Neovim Configuration
💻 This configuration is working on my Manjaro Linux as well as on my macOS and requires Neovim dev build (0.8)!
Have a look at my rice how my Linux machine is configured and at my mac-setup how my MBP is configured. My dotfiles are also on Github.
Motivation
There is a number of great Neovim configurations online (see Inspiration) that give you a pleasant experience right out of the box. However, I am a long time (Neo)Vim user with a specific workflow and needs. Additionally, I do not have any Lua background and was not willing to spent too much time into that. Therefore, it was quite hard for me to customize and strip down the existing configs to my needs especially because the code is quite sophisticated.
I decided to move to my own fresh Lua based Neovim from my good old vimrc trying to accomplish the following principles.
Principles
- Migrate to Lua based alternative plugins respectively use only Lua based plugins (if possible).
- Keep the config as maintainable as possible knowing that this would possibly impact the code quality.
- Modular and meaningful directory structure and file naming.
- Just make it work and not make it beautiful 😃. Of course, Neovim itself must look beautiful but my focus is not on beautiful code or on utilizing all Lua features.
Try out
If you have Docker on your system you can try out this config via the provided Dockerfile
💡 All dependencies of my config are installed except texlab, tectonic, and vim-grammarous which makes it at 1.9GB a rather large image
Build the image
There are some issues with building a multi architecture Docker image via Github Action. Until I sorted that out, you can build the Docker image locally on your own
docker build -t nvim .
Just start nvim
docker run --name nvim --rm -it nvim
Mount a local directory (to ~/mount) and start nvim
docker run --name nvim --rm -it -v ${HOME}/tmp:/home/nvim/mount nvim
Start container in bash instead of nvim
docker run --name nvim --rm -it --entrypoint=/bin/bash nvim
Features
General ⚙️
- Package management and plugin configuration via Packer
- Mnemonic keyboard mappings inspired by Spacemacs via which-key.nvim; no more than three keystrokes for each keybinding
- Submodes powered by Hydra.nvim
- Fully featured status line via mini.nvim
- Terminal integration via nvim-toggleterm.lua
- Fancy notifications via nvim-notify
- Better writing with vale integration via null-ls
- Fast startup 🚀
Navigation 🧭
- Telescope.nvim for all your search needs
- Project management with Project.nvim
- File tree navigation/manipulation via nvim-tree
- Convenient Tmux navigation with your home row via Navigator.nvim
- LF integration via lf.vim for a full featured file manager in Neovim
- Convenient jumping through windows with nvim-window
Coding 🖥️
- Auto completion powered by nvim-cmp
- Built-in LSP configured via nvim-lspconfig
- Debugging for Go and Python via nvim-dap and friends
- Treesitter and Tresitter-textobjects for your syntax needs
- Auto formatting via null-ls.nvim
- Excellent Go support via LSP and go.nvim including sensible keybindings
- Git integration via Neogit, gitsigns, git-blame, and gitui
- Schema integration via LSPs for Kubernetes, package.json, github workflows, gitlab-ci.yml, kustomization.yaml, and more
- Always know where you are in your code via nvim-navic
- Outlining symbols with symbols-outline.nvim
- Snippets provided by Luasnip and friendly snippets with autocompletion
Structure
Each plugin to be installed is defined in plugins.lua and each plugin has its own configuration file (if necessary) in lua/config/ which is loaded by packer.
.
├── after
│ └── ftplugin # file specific settings
├── init.lua # main entry point
├── lua
│ ├── config/ # each plugin configuration is in its own file
│ ├── autocmd.lua # autocommands
│ ├── functions.lua # lua functions to extend functionality
│ ├── mappings.lua # Vim keymaps definitions -> config/which.lua for more
│ ├── options.lua # non plugin related (vim) options
│ ├── plugins.lua # define plugins to be managed via Packer
│ └── user-conf.lua # parameters to configure some settings
├── plugin # packer_compiled
├── snippets # snippets directory (luasnip style)
└── spell # my spell files linked from another repo
Bindings
| Mode | key | binding |
|---|---|---|
| n | space | Leader key |
| n | ⬆ ⬇ ⬅ ➡ | Resize panes |
| n | <c-h | j | k | l> | Change pane focus (including Tmux panes) |
| n | <leader>Tab | Switch to previously opened buffer |
| n | <Tab> | Switch to next buffer (bnext) |
| n | <S-Tab> | Switch to previous buffer (bprev) |
| n | st | Visual selection with Treesitter hint textobject |
| v | sa | Add surrounding |
| n | sd | Delete surrounding |
| n | sr | Replace surrounding |
| v | ga | Easyalign |
| n | gcc | Toggle line comment |
| n/v | gc | Toggle line comment (works with movements like gcip) |
| n | ss | Search 2 char forward (lightspeed) |
| n | S | Search 2 char backward (lightspeed) |
| i/s | <c-j> | Luasnip expand/forward |
| i/s | <c-k> | Luasnip backward |
| i | <c-h> | Luasnip select choice |
| n | <c-n> | Toggleterm (opens/hides a full terminal in Neovim) |
| i | <c-l> | Move out of closing bracket |
| n | <CR> | Start incremental selection |
| v | <Tab> | Increment selection |
| v | <S-Tab> | Decrement selection |
Which-key leader key clusters
Mappings are clustered according to their topic/tool.
See ./lua/config/which.lua for details.
| key | cluster |
|---|---|
| b | Buffer management |
| c | Language specific actions (only in Go, e.g. run tests) |
| d | Debugging |
| f | File management |
| g | Git actions |
| l | LSP integration (only when a LSP is attached) |
| m | Misc stuff |
| q | Quickfix |
| s | Searching |
| w | Window management |
| x | Languagetool integration |
| z | Spell bindings |
User configuration (experimental)
The intention of my Neovim configuration was never to be a fully customizable "distribution" like LunarVim, SpaceVim, etc but from time to time I like to change my color scheme and the idea of making this configurable came to my mind. Based upon this idea I implemented some further lightweight configuration options that might be useful.
All options can be found in ./lua/user-conf.lua.
Remove plugins
Basically, you can remove unwanted plugins by just removing the appropriate line in ./lua/plugins.lua and, if applicable, delete its configuration file in ./lua/config/.
ℹ️ Keep in mind that some plugins are configured to work in conjunction with other plugins. For instance, autopairs is configured in ./lua/config/treesitter.lua. For now there is no logic implemented that cross-checks such dependencies.
Add plugins
If you want to follow my method adding a plugin is straight forward:
In lua/plugins.lua add the plugin to Packer. You are free to use a name for the configuration file (should be a valid filename).
use {"<Address-of-the-plugin>", config = get_config("<name-of-the-plugin>")}
Create lua/config/<name-of-the-plugin>.lua where you put the plugins settings. If your plugin does not require additional configuration or loading you can omit the config part.
Open another instance of Neovim (I always try to keep one running instance of Neovim open in case I messed up my config) and run PackerSync.
Requirements
There are some tools that are required in order to use some features/plugins:
Tools
LSPs, Formatting, Linters, DAP
The following programs should be installed on your system so that the appropriate tools can be installed:
- Go
- Python
- NodeJs > 12
- Cargo
Go
Go related dependencies are managed by go.nvim and are installed by running :GoInstallBinaries (when a Go file is loaded). They are installed in your $GOPATH.
All other
All other dependencies are managed by Mason and Mason tool installer. Tools are installed by running :MasonToolsInstall (in vim.fn.stdpath("data") .. "mason"). Mason requirements must be available on your system.
For advanced spell checks via vim-grammarous Java 8+ is required
Allaman