Minimal Neovim flake

Warning

This project is a WIP and is not well documented. For now, the Neovim wrapper, basic options, and partially the README have been completed.

Philosophy

• Manage plugins and external dependencies using Nix and lazy-load with lz.n
• Configuration entirely in Lua
• Utilizes Neovim's built-in LSP client, with Nix managing language servers
• Usable on any device with Nix installed, regardless of system settings
• Uses a minimal set of plugins and leverages the latest capabilities of Neovim's nightly versions

Test drive

If you have Nix installed (with flakes enabled), you can test drive this by running:

$ nix run github:ary418/nvim-flake

Installation

Here's an example of minimal flake using this config

{
  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
    # Optionally, use a local path or your own fork for development
    #nvim-flake.url = "git+file:///path/to/local/repo";
    nvim-flake.url = "github:ary418/nvim-flake";
  };
  outputs = { nixpkgs, nvim-flake }@inputs: {
    nixosConfigurations.nixos = nixpkgs.lib.nixosSystem {
      specialArgs = { inherit inputs; lib = nixpkgs.lib; };
      modules = [
        (
          { inputs, pkgs, ... }:
          {
            environment.systemPackages = [
              inputs.nvim-flake.packages.${pkgs.system}.default
            ];
          }
        )
      ];
    };
  };
}

Design

Note

This section is pretty WIP

All plugins to install are listed in plugins.nix

Lua configs in the config/ directory

 config
├── plugin
│   └── init.lua # entry point of configuration plugin
└── lua
    ├── libx.lua # shared utility functions
    ├── asap.lua # things to do ASAP
    ├── autocmds.lua
    ├── mappings.lua
    ├── options # vim.opt assigments
    │   ├── appearance.lua # purely cosmetic settings
    │   ├── behavior.lua # behavior, such as files, buffers handling, etc.
    │   └── formatting.lua # formatting: auto-indent, tab size, etc.
    └── plugins # FIXME: implement and describe
        └── init.lua

How it works

• Symlinking: The config/ directory is symlinked to the packpath in default.nix. This setup allows you to run nix run on this flake from any location and launch Neovim with all your custom settings applied.
• Non-Overrideable via Nix Modules: Due to the way the configuration is structured, it cannot be overridden using Nix modules. This ensures that your custom settings remain intact and are not inadvertently changed by other parts of the system.

Nix-generated plugins

You can extend the default configuration by overriding the extraPlugins attribute. This allows you to add custom plugins that can utilize configuration options from your local setup.

For an example, let's configure mini.base16 with colors of Stylix

inputs.nvim-flake.packages.${pkgs.system}.default.override {
  extraPlugins = [
    pkgs.vimPlugins.mini-base16
    (pkgs.runCommandLocal "mini-base16-stylix" {} ''
      mkdir -pv $out/plugin
      tee $out/plugin/init.lua <<EOF
        require('mini.base16').setup {
          palette = {
          ${
            lib.concatMapAttrsStringSep
            "\n"
            (name: value: "${name} = '${value}',")
            (
              lib.filterAttrs
              (name: value:
                (lib.hasPrefix "base" name)
                && (builtins.stringLength name) == 6
              )
              config.lib.stylix.colors.withHashtag
            )
          }
          },
        }
      EOF
    '')
  ];
}

Credit

This flake was made following this awesome guide: https://ayats.org/blog/neovim-wrapper