mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-21 00:25:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

lib/plugins: extract common logic for package options

Browse source 
Adds `mkPluginPackageModule`.
This commit is contained in:
Matt Sturgeon 2024-12-18 22:29:47 +00:00
parent 896f6be694
commit 690fc895b5
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
3 changed files with 58 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

43
lib/plugins/mk-neovim-plugin.nix
View file

@ -45,12 +45,7 @@ let
];
module =
{
config,
options,
pkgs,
...
}:
{ config, options, ... }:
let
cfg = lib.getAttrFromPath loc config;
opts = lib.getAttrFromPath loc options;
@ -77,30 +72,6 @@ let
{
enable = lib.mkEnableOption packPathName;
lazyLoad = lib.nixvim.mkLazyLoadOption packPathName;
package =
if lib.isOption package then
package
else
lib.mkPackageOption pkgs packPathName {
default =
if builtins.isList package then
package
else
[
"vimPlugins"
package
];
};
packageDecorator = lib.mkOption {
type = lib.types.functionTo lib.types.package;
default = lib.id;
defaultText = lib.literalExpression "x: x";
description = ''
Additional transformations to apply to the final installed package.
The result of these transformations is **not** visible in the `package` option's value.
'';
internal = true;
};
}
// lib.optionalAttrs hasSettings {
settings = lib.nixvim.mkSettingsOption {
@ -126,12 +97,7 @@ let
lib.mkIf cfg.enable (
lib.mkMerge (
[
{
inherit extraPackages;
extraPlugins = extraPlugins ++ [
(cfg.packageDecorator cfg.package)
];
}
{ inherit extraPackages extraPlugins; }
(lib.optionalAttrs (isColorscheme && colorscheme != null) {
colorscheme = lib.mkDefault colorscheme;
@ -194,7 +160,10 @@ in
settingsPath = loc ++ [ "settings" ];
in
imports
++ [ module ]
++ [
module
(lib.nixvim.plugins.utils.mkPluginPackageModule { inherit loc packPathName package; })
]
++ lib.optional deprecateExtraOptions (
lib.mkRenamedOptionModule (loc ++ [ "extraOptions" ]) settingsPath
)

41
lib/plugins/mk-vim-plugin.nix
View file

@ -51,12 +51,7 @@ let
};
module =
{
config,
options,
pkgs,
...
}:
{ config, options, ... }:
let
cfg = lib.getAttrFromPath loc config;
opts = lib.getAttrFromPath loc options;
@ -74,30 +69,6 @@ let
options = lib.setAttrByPath loc (
{
enable = lib.mkEnableOption packPathName;
package =
if lib.isOption package then
package
else
lib.mkPackageOption pkgs packPathName {
default =
if builtins.isList package then
package
else
[
"vimPlugins"
package
];
};
packageDecorator = lib.mkOption {
type = lib.types.functionTo lib.types.package;
default = lib.id;
defaultText = lib.literalExpression "x: x";
description = ''
Additional transformations to apply to the final installed package.
The result of these transformations is **not** visible in the `package` option's value.
'';
internal = true;
};
}
// settingsOption
// extraOptions
@ -106,10 +77,7 @@ let
config = lib.mkIf cfg.enable (
lib.mkMerge [
{
inherit extraPackages;
extraPlugins = extraPlugins ++ [
(cfg.packageDecorator cfg.package)
];
inherit extraPackages extraPlugins;
globals = lib.nixvim.applyPrefixToAttrs globalPrefix (cfg.settings or { });
}
(lib.optionalAttrs (isColorscheme && colorscheme != null) {
@ -130,7 +98,10 @@ in
settingsPath = loc ++ [ "settings" ];
in
imports
++ [ module ]
++ [
module
(lib.nixvim.plugins.utils.mkPluginPackageModule { inherit loc packPathName package; })
]
++ lib.optional (deprecateExtraConfig && createSettingsOption) (
lib.mkRenamedOptionModule (loc ++ [ "extraConfig" ]) settingsPath
)

46
lib/plugins/utils.nix
View file

@ -31,4 +31,50 @@
loc' = lib.toList (if isOrder then loc.content else loc);
in
lib.setAttrByPath loc' (withOrder def);
mkPluginPackageModule =
{
loc,
packPathName,
package,
}:
# Return a module
{ config, pkgs, ... }:
let
cfg = lib.getAttrFromPath loc config;
in
{
options = lib.setAttrByPath loc {
package =
if lib.isOption package then
package
else
lib.mkPackageOption pkgs packPathName {
default =
if builtins.isList package then
package
else if builtins.isString package then
[
"vimPlugins"
package
]
else
throw "Unexpected `package` type for `${lib.showOption loc}` expected (option, list, or string), but found: ${builtins.typeOf package}";
};
packageDecorator = lib.mkOption {
type = lib.types.functionTo lib.types.package;
default = lib.id;
defaultText = lib.literalExpression "x: x";
description = ''
Additional transformations to apply to the final installed package.
The result of these transformations is **not** visible in the `package` option's value.
'';
internal = true;
};
};
config = lib.mkIf cfg.enable {
extraPlugins = [ (cfg.packageDecorator cfg.package) ];
};
};
}