nix-community.nixvim/lib/modules.nix

{
  lib,
  self,
}:
rec {
  # Build specialArgs for evaluating nixvim modules
  specialArgsWith =
    # TODO: switch defaultPkgs -> pkgsPath (i.e. pkgs.path or inputs.nixvim)
    # FIXME: Ideally, we should not require callers to pass in _anything_ specific
    { defaultPkgs, ... }@extraSpecialArgs:
    {
      inherit lib defaultPkgs;
      # TODO: deprecate `helpers`
      helpers = self;
    }
    // extraSpecialArgs;

  # Evaluate nixvim modules, checking warnings and assertions
  evalNixvim =
    {
      modules ? [ ],
      extraSpecialArgs ? { },
      check ? null, # TODO: Remove stub
    }@args:
    # TODO: `check` argument removed 2024-09-24
    # NOTE: this argument was always marked as experimental
    assert lib.assertMsg (!args ? "check")
      "`evalNixvim`: passing `check` is no longer supported. Checks are now done when evaluating `config.build.package` and can be avoided by using `config.build.packageUnchecked` instead.";
    lib.evalModules {
      modules = [ ../modules/top-level ] ++ modules;
      specialArgs = specialArgsWith extraSpecialArgs;
    };

  # TODO: Removed 2024-09-24
  getAssertionMessages = throw "`modules.getAssertionMessages` has been removed.";
}