Is it possible to use opts and config together?

[Integralist]

👋🏻

I have a configuration that currently uses config set to a function.

The function does the standard .setup({...}) call, which by itself could just be moved to opts = {...} but the config function also does some other stuff like setting up autocommands using vim.api.nvim_create_augroup and vim.api.nvim_create_autocmd.

So do I keep everything inside the config function or can I move the setup options to opts and leave config function for just the autocommand stuff? Or is there a better/more correct way to configure "other stuff" around the plugin?

Thanks!

[folke]

{
  opts = {}
  config = function(_, opts)
     require("foo").setup(opts)
  end
}

[Integralist]

I probably should have provided an example.

This is what I have...

  {
    "hedyhli/outline.nvim",
    cmd = { "Outline", "OutlineOpen" },
    keys = {
      { "gs", "<cmd>Outline<CR>", desc = "List document symbols in a tree" },
    },
    config = function()
      require("outline").setup({
        outline_window = { position = "left", width = 25 },
        symbols = {
          icons = {
            Array = { icon = '󰅪', hl = 'Constant' },
            Boolean = { icon = '◩', hl = 'Boolean' }, -- ⊨ 
            Class = { icon = '𝓒', hl = 'Type' },
            Component = { icon = '󰅴', hl = 'Function' },
            Constant = { icon = '󰏿', hl = 'Constant' }, -- 
            Constructor = { icon = '', hl = 'Special' }, -- 
            Enum = { icon = 'ℰ', hl = 'Type' },
            EnumMember = { icon = '', hl = 'Identifier' },
            Event = { icon = '', hl = 'Type' }, -- 🗲
            Field = { icon = '', hl = 'Identifier' }, -- 󰆨 
            File = { icon = '', hl = 'Identifier' }, -- 󰈔
            Fragment = { icon = '󰅴', hl = 'Constant' },
            Function = { icon = 'ƒ', hl = 'Function' }, -- 
            Interface = { icon = '', hl = 'Type' }, -- 󰜰
            Key = { icon = '󰌋', hl = 'Type' }, -- 🔐
            Macro = { icon = ' ', hl = 'Function' },
            Method = { icon = '', hl = 'Function' }, -- ƒ ➡️
            Module = { icon = '', hl = 'Include' }, -- 󰆧 (changed because yaml considers an object a module)
            Namespace = { icon = '󰌗', hl = 'Include' }, -- 󰅪
            Null = { icon = '', hl = 'Type' }, -- NULL
            Number = { icon = '#', hl = 'Number' },
            Object = { icon = '', hl = 'Type' }, -- ⦿
            Operator = { icon = '󰆕', hl = 'Identifier' }, -- + 
            Package = { icon = '', hl = 'Include' }, -- 󰏗
            Parameter = { icon = ' ', hl = 'Identifier' },
            Property = { icon = '', hl = 'Identifier' },
            StaticMethod = { icon = ' ', hl = 'Function' }, -- 
            String = { icon = '𝓢', hl = 'String' }, -- 𝓐
            Struct = { icon = '', hl = 'Structure' }, -- 𝓢
            TypeAlias = { icon = ' ', hl = 'Type' }, -- 
            TypeParameter = { icon = '󰊄', hl = 'Identifier' }, -- 𝙏
            Variable = { icon = '', hl = 'Constant' }, -- 
          },
        }
      })
      vim.api.nvim_create_autocmd("FileType", {
        pattern = "Outline",
        command = "setlocal nofoldenable"
      })
    end
  },

I'm hoping I can do this instead...

{
    "hedyhli/outline.nvim",
    cmd = { "Outline", "OutlineOpen" },
    keys = {
      { "gs", "<cmd>Outline<CR>", desc = "List document symbols in a tree" },
    },
    opts = {
      outline_window = { position = "left", width = 25 },
      symbols = {
        icons = {
          Array = { icon = '󰅪', hl = 'Constant' },
          Boolean = { icon = '◩', hl = 'Boolean' }, -- ⊨ 
          Class = { icon = '𝓒', hl = 'Type' },
          Component = { icon = '󰅴', hl = 'Function' },
          Constant = { icon = '󰏿', hl = 'Constant' }, -- 
          Constructor = { icon = '', hl = 'Special' }, -- 
          Enum = { icon = 'ℰ', hl = 'Type' },
          EnumMember = { icon = '', hl = 'Identifier' },
          Event = { icon = '', hl = 'Type' }, -- 🗲
          Field = { icon = '', hl = 'Identifier' }, -- 󰆨 
          File = { icon = '', hl = 'Identifier' }, -- 󰈔
          Fragment = { icon = '󰅴', hl = 'Constant' },
          Function = { icon = 'ƒ', hl = 'Function' }, -- 
          Interface = { icon = '', hl = 'Type' }, -- 󰜰
          Key = { icon = '󰌋', hl = 'Type' }, -- 🔐
          Macro = { icon = ' ', hl = 'Function' },
          Method = { icon = '', hl = 'Function' }, -- ƒ ➡️
          Module = { icon = '', hl = 'Include' }, -- 󰆧 (changed because yaml considers an object a module)
          Namespace = { icon = '󰌗', hl = 'Include' }, -- 󰅪
          Null = { icon = '', hl = 'Type' }, -- NULL
          Number = { icon = '#', hl = 'Number' },
          Object = { icon = '', hl = 'Type' }, -- ⦿
          Operator = { icon = '󰆕', hl = 'Identifier' }, -- + 
          Package = { icon = '', hl = 'Include' }, -- 󰏗
          Parameter = { icon = ' ', hl = 'Identifier' },
          Property = { icon = '', hl = 'Identifier' },
          StaticMethod = { icon = ' ', hl = 'Function' }, -- 
          String = { icon = '𝓢', hl = 'String' }, -- 𝓐
          Struct = { icon = '', hl = 'Structure' }, -- 𝓢
          TypeAlias = { icon = ' ', hl = 'Type' }, -- 
          TypeParameter = { icon = '󰊄', hl = 'Identifier' }, -- 𝙏
          Variable = { icon = '', hl = 'Constant' }, -- 
        },
      }
    },
    config = function()
      vim.api.nvim_create_autocmd("FileType", {
        pattern = "Outline",
        command = "setlocal nofoldenable"
      })
    end
  }

[Integralist]

aha, I see what you were suggesting now...

    opts = {...},
    config = function(_, opts)
      require("outline").setup(opts)
      vim.api.nvim_create_autocmd("FileType", {
        pattern = "Outline",
        command = "setlocal nofoldenable"
      })
    end