mirror of
https://github.com/nix-community/nixvim.git
synced 2025-11-21 17:59:41 +01:00
f11c43612f
Rename the overlay arguments from the conventional `final: prev:` to the more explicit `lib: prevLib:`, reflecting that this overlay operates only on the Nixpkgs lib, rather than a full package set. Add a doccomment explaining how the overlay is intended to be applied (via `lib.extend`) and what each argument represents. Improved inline comments in the overlay.
40 lines
898 B
Nix
40 lines
898 B
Nix
{ flake }:
|
|
|
|
/**
|
|
Overlay function extending the Nixpkgs `lib` with Nixvim's additions.
|
|
|
|
This function is intended to be passed to `lib.extend`.
|
|
|
|
# Examples
|
|
|
|
Importing the file directly:
|
|
```
|
|
lib.extend (import ./overlay.nix { flake = nixvim; })
|
|
```
|
|
|
|
Using the overlay from flake outputs:
|
|
```
|
|
lib.extend nixvim.lib.overlay
|
|
```
|
|
|
|
# Inputs
|
|
|
|
`lib`
|
|
: The final lib instance; the fixpoint of all extensions, including this one.
|
|
|
|
`prevLib`
|
|
: The lib instance prior to applying this overlay.
|
|
*/
|
|
lib: prevLib: {
|
|
# Add Nixvim's section to the lib
|
|
nixvim = flake.lib.nixvim.override {
|
|
inherit lib;
|
|
_isExtended = true;
|
|
};
|
|
|
|
# Extend the maintainers set with Nixvim-specific maintainers
|
|
maintainers = prevLib.maintainers // import ./maintainers.nix;
|
|
|
|
# Extend lib.types with Nixvim's custom types
|
|
types = prevLib.types // import ./types.nix { inherit lib; };
|
|
}
|