README.md

tolerable-nvim-nix

Make your ~/.config/nvim/ portable with nix! This flake patches neovim to support absolute configuration paths, and exposes a nix function to create a package with your configuration baked in.

Tip

lazy.nvim / LazyVim works for the most part, however mason will not work under nix. Remove the part of your config that bootstraps lazy.nvim and add pkgs.vimPlugins.lazy-nvim to the list of plugins to keep using lazy

Read :h config for how to configure neovim.

Additionally, this flake adds a few checks to your config. The derivation will fail to build if any lua syntax errors are found or any vim.notify(..., vim.log.levels.ERROR)'s are thrown.

Getting Started

nix flake init -t github:wires-org/tolerable-nvim-nix#stable

nix flake init -t github:wires-org/tolerable-nvim-nix#nightly

You can now alter the example directory and use it exactly as you would your normal ~/.config/nvim/.

Note

If any plugins are causing your plugin to fail the checkPhase, disable them based on the presence of the environment variable TOLERABLE_CHECK, or disable the phase entirely with doCheck = false.

Example

Your configuration directory structure should look something like this:

~/my/neovim/config/
├── MY_APPNAME
│  ├── after
│  │  └── ...
│  ├── ftplugin
│  │  └── ...
│  ├── lua
│  │  └── ...
│  ├── queries
│  │  └── ...
│  └── init.lua
└── flake.nix

You should change MY_APPNAME to something unique for your neovim configuration. This prevents any collisions with other neovim configurations on systems.

# use makeNightlyNeovimConfig for nightly neovim
neovim = inputs.tolerable.makeNeovimConfig "MY_APPNAME" {
  inherit pkgs;
  # Use a fileset to prevent rebuilding neovim when files irrelevant to your configuration change.
  src = pkgs.lib.fileset.toSource {
    root = ./.;
    fileset = ./MY_APPNAME;
  };
  # passed to pkgs.neovimUtils.makeNeovimConfig
  config = {
    plugins = with pkgs.vimPlugins; [
      nvim-treesitter.withAllGrammars
      nvim-lspconfig
      # ...
    ];
  };
  # add packages to the path that will be available to neovim
  # (aka, LSP's)
  # some packages have different binary names, and lspconfig may have to be adjusted
  path = with pkgs; [
    lua-language-server
    nil
    prettierd
    # ...
  ];
};