Migrating from nixcats - "definition for option data is not of type null..."

[mettavi]

Hi, I have been using nixcats using the lazy template, but I would now like to remove lazy.nvim completely using the neovim wrapper from nix-wrapper-modules.

I am trying to implement this as a home-manager module. I am running home-manager as a module of nixos.

I started using the code from https://birdeehub.github.io/nix-wrapper-modules/md/getting-started.html#nixos-home-manager-and-friends along with code from the neovim template at https://github.com/BirdeeHub/nix-wrapper-modules/tree/main/templates/neovim

At first I had a lot of errors, so I decided to get it working with a minimal example first. Here is the code I managed to get working:

# nvim-wrap/default.nix
{
  config,
  inputs,
  lib,
  ...
}:
with lib;
let
  cfg = config.mettavi.shell.nvim-lib;
in
{
  # import the neovim wrapper module
  imports = [
    (inputs.wrappers.lib.getInstallModule {
      name = "neovim";
      value = inputs.wrappers.lib.wrapperModules.neovim;
    })
  ];

  options.mettavi.shell.nvim-lib = {
    enable = mkEnableOption "set up and configure the nvim wrapper module";
    cats = lib.mkOption {
      readOnly = true;
      type = lib.types.attrsOf lib.types.bool;
      default = builtins.mapAttrs (_: v: v.enable) config.specs;
    };
  config = mkIf cfg.enable {
    wrappers.neovim =
      { pkgs, ... }:
      {
        enable = true;
        env.NVIM_APPNAME = "nvim-wrap";
        # If you want to install multiple neovim derivations via home.packages or environment.systemPackages
        # in order to prevent path collisions:
        # set this to true:
        settings.dont_link = true;
        # and make sure these dont share values:
        binName = "nvw";
        # settings.aliases = [ ];

        settings.config_directory = ./config;

        specs.stylix = {
          data = with pkgs.vimPlugins; [
            mini-base16
            lazydev-nvim
          ];
          before = [ "INIT_MAIN" ];
          config = /* lua */ ''
            local info, pname, lazy = ...
            require("mini.base16").setup({ palette = info, })
          '';
        };
      };

    xdg.configFile = {
      "nvim-wrap".source = ./config;
    };
  }
 
  };
}

So, it works using specs.stylix, but anything else causes an error. When I add the following:

        specs.lua = {
          after = [ "lazy" ];
          lazy = true;
          data = with pkgs.vimPlugins; [
            lazydev-nvim
          ];
          extraPackages = with pkgs; [
            lua-language-server
            stylua
          ];
        };

I get the following error:

       error: A definition for option `home-manager.users.timotheos.wrappers.neovim.specs.lua.data' is not of type `null or str|path|drv or list of spec with main field: `data` of (null or str|path|drv)'. Definition values:
       - In `/nix/store/d5ndqy86a9is1wjyickly0xr5v94h2r7-source/home/shared/modules/shell/nvim-wrap':
           {
             after = [
               "lazy"
             ];
             data = [
           ...

I get the same error if I add specs.bash, specs.nix, or anything else.

Now, I am sure I am making a silly mistake here, can anyone help me solve this problem?

[nikoof]

Hey, I'm running into a similar issue trying to migrate from nixCats. I'm not a Nix expert by any means, but as far as I can see the problem is caused by setting extraPackages in a spec, which doesn't conform to its type. The documentation doesn't mention the attribute extraPackages for specs.<name> either, so it seems to only be a top-level attribute on the module. I'm not sure if the template is somehow stale, or if I am also missing something.

One other idea I had was to use the top-level extraPackages with lib.lists.optionals to add the packages, since the documentation says that specs.<name>.enable is an option. This seems to work, but I'm not sure how you're supposed to set this from outside the module declaration (which could very well be because I am fundamentally misunderstanding how this entire system is supposed to work). Can anyone clarify what is the intended way to conditionally include stuff like LSPs and formatters?

[BirdeeHub]

Oh! yep

That is probably it.

extraPackages is not something defined on the specs by default. You have to do that yourself. You can add anything you want to those specs, but the things you pass need to be valid

It is mentioned in the neovim Tips and Tricks section, and also it is shown in the template!

nix-wrapper-modules/templates/neovim/module.nix

Lines 167 to 202 in dc51840

	# These are from the tips and tricks section of the neovim wrapper docs!
	# https://birdeehub.github.io/nix-wrapper-modules/neovim.html#tips-and-tricks
	# We could put these in another module and import them here instead!
	# This submodule modifies both levels of your specs
	config.specMods =
	{
	# When this module is ran in an inner list,
	# this will contain `config` of the parent spec
	parentSpec ? null,
	# and this will contain `options`
	# otherwise they will be `null`
	parentOpts ? null,
	parentName ? null,
	# and then config from this one, as normal
	config,
	# and the other module arguments.
	...
	}:
	{
	# you could use this to change defaults for the specs
	# config.collateGrammars = lib.mkDefault (parentSpec.collateGrammars or false);
	# config.autoconfig = lib.mkDefault (parentSpec.autoconfig or false);
	# config.runtimeDeps = lib.mkDefault (parentSpec.runtimeDeps or false);
	# config.pluginDeps = lib.mkDefault (parentSpec.pluginDeps or false);
	# or something more interesting like:
	# add an extraPackages field to the specs themselves
	options.extraPackages = lib.mkOption {
	type = lib.types.listOf wlib.types.stringable;
	default = [ ];
	description = "a extraPackages spec field to put packages to suffix to the PATH";
	};
	# You could do this too
	# config.before = lib.mkDefault [ "INIT_MAIN" ];
	};
	config.extraPackages = config.specCollect (acc: v: acc ++ (v.extraPackages or [ ])) [ ];

In the above template, using the created extraPackages on the specs will allow you to enable or disable packages alongside those specs, as the values from config.specCollect have been filtered already.

config.specMods = {
  options.extraPackages = lib.mkOption { 
    type = lib.types.listOf wlib.types.stringable; 
    default = [ ]; 
    description = "a extraPackages spec field to put packages to suffix to the PATH"; 
  };
};
config.extraPackages = config.specCollect (acc: v: acc ++ (v.extraPackages or [ ])) [ ]; 

[nikoof]

Ah, I was a bit impatient and didn't read the entire thing, my bad. This makes a lot more sense now. Thanks a lot for the help!

[BirdeeHub]

Thanks for chiming in, I think you pointed out what was wrong for the other user too. I had only skimmed it and had not noticed yet but you pointed it out well.