Unverified Commit 419fffed authored by Aleksana's avatar Aleksana Committed by GitHub
Browse files

Merge pull request #295846 from linsui/yazi

nixos/yazi: support plugins and flavors
parents 951f6c89 ced67348
Loading
Loading
Loading
Loading
+51 −12
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ let

  settingsFormat = pkgs.formats.toml { };

  names = [ "yazi" "theme" "keymap" ];
  files = [ "yazi" "theme" "keymap" ];
in
{
  options.programs.yazi = {
@@ -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 = { };
@@ -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};
    environment.systemPackages = [
      (cfg.package.override {
        inherit (cfg) settings initLua plugins flavors;
      })
        names);
    };
    ];
  };

  meta = {
    maintainers = with lib.maintainers; [ linsui ];
  };
+1 −1
Original line number Diff line number Diff line
@@ -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";
  };
}
+43 −2
Original line number Diff line number Diff line
@@ -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}"}
''