From 4826bc455d57af7cd75049ba3bf2f6a414a277bf Mon Sep 17 00:00:00 2001 From: linsui Date: Thu, 14 Mar 2024 18:40:47 +0800 Subject: nixos/yazi: support plugins and flavors --- nixos/modules/programs/yazi.nix | 61 +++++++++++++++++++++++++++++++++++++---- 1 file changed, 56 insertions(+), 5 deletions(-) diff --git a/nixos/modules/programs/yazi.nix b/nixos/modules/programs/yazi.nix index 5905f2afb946d..cfb26c01bfab5 100644 --- a/nixos/modules/programs/yazi.nix +++ b/nixos/modules/programs/yazi.nix @@ -5,7 +5,9 @@ let settingsFormat = pkgs.formats.toml { }; - names = [ "yazi" "theme" "keymap" ]; + files = [ "yazi" "theme" "keymap" ]; + + dirs = [ "plugins" "flavors" ]; in { options.programs.yazi = { @@ -15,7 +17,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 = { }; @@ -25,24 +27,73 @@ 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. + ''; + }; + + } // (lib.listToAttrs (map + (name: lib.nameValuePair name (lib.mkOption { + type = with lib.types; attrsOf (oneOf [ path package ]); + default = { }; + description = '' + Lua plugins. + + See https://yazi-rs.github.io/docs/${name}/overview/ for documentation. + ''; + })) + dirs) + ); + + 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 + etc = (lib.attrsets.mergeAttrsList (map (name: lib.optionalAttrs (cfg.settings.${name} != { }) { "yazi/${name}.toml".source = settingsFormat.generate "${name}.toml" cfg.settings.${name}; }) - names); + files)) // (lib.attrsets.mergeAttrsList (map + (dir: + if cfg.${dir} != { } then + (lib.mapAttrs' + (name: value: lib.nameValuePair "yazi/${dir}/${name}" { source = value; }) + cfg.${dir}) else { + # Yazi checks the directories. If they don't exist it tries to create them and then crashes. + "yazi/${dir}".source = pkgs.emptyDirectory; + }) + dirs)) // lib.optionalAttrs (cfg.initLua != null) { + "yazi/init.lua".source = cfg.initLua; + }; }; }; meta = { -- cgit 1.4.1 From ced6734812dd664e3a9ef870aafc4d5159bde25d Mon Sep 17 00:00:00 2001 From: linsui Date: Sun, 7 Apr 2024 22:54:18 +0800 Subject: yazi: add config files to wrapper --- nixos/modules/programs/yazi.nix | 44 +++++++++++------------------ pkgs/by-name/ya/yazi-unwrapped/package.nix | 2 +- pkgs/by-name/ya/yazi/package.nix | 45 ++++++++++++++++++++++++++++-- 3 files changed, 60 insertions(+), 31 deletions(-) diff --git a/nixos/modules/programs/yazi.nix b/nixos/modules/programs/yazi.nix index cfb26c01bfab5..d9f38d8d81185 100644 --- a/nixos/modules/programs/yazi.nix +++ b/nixos/modules/programs/yazi.nix @@ -6,8 +6,6 @@ let settingsFormat = pkgs.formats.toml { }; files = [ "yazi" "theme" "keymap" ]; - - dirs = [ "plugins" "flavors" ]; in { options.programs.yazi = { @@ -41,20 +39,24 @@ in description = '' The init.lua for Yazi itself. ''; + example = lib.literalExpression "./init.lua"; }; - } // (lib.listToAttrs (map - (name: lib.nameValuePair name (lib.mkOption { + plugins = lib.mkOption { type = with lib.types; attrsOf (oneOf [ path package ]); default = { }; description = '' Lua plugins. - See https://yazi-rs.github.io/docs/${name}/overview/ for documentation. + See https://yazi-rs.github.io/docs/plugins/overview/ for documentation. ''; - })) - dirs) - ); + example = lib.literalExpression '' + { + foo = ./foo; + bar = pkgs.bar; + } + ''; + }; flavors = lib.mkOption { type = with lib.types; attrsOf (oneOf [ path package ]); @@ -75,27 +77,13 @@ in }; 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}; - }) - files)) // (lib.attrsets.mergeAttrsList (map - (dir: - if cfg.${dir} != { } then - (lib.mapAttrs' - (name: value: lib.nameValuePair "yazi/${dir}/${name}" { source = value; }) - cfg.${dir}) else { - # Yazi checks the directories. If they don't exist it tries to create them and then crashes. - "yazi/${dir}".source = pkgs.emptyDirectory; - }) - dirs)) // lib.optionalAttrs (cfg.initLua != null) { - "yazi/init.lua".source = cfg.initLua; - }; - }; + environment.systemPackages = [ + (cfg.package.override { + inherit (cfg) settings initLua plugins flavors; + }) + ]; }; + meta = { maintainers = with lib.maintainers; [ linsui ]; }; diff --git a/pkgs/by-name/ya/yazi-unwrapped/package.nix b/pkgs/by-name/ya/yazi-unwrapped/package.nix index d0a0d77ecfec6..77a9b9ad8b5bb 100644 --- a/pkgs/by-name/ya/yazi-unwrapped/package.nix +++ b/pkgs/by-name/ya/yazi-unwrapped/package.nix @@ -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"; }; } diff --git a/pkgs/by-name/ya/yazi/package.nix b/pkgs/by-name/ya/yazi/package.nix index 134db023edd96..ee807645c3fd4 100644 --- a/pkgs/by-name/ya/yazi/package.nix +++ b/pkgs/by-name/ya/yazi/package.nix @@ -3,6 +3,7 @@ , makeWrapper , yazi-unwrapped +, withRuntimeDeps ? true , withFile ? true , file , withJq ? true @@ -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 @@ -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; @@ -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}"} '' -- cgit 1.4.1