Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nixos/yazi: support plugins and flavors #295846

Merged
merged 2 commits into from
May 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 51 additions & 12 deletions nixos/modules/programs/yazi.nix
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ let

settingsFormat = pkgs.formats.toml { };

names = [ "yazi" "theme" "keymap" ];
files = [ "yazi" "theme" "keymap" ];
in
{
options.programs.yazi = {
Expand All @@ -15,7 +15,7 @@ in

settings = lib.mkOption {
type = with lib.types; submodule {
options = lib.listToAttrs (map
options = (lib.listToAttrs (map
(name: lib.nameValuePair name (lib.mkOption {
inherit (settingsFormat) type;
default = { };
Expand All @@ -25,26 +25,65 @@ in
See https://yazi-rs.github.io/docs/configuration/${name}/ for documentation.
'';
}))
names);
files));
};
default = { };
description = ''
Configuration included in `$YAZI_CONFIG_HOME`.
'';
};

initLua = lib.mkOption {
type = with lib.types; nullOr path;
default = null;
description = ''
The init.lua for Yazi itself.
'';
example = lib.literalExpression "./init.lua";
};

plugins = lib.mkOption {
type = with lib.types; attrsOf (oneOf [ path package ]);
default = { };
description = ''
Lua plugins.

See https://yazi-rs.github.io/docs/plugins/overview/ for documentation.
'';
example = lib.literalExpression ''
{
foo = ./foo;
bar = pkgs.bar;
}
'';
};

flavors = lib.mkOption {
type = with lib.types; attrsOf (oneOf [ path package ]);
default = { };
description = ''
Pre-made themes.

See https://yazi-rs.github.io/docs/flavors/overview/ for documentation.
'';
example = lib.literalExpression ''
{
foo = ./foo;
bar = pkgs.bar;
}
'';
};

};

config = lib.mkIf cfg.enable {
environment = {
systemPackages = [ cfg.package ];
variables.YAZI_CONFIG_HOME = "/etc/yazi/";
etc = lib.attrsets.mergeAttrsList (map
(name: lib.optionalAttrs (cfg.settings.${name} != { }) {
"yazi/${name}.toml".source = settingsFormat.generate "${name}.toml" cfg.settings.${name};
})
names);
};
environment.systemPackages = [
(cfg.package.override {
inherit (cfg) settings initLua plugins flavors;
})
];
};

meta = {
maintainers = with lib.maintainers; [ linsui ];
};
Expand Down
2 changes: 1 addition & 1 deletion pkgs/by-name/ya/yazi-unwrapped/package.nix
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ rustPlatform.buildRustPackage rec {
description = "Blazing fast terminal file manager written in Rust, based on async I/O";
homepage = "https://github.com/sxyazi/yazi";
license = lib.licenses.mit;
maintainers = with lib.maintainers; [ xyenon matthiasbeyer ];
maintainers = with lib.maintainers; [ xyenon matthiasbeyer linsui ];
mainProgram = "yazi";
};
}
45 changes: 43 additions & 2 deletions pkgs/by-name/ya/yazi/package.nix
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
, makeWrapper
, yazi-unwrapped

, withRuntimeDeps ? true
, withFile ? true
, file
, withJq ? true
Expand All @@ -21,10 +22,16 @@
, fzf
, withZoxide ? true
, zoxide
, settings ? { }
, formats
, plugins ? { }
, flavors ? { }
, initLua ? null
}:

let
runtimePaths = with lib; [ ]
runtimePaths = with lib;
[ ]
++ optional withFile file
++ optional withJq jq
++ optional withPoppler poppler_utils
Expand All @@ -34,7 +41,40 @@ let
++ optional withRipgrep ripgrep
++ optional withFzf fzf
++ optional withZoxide zoxide;

settingsFormat = formats.toml { };

files = [ "yazi" "theme" "keymap" ];

configHome = if (settings == { } && initLua == null && plugins == { } && flavors == { }) then null else
runCommand "YAZI_CONFIG_HOME" { } ''
mkdir -p $out
${lib.concatMapStringsSep
"\n"
(name: lib.optionalString (settings ? ${name} && settings.${name} != { }) ''
ln -s ${settingsFormat.generate "${name}.toml" settings.${name}} $out/${name}.toml
'')
files}

mkdir $out/plugins
${lib.optionalString (plugins != { }) ''
${lib.concatMapStringsSep
"\n"
(lib.mapAttrsToList (name: value: "ln -s ${value} $out/plugins/${name}") plugins)}
''}

mkdir $out/flavors
${lib.optionalString (flavors != { }) ''
${lib.concatMapStringsSep
"\n"
(lib.mapAttrsToList (name: value: "ln -s ${value} $out/flavors/${name}") flavors)}
''}


${lib.optionalString (initLua != null) "ln -s ${initLua} $out/init.lua"}
'';
in
if (!withRuntimeDeps && configHome == null) then yazi-unwrapped else
runCommand yazi-unwrapped.name
{
inherit (yazi-unwrapped) pname version meta;
Expand All @@ -44,5 +84,6 @@ runCommand yazi-unwrapped.name
mkdir -p $out/bin
ln -s ${yazi-unwrapped}/share $out/share
makeWrapper ${yazi-unwrapped}/bin/yazi $out/bin/yazi \
--prefix PATH : "${lib.makeBinPath runtimePaths}"
${lib.optionalString withRuntimeDeps "--prefix PATH : \"${lib.makeBinPath runtimePaths}\""} \
${lib.optionalString (configHome != null) "--set YAZI_CONFIG_HOME ${configHome}"}
''