How should I add plugins to yazi using the wrapper?

[Joao-Queiroga]

I read the docs but didn't understand what I should do to add plugins for yazi from nixpkgs our the yazi.lua file like I do in home-manager.

[BirdeeHub]

Excellent question

I don't use yazi, and looking at this wrapper side by side with the home manager module, I'll be honest, I have no idea.

It looked like package.plugins was it when I first reviewed, but I apparently did not review closely enough?

I didn't try to install any yazi plugins when I reviewed this wrapper.

It also literally does not handle the yazi/init.lua whatsoever

config.constructFiles.init = {
  relPath = "${config.binName}-config/init.lua";
  content = ''
  '';
};

or flavors

https://github.com/nix-community/home-manager/blob/a0bb0d11514f92b639514220114ac8063c72d0a3/modules/programs/yazi.nix#L272-L288

I usually catch this sort of stuff on review, but I think because it mentions plugins twice I thought it was handled?

I have opened an issue about it #395, hopefully the maintainer @apetrovic6 is able to help us out with adding it? Or if it is already possible clearing up how to do so and putting it in the docs?

But on first glance, it looks like we are just not provisioning those files at all

For now you would have to add it yourself with constructFiles for the init.lua and then probably link the plugins with config.buildCommmand to ${config.generatedConfig.placeholder}/plugins

[Joao-Queiroga]

the package.plugin in the wrapper is for the package.toml file wich is kind of a lockfile for the yazi package manager for plugins. basically just the github owner/repo thing like in neovim plugin managers like lazy.nvim.

the plugins in yazi are just in a plugin directory inside the config directory(ex: "~/.config/yazi/plugins") and each plugin is another dir with a main.lua file.

Thank you for your time answering my question an sorry for spelling mistakes(english is not my native language.

[BirdeeHub]

Oh. Hmmmm

Well that is not ideal I suppose then to be specifying that at all...

Hmmm

Im sorry I don't have a more satisfying answer to that at the moment.

It appears it is definitely not correct as-is, unfortunately. I can't easily do more than tell you how you would go about fixing it yourself at the moment. I would like to see if the maintainer is able to help us, and if not then I will have to look into it myself, which, I could probably do, but I have never used yazi before at all. If you figure out how to add it using constructFiles or buildCommand in the meantime, or some other method, do let us know, it would be greatly appreciated.

[Joao-Queiroga]

I did it.
dont know if is the best way to use it but here it is
ps: I am using flake-parts with import-tree

{inputs, ...}: {
  flake.wrappers.yazi = {
    pkgs,
    wlib,
    lib,
    config,
    ...
  }: let
    plugins = with pkgs.yaziPlugins; {
      smart-enter = smart-enter;
      drag = inputs.drag;
      gvfs = inputs.gvfs-yazi;
      git = git;
      starship = starship;
      full-border = full-border;
    };
    makePlugin = name: pluginDrv: {
      content = "";
      relPath = "${config.binName}-config/plugins/${name}.yazi";
      builder = ''
        mkdir -p "$(dirname "$2")"
        ln -s "${pluginDrv}" "$2"
      '';
      key = "plugin_${builtins.replaceStrings ["-"] ["_"] name}";
    };

    pluginConfigs = lib.mapAttrs makePlugin plugins;
  in {
    imports = [wlib.wrapperModules.yazi];
    constructFiles =
      pluginConfigs
      // {
        luaInit = {
          content =
            /*
            lua
            */
            ''
              require("starship"):setup()
              require("full-border"):setup()
              require("git"):setup()
              require("zoxide"):setup({
              	update_db = true,
              })
              require("gvfs"):setup()
            '';
          relPath = "${config.binName}-config/init.lua";
        };
      };
  };
}

also, the inputs used here are not flakes, they are github repos with flake = false.

[BirdeeHub]

We no longer need to sanitize the names for the options in constructFiles, key auto sanitizes and setting it is now strictly optional.

That being said

key = "plugin_${name}";

We probably still want to set key to prefix them to avoid collisions

But we at least do not need to sanitize them anymore.

And yes. this does also apply to flavors.

What we need is an option that does this for each probably.

Another problem, is this probably means their ya thing doesn't work with our solution... I wonder what can be done about that, can we tell ya to put its lockfile and plugins somewhere else? We can wrap it as well with wrapperVariants

[BirdeeHub]

I would also say that, we probably shouldnt be using constructFiles at all for the plugins

We aren't constructing the plugin files, we are simply linking them into place.

config.buildCommand.makePluginsAndFlavors = ''
  # generate some ln -s commands here
'';

For flavors, it appears they are also directories and not single files, so you would just handle both of them like that.

You may want to specify when that buildCommand segment runs also

config.buildCommand.makePluginsAndFlavors = {
  before = [ "constructFiles" ]; # <- by default constructFiles is the first of the 3 in modules.default
  data = ''
    # generate some ln -s commands here
  '';
};

[Joao-Queiroga]

I should also mention that the same apply to yazi flavors that are put in the flavors directory rather than the plugins directory.

[apetrovic6]

Hi, sorry for being MIA.
I'm not using any plugins in Yazi currently, so I'm not sure how that works.

I can take a look at how all of that works when I'm back home from a trip, and figure out how to implement it in the wrapper module.