nix-community/nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-11-21 17:59:41 +01:00
Code Activity

lib/overlay: rename and document overlay arguments

Browse source 
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.
This commit is contained in:
Matt Sturgeon 2025-11-20 03:09:13 +00:00
parent f5235d311e
commit f11c43612f
1 changed files with 33 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

40
lib/overlay.nix
View file

@ -1,14 +1,40 @@
{ flake }: { flake }:
final: prev: {
# Include our custom lib /**
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 { nixvim = flake.lib.nixvim.override {
lib = final; inherit lib;
_isExtended = true; _isExtended = true;
}; };
# Merge in our maintainers # Extend the maintainers set with Nixvim-specific maintainers
maintainers = prev.maintainers // import ./maintainers.nix; maintainers = prevLib.maintainers // import ./maintainers.nix;
# Merge in our custom types # Extend lib.types with Nixvim's custom types
types = prev.types // import ./types.nix { lib = final; }; types = prevLib.types // import ./types.nix { inherit lib; };
} }