nixCats-nvim: for the Lua-natic's neovim config on nix!

Table of Contents:

1. Introduction
2. Features
3. Installation
4. Extra Information
5. Alternative / Similar Projects
   • nixcats.org: Table of Contents

Introduction:

nixCats is a neovim package manager written in nix that allows for using a normal config directory structure without sacrificing the ability to easily pass data from nix to lua.

It can be configured in a flake, as a derivation, or as a module, can be set up so that you can have normal lua reloading while editing, and allows you to easily output multiple configured packages that are variations of your main config.

Unlike nixvim, whose goal is to nixify everything neovim they can, nixCats takes the opposite approach. Make it as easy to interact with the normal scheme as possible while using nix to install things, and add useful meta features in nix in addition to your normal neovim config that can be optionally used.

The end result ends up being very comparable if not better than using a regular neovim package manager + mason, and certainly has more overall capability to be ran in a portable way.

In this way, it avoids falling into the classic trap of trying to make a module for every plugin somebody might want to use. The neovim plugin ecosystem is very large, and updates are often. This leads to a lot of time spent doing simple translations of lua options to nix options and then maintaining them. Things are missed, new plugins are released that people now have to use a completely different pattern to install due to not yet being included. Problems like this occur because of the size of the task.

It leads to a higher quality experience to interact with the plugin ecosystem as it is, while needing only a single nix file to effectively manage your neovim installations. In addition, this means you can make use of the amazing auto completion and other nice features that one can usually use in a neovim configurations.

But it is only nicer if you have an easy way to get info from nix to wherever you need it.

This is where home-manager and pkgs.wrapNeovim start to fall short. It is not uncommon to see a mess of global variables written in nix strings, and a bunch of files called via dofile that are not properly detected by neovim tooling with these methods.

Nix is for downloading. Lua is for configuring.

But to pass info from nix to lua, you must ''${interpolate a string}'';. So you need to write some lua in strings in nix. Right?

Not anymore you don't!

If you like the normal neovim configuration scheme, but want your config to be runnable via nix run and have an easier time dealing with dependency issues, this repo is for you.

Even if you don't use it for downloading plugins at all, preferring to use lazy and mason and deal with issues as they arise, this scheme will have useful things for you.

It allows you to provide a configuration and any dependency you could need to your neovim in a contained and reproducible way, buildable separately from your nixos or home-manager config.

The example neovim config here is a great example of how to use nixCats for yourself.

You should stop and take a moment to read the overview while looking at the above example configuration and/or the default template to get a feel of what this package management scheme has to offer!

Everything in ./templates is also either a starter template, or more examples. The in-editor help will be available in any neovim that uses the nixCats builder, or at the website! There is significantly more help and example in this repository than there is actual functional code for the nixCats wrapper.

When you are ready, start with a template and include your normal configuration, and refer back here or to the in-editor help or the other templates for guidance!

All config folders like ftplugin/, pack/ and after/ work as designed (see :h rtp), if you want lazy loading put it in optionalPlugins in a category in the flake and call vim.cmd('packadd <pluginName>') from an autocommand or keybind when you want it.

For lazy loading in your configuration, I strongly recommend using lze or lz.n. The main example configuration here uses lze. They are not package managers, and work within the normal neovim plugin system, just like nixCats does.

However there is a lazy.nvim wrapper that can be used if desired, but follow that link and read the info about it before deciding to take that route. lazy.nvim is known for not playing well in conjunction with other package managers, so using it will require a little bit of extra setup compared to the 2 above options.

Attention:

You may launch your neovim built via nixCats with any name you would like to choose.

The default launch name is the package name in the packageDefinitions set in flake.nix for that package. You may then make any other aliases that you please as long as they do not conflict.

This means that your $EDITOR variable should match the name in your packageDefinitions set in flake.nix so that stuff like git opens the right thing, because that is what the desktop file is called.

If your aliases conflict and you try to install them both to your path via home.packages or environment.systemPackages, it will throw a collision error.

Nvim does not know about the wrapper script. It is still at <store_path>/bin/nvim and is aware of that. Thus, this should not cause any issues beyond the way nvim is normally wrapped via the wrappers in nixpkgs.

(remember to change your $EDITOR variable if you named your package something other than nvim!)

Features:

• Allows normal neovim configuration file scheme to be loaded from the nix store.
• Configure all downloads from a single nix file, use a regular neovim config scheme with full visibility of your nix!
• Easy-to-use Nix Category system for many configurations in 1 repository!
  • to use:
  • Make a new list in the set in the flake for it (i.e. if its a plugin you want to load on startup, put it in startupPlugins in categoryDefinitions)
  • enable the category for a particular neovim package in packageDefinitions set.
  • check for it in your neovim lua configuration with nixCats('attr.path.to.yourList')
• the nixCats command is your method of communicating with neovim from nix outside of installing plugins.
  • you can pass any extra info through the same set you define which categories you want to include.
  • it will be printed verbatim to a table in a lua file.
  • Not only will it be easily accessible anywhere from within neovim via the nixCats command, but also from your category definitions within nix as well for even more subcategory control.
• Can be configured as a:
  • flake
  • in another flake
  • as a nixos or home-manager module
  • entirely via calling the override function on a nixCats based package.
  • It can then be imported and reconfigured without duplication and exported again. And again. and again.
• blank flake template that can be initialized into your existing neovim config directory to get you started!
  • because you can mess around with it in its own repo in any directory, this is the lowest barrier of entry, and transitions well into any other template if desired.
• blank template that is called as a nix expression from any other flake.
  • It is simply the outputs function of the flake template above but as its own file, callable with your system's flake inputs, and returning all the normal flake outputs the other would have.
  • great for integrating into a system config and still being able to output the finished packages from your system flake.
• blank override template that achieves functionality the same as the above two, but entirely via using the override function on the example nvim package from the nixCats flake.
• blank module template that exports the configuration of your packages in module form, inherits values from your other template and can be reconfigured. Similar to override, but as a module.
• luaUtils template template containing the tools for detecting if nix loaded your config or not, and integrating with lazy.nvim or other plugin managers.
  • this is an optional, additional template.
  • proper useage of this template can yield a configuration that you can use both with or without nix.
  • contains the lazy.nvim wrapper.
• other templates containing examples of how to do other things with nixCats, and even one that implements the entirety of kickstart.nvim using the lazy wrapper! (for a full list see :help nixCats.templates)
• ability to call override as many times as you like to fully recustomize or combine packages
• Extensive in-editor help.
• I mentioned the templates already but if you want to see them all on github they are here: templates

Installation:

see :help nixCats.installation_options for more info, including a list of templates available (as well as a 100 line overview of what nixCats is and how to use it)

The installation info here is simply a repetition of the info there, and I would suggest viewing it there instead.

• to test:

  nix shell github:BirdeeHub/nixCats-nvim?dir=templates/example

Now, typing nixCats will open nixCats until you exit the shell.

Now that you are within an editor outfitted to edit a flake, you can access the help for nixCats by typing :help nixCats and choosing one of the options suggested by the auto-complete.

Now that you have access to the help and a nix lsp, to get started, first exit neovim. (but not the nix shell!)

In a terminal, navigate to your nvim directory and run your choice of the following commands at the top level of your neovim config:

(don't worry! It doesnt overwrite anything!)

• standalone flake template:

  nix flake init -t github:BirdeeHub/nixCats-nvim

• nixExpressionFlakeOutputs template:
  • for more advanced nix users
  • the outputs function of the flake template but as its own file callable with import ./the/dir { inherit inputs; } to recieve all normal flake outputs. Best used after the default template to integrate your new neovim config into an existing flake-based configuration's repository

  nix flake init -t github:BirdeeHub/nixCats-nvim#nixExpressionFlakeOutputs

If using zsh with extra regexing, be sure to escape the #

There are others which could be used to create a new base config, but these will be the simplest to start with, and don't inherit any previous config by default.

All such templates have more or less the same options, so converting between them is easy.

To add utilities for functionality without nix at lua/nixCatsUtils, also run the following at the top level of your neovim config:

  nix flake init -t github:BirdeeHub/nixCats-nvim#luaUtils

contains things like "is this nix?" "do this if not nix, else do that"

Needs to be in your config at lua/nixCatsUtils, because if you dont use nix to load neovim, nixCats (obviously) can't provide you with anything from nix!

The starter templates will create an empty version of flake.nix (or default.nix) for you to fill in.

If you are unfamiliar with neovim and want a ready-made starter config, you should instead use the following template:

  nix flake init -t github:BirdeeHub/nixCats-nvim#example

All templates will import the utils set and thus also the builder and help from nixCats-nvim itself.

If you added the luaUtils template, you should have that now too at lua/nixCatsUtils.

Re-enter the nixCats nvim version by typing nixCats . and take a look! Reference the help and nixCats-nvim itself as a guide for importing your setup. Typing :help nixCats without hitting enter will open up a list of help options for this scheme via auto-complete.

You add plugins to the flake.nix, call whatever setup function is required by the plugin wherever you want, and use lspconfig to set up lsps. You may optionally choose to set up a plugin only when that particular category is enabled in the current package by checking nixCats('your.cats.name') first.

see :h nixCats for help with the nixCats lua plugin.

It is a similar process to migrating to a new neovim plugin manager. Because you are.

Use a template and put the plugin names into the main nix file provided.

You can import them from nixpkgs or straight from your inputs via a convenience overlay :h nixCats.flake.inputs

Then configure in lua.

Use the help, and the example config here. The help will still be accessible in your version of the editor.

When you have your plugins added, you can build it using nix build and it will build to a result directory, or nix profile install to install it to your profile. Make sure you run git add . first as anything not staged will not be added to the store and thus not be findable by either nix or neovim. See nix documentation on how to use these commands further at: the nix command reference manual

When you have a working version, you can begin to explore the many options made available for importing your new nix neovim configuration into a nix system or home manager configuration. There are MANY, thanks to the virtues of the category scheme of this flake.

Extra Information:

Challenges:

Mason:

Mason does not work on nixOS although it does on other OS options.

Luckily you also don't need it. All mason does is download it to your path, and call lspconfig on the result.

You can do this via the lspsAndRuntimeDeps field in nixCats, and then calling lspconfig yourself.

The example config and :h nixCats.LSPs show examples of this, and the examples still run mason when nix wasn't used to load the config!

That way you can just add the lsp to the list in nix, add the same lua config you would have for mason, and move on.

However you can make it work with SharedLibraries and lspsAndRuntimeDeps options if you choose to not use those fields for their intended purpose! Sometimes it can be hard to tell what dependency the error is even asking for though.

lazy.nvim:

lze and lz.n, unlike lazy.nvim, are not plugin managers. They stick to the task of lazy loading and do it well, with a very similar plugin spec style to lazy.nvim They fit in much better with all nix solutions for nvim than lazy.nvim does.

If you do decide to use lazy.nvim, consider using the lazy.nvim wrapper in luaUtils template documented in :h luaUtils and demonstrated here. The luaUtils template also contains other simple tools that will help if you want your configuration to still load without nix involved in any way. You likely will not need to do that though. The nix package manager runs on any linux, mac, or WSL.

Lazy.nvim works but unless you tell it not to reset the RTP you will lose your config directory and treesitter parsers.

There is an included wrapper that you can use to do this and also stop it from downloading stuff you already downloaded via nix.

You call that instead. It takes 1 extra argument, and then the 2 standard lazy.setup arguments.

The first argument is the path to lazy.nvim downloaded from nix. If this is nil it will download lazy the normal way instead.

You can fetch this value with nixCats.pawsible({"allPlugins", "start", "lazy.nvim" }) unless your lazy.nvim has been given a different name.

Then in your specs, simply fix any names that were different from nix (see :NixCats pawsible for the new values) and disable build statements while on nix with the require('nixCatsUtils').lazyAdd function

Obviously if you chose to still download the plugins via lazy you would want to keep the build statements and instead add any non-plugin dependencies they need to your nix.

Keep in mind, lazy.nvim will prevent nix from loading any plugins unless you also add it to a lazy plugin spec

I highly recommend using one of the following 2 projects for lazy loading instead:

lz.n

lz.n exists and due to it working within the normal neovim plugin management scheme is better suited for managining lazy loading on nix-based configurations than lazy.nvim is.

lze

lze is my take on what lz.n did, after spending a decent amount of time contributing to lz.n to begin with.

I preferred a different design to the management of state and custom handlers, and quite like the result. The main example configuration in this repo uses it for lazy loading.

Special mentions:

For getting me started:

Many thanks to Quoteme for a great repo to teach me the basics of nix!!! I borrowed some code from it as well because I couldn't have written it better.

utils.standardPluginOverlay is copy-pasted from a section of Quoteme's repo.

Thank you!!! I literally did not even know what an overlay was yet and you taught me!

I also borrowed code from nixpkgs and made modifications and improvements to better fit nixCats.

Alternative / similar projects:

• kickstart.nvim: This project was the start of my neovim journey and I would 100% suggest it over this one to anyone new to neovim. It does not use Nix to manage plugins. Use nixCats after this one if you want to move your version of kickstart to nix.
• kickstart-nix.nvim: A project that, like this one, also holds to a normal neovim config structure. It is a template tutorial on using the raw, wrapNeovimUnstable function with no modifications. If nixCats feels like it is too far from the metal on the nix side of things for you and you want to build from the ground up, and you still want to be able to run it in nix shells, this is the way to go.
• NixVim: A Neovim module scheme semi-comparable to home manager for neovim. They try to have a module for as many packages as they can and do a great job, but you can always fall back to the programs.neovim syntax if something is missing.
• Luca's super simple: Definitely the simplest example I have seen thus far. I took it and ran with it, read a LOT of docs and nixpkgs source code and then made this. I mentioned it above in the special mentions. As someone with no exposure to functional programming, such a simple example was absolutely fantastic.
• nixPatch-nvim: Focused specifically for lazy.nvim. A cool unique concept, uses a zig program to parse lazy.nvim definitions to replace urls with the plugins you put in your nix lists at build time. Useage is somewhat similar to the lazy.nvim wrapper of nixCats in a standalone flake template, but without needing to explicitly pass in a nix-provided ignore list to the wrapper in your lua code itself. It obviously also does not have the categories, modules, multiple packages, the overriding scheme, etc.