lib.nixvim.modules: module functions

lib.nixvim.modules.evalNixvim

Evaluate Nixvim modules into a module system configuration.

Input

An attribute set with the following fields:

modules

An optional list of modules. These are merged together to form the final configuration.

extraSpecialArgs

An optional AttrSet, appended to specialArgs.

specialArgs is an attribute set of module arguments that can be used in imports. In contrast to config._module.args, which is only available after imports have been resolved.

Caution: relying on special args can make your modules less portable.

system

An optional string, used to define nixpkgs.hostPlatform.

Output

Returns a Nixvim configuration, as produced by lib.evalModules.

Notable attributes include:

config

The nested attribute set of all merged option values.

options

The nested attribute set of all option declarations.

type

A module system type. See: https://nixos.org/manual/nixpkgs/unstable/#module-system-lib-evalModules-return-value-type

extendModules

Extends the current configuration with additional modules. See: https://nixos.org/manual/nixpkgs/unstable/#module-system-lib-evalModules-return-value-extendModules

See Also

• Module System: https://nixos.org/manual/nixpkgs/unstable/#module-system
• lib.evalModules: https://nixos.org/manual/nixpkgs/unstable/#module-system-lib-evalModules

Located at lib/modules.nix:52 in <nixvim>.

lib.nixvim.modules.buildNixvim

Build a Nixvim package.

Inputs

input

One of:

1. A Nixvim module or a list of modules.
2. A Nixvim configuration.
3. A Nixvim package.

Output

An installable Nixvim package.

Located at lib/modules.nix:102 in <nixvim>.

lib.nixvim.modules.buildNixvimWith

Build a Nixvim package using the same interface as evalNixvim.

Output

An installable Nixvim package.

Located at lib/modules.nix:124 in <nixvim>.

lib.nixvim.modules.testNixvim

Build a Nixvim test derivation.

Inputs

input

One of:

1. A Nixvim module or a list of modules.
2. A Nixvim configuration.
3. A Nixvim package.

Output

A buildable Nixvim test.

Located at lib/modules.nix:143 in <nixvim>.

lib.nixvim.modules.testNixvimWith

Build a Nixvim test derivation using the same interface as evalNixvim.

Output

A buildable Nixvim test.

Located at lib/modules.nix:165 in <nixvim>.