mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-20 16:15:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

wrappers: make helpers available via lib option

Browse source 
NixOS, HM, & Darwin provide a `lib` option, not to be confused with the
`lib` module arg.

This option is intended for modules to define custom functions without
having to extend nixpkgs lib.

The old option is renamed, if it is accessed it will print:

    trace: Obsolete option `nixvim.helpers' is used. It was renamed to `lib.nixvim'.
This commit is contained in:
Matt Sturgeon 2024-07-08 05:12:24 +01:00
parent 0ac10f6776
commit 216d64c158
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
2 changed files with 17 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/user-guide/helpers.md
View file

@ -10,12 +10,12 @@ If Nixvim is built using the standalone method, you can access our `helpers` as
```
If Nixvim is being used as as a home-manager module, a nixos module, or as a dawwin module,
helpers can be accessed via the `config.nixvim.helpers` option:
helpers can be accessed via the `config.lib` option:
```nix
{ config, ... }:
let
inherit (config.nixvim) helpers;
helpers = config.lib.nixvim;
in
{
# Your config

26
wrappers/_shared.nix
View file

@ -29,20 +29,24 @@ let
extraFiles = lib.filter (file: file.enable) (lib.attrValues cfg.extraFiles);
in
{
options = {
nixvim.helpers = mkOption {
type = mkOptionType {
name = "helpers";
description = "Helpers that can be used when writing nixvim configs";
check = isAttrs;
};
description = "Use this option to access the helpers";
};
};
# TODO: Added 2024-07-24; remove after 24.11
imports = [
(lib.mkRenamedOptionModule
[
"nixvim"
"helpers"
]
[
"lib"
"nixvim"
]
)
];
config = mkMerge [
# Make our lib available to the host modules
{ nixvim.helpers = lib.mkDefault (import ../lib/helpers.nix { inherit pkgs lib; }); }
# TODO: import top-level ../lib
{ lib.nixvim = lib.mkDefault (import ../lib/helpers.nix { inherit pkgs lib; }); }
# Propagate extraFiles to the host modules
(optionalAttrs (filesOpt != null) (
mkIf (!cfg.wrapRc) (