Neovim

Neovim is a fork of Vim aiming to improve the codebase, allowing for easier implementation of APIs, improved user experience and plugin implementation.

Installation

With Home Manager

Home Manager has a module for Neovim, which can be enabled via

 programs.neovim = {
   enable = true;
   extraConfig = ''
     set number relativenumber
   '';
 };

More information about the module can be found here: Home Manager Manual.

System-wide

If you do not use Home Manager, you can use the following code in your NixOS configuration:

 programs.neovim = {
   enable = true;
   defaultEditor = true;
 };

You can also manually add Neovim to your packages. This should only be used if the two version above do not work for you.

  environment.systemPackages = [ pkgs.neovim ];

Configuration

Neovim shares most of its configuration with Vim. See the Vim page for more details on the use of both.

With Home Manager

The Home Manager module does not expose many configuration options. Therefore, the easiest way to get started is to use the extraConfig option. You can copy your old config or directly load your default Neovim config via:

 programs.neovim.extraConfig = lib.fileContents ../path/to/your/init.vim;

To use Neovim as your default editor, you can set the EDITOR environmental variable to "nvim" by adding the following to your NixOS configuration:

 environment.variables.EDITOR = "nvim";

The Home Manager module does also expose options to automatically add vi and vim aliases. To use them, add the following to your Home Manager configuration:

 programs.neovim = {
   viAlias = true;
   vimAlias = true;
 };

Installing Plugins

Plugins can be installed using the programs.neovim.plugins option. You can add only the plugin, or the plugin with its corresponding config:

 programs.neovim.plugins = [
   pkgs.vimPlugins.nvim-tree-lua
   {
     plugin = pkgs.vimPlugins.vim-startify;
     config = "let g:startify_change_to_vcs_root = 0";
   }
 ];

If you only add the plugin, you can add the configuration as described above.

An index of official packages can be found in on search.nixos.org. In addition to the official packages, there are several user maintained repositories, such as vim-extra-plugins or NixNeovimPlugins.

System-wide

The NixOS module does not have an extraConfig option as the Home Manager module does. Instead, you can use the programs.neovim.configure option as described here.

The following example configures RC commands and enables the plugin vim-nix to support syntax highlighting for Nix files

 programs.neovim = {
   enable = true;
   configure = {
     customRC = 
       set number
       set cc=80
       set list
       set listchars=tab:→\ ,space:·,nbsp:␣,trail:•,eol:¶,precedes:«,extends:»
       if &diff
         colorscheme blue
       endif
     ;
     packages.myVimPackage = with pkgs.vimPlugins; {
       start = [ vim-nix ];
     };
   };
 };

Similarly to the Home Manager module, to set Neovim as your default editor you have to set the EDITOR environment variable like this:

 environment.variables.EDITOR = "nvim";

Further, the NixOS module does also expose options to automatically add vi and vim aliases. To use them, add the following to your NixOS configuration:

 programs.neovim = {
   viAlias = true;
   vimAlias = true;
 };

Tips and tricks

Build Neovim using Nix

You can also compile Neovim using nix. For this, the Neovim GitHub page has more information on this: Neovim Guide.

The Neovim repository also contains a flake. You can run the master version via the following command:

nix run "github:neovim/neovim?dir=contrib"

Finally, there is a Neovim Nightly Overlay.

Note on Lua plugins

Due to how the `runtimepath` for Lua modules is processed, your configuration may require packadd! plugin-name to require a module. A home-manager example:

 programs.neovim = {
   plugins = [
     {
       plugin = nvim-colorizer-lua
       config = ''
         packadd! nvim-colorizer.lua
         lua require 'colorizer'.setup()
       '';
     }
   ];
 }

See Also

• Vim
• Treesitter for Neovim