How to insert lua code into a plugin's setupOpts

[mnpqraven]

I'm trying to pass a lua function into a plugin's (nvimTree in this case) setupOpts, which is the attach function
that remaps of some default keys. From the documentation it says i can pass in anything and i tried putting in the lua code as a string block but it didn't work. I just started using nix/nixOs for a week so i'm kinda lost on a lot of things and would appreciate some pointers, cheers!
This is what i had:

{
    programs.nvf.settings.vim.filetree.nvimTree = {
      enable = true;
      mappings = { toggle = "<C-\\>"; };
      setupOpts = {
        on_attach = ''
          function()
              local api = require "nvim-tree.api"

              local function opts(desc)
                  return { desc = "nvim-tree: " .. desc, buffer = bufnr, noremap = true, silent = true, nowait = true }
              end

              -- default mappings
              api.config.mappings.default_on_attach(bufnr)

              -- custom mappings
              vim.keymap.set("n", "<C-e>", "<cmd>:wincmd l<CR>", opts(""))
              vim.keymap.set("n", "e", function() end, opts(""))
              vim.keymap.set("n", "<C-n>", api.node.open.tab, opts("Edit in new tab"))
              vim.keymap.set("n", "<CR>", api.node.open.edit, opts("Edit"))
              vim.keymap.set("n", "<C-o>", api.node.open.edit, opts("Edit"))
              vim.keymap.set("n", "o", api.node.open.edit, opts("Edit"))
              vim.keymap.set("n", "<2-LeftMouse>", api.node.open.edit, opts("Edit"))
            end
        '';
      # rest of config
        };
      };
    };
}

[horriblename]

lua code has to be wrapped with lib.generators.mkLuaInline

on_attach = lib.generators.mkLuaInline ''
  function() 
   .... 
  end
''

[mnpqraven]

omg it works flawlessly, thank you so much for the help!

[Pierre-Thibault]

I don't get it. Something like this:

{
  programs.nvf = {
    enable = true;
    settings = {
      vim = {
        filetree.nvimTree.on_attach = lib.generators.mkLuaInline ''
            return {

It gives the error that on_attach does not exist.

[horriblename]

your code is cut off so I'm not sure what exactly you're trying to do, but as an example, to translate the following lua code to our nix option:

require('nvimtree').setup({
  enable_feature = true,
  foo = 3,
  on_attach = function()
    vim.keymap.set('n', '<leader>e', ':NvimTree<CR>')
    vim.keymap.set('n', '...', '...')
  end
})

when translated to our nix option:

# setup() arguments are by convention passed to setupOpts
vim.filetree.nvimTree.setupOpts = {
  # simple values can be translated to lua without problem
  enable_feature = true;
  foo = 3;

  # to write raw lua code:
  on_attach = lib.generators.mkLuaInline ''
    function()
      vim.keymap.set('n', '...')
      vim.keymap.set('n', '...')
    end
  '';
};

some key notes:

1. arguments passed to the plugin's setup() function are by convention put under setupOpts
2. when using mkLuaInline, you should make sure your lua code is an expression instead of statement(s)

[Pierre-Thibault]

Sorry for the cut-off. Here is my code file again:

return {
  {
    "catppuccin/nvim",
    name = "catppuccin",
    priority = 1000, -- Ensure it loads early to apply the colorscheme properly
    config = function()
      require("catppuccin").setup({
        flavour = "auto", -- Set the flavor to latte
        background = {    -- Optional: Match Vim's background setting
          light = "latte",
          dark = "mocha",
        },
        transparent_background = true, -- Optional: Set to true if you prefer no background color
        integrations = {  -- Optional: Enable integrations with AstroNvim plugins
          cmp = true,
          gitsigns = true,
          nvimtree = true,
          treesitter = true,
          telescope = true,
        },
      })
      -- Apply the colorscheme after setup
      vim.cmd.colorscheme("catppuccin")
    end,
  },
  {
    "f-person/auto-dark-mode.nvim",
    config = function()
      require("auto-dark-mode").setup({
        update_interval = 1000, -- Check every second
        set_dark_mode = function()
          vim.api.nvim_set_option("background", "dark")
          vim.api.nvim_set_hl(0, "MsgArea", { fg = "#03ff13" })
        end,
        set_light_mode = function()
          vim.api.nvim_set_option("background", "light")
          vim.api.nvim_set_hl(0, "MsgArea", { fg = "green" })
        end,
      })
      require("auto-dark-mode").init()
    end,
  },
}

This code file was previously in ~/.config/nvim/lua/plugins. I was trying to Astrovim. I didn't work very well, so I moved to nvf.

Furthermore, I don't understand how to translate this script with the information you gave me. Like, how can I call require("catppuccin") as the code is before the setup function?

Can you please help me?

[horriblename]

ah, the example I gave is more for plugins that nvf supports. For custom plugins you can either

1. use vim.lazy.plugins
   • my comment on setupOpts is valid here
2. use vim.extraPlugins
   • setupOpts is unfortunately not a thing in extraPlugins currently, but I am planning on adding it - this means you'll have to copy-paste your lua config verbatim into extraPlugins.<name>.setup