plugins.lz-n.plugins

List of plugin specs provided to the require('lz.n').load function. Plugin specs can be raw lua code.

Type: list of (attribute set of anything)

Default: [ ]

Example:

[
  {
    __unkeyed-1 = "neo-tree.nvim";
    after = ''
      function()
        require("neo-tree").setup()
      end
    '';
    enabled = ''
      function()
      return true
      end
    '';
    keys = [
      {
        __unkeyed-1 = "<leader>ft";
        __unkeyed-2 = "<CMD>Neotree toggle<CR>";
        desc = "NeoTree toggle";
      }
    ];
  }
  {
    __unkeyed-1 = "telescope.nvim";
    cmd = [
      "Telescope"
    ];
    keys = [
      {
        __unkeyed-1 = "<leader>fa";
        __unkeyed-2 = "<CMD>Telescope autocommands<CR>";
        desc = "Telescope autocommands";
      }
      {
        __unkeyed-1 = "<leader>fb";
        __unkeyed-2 = "<CMD>Telescope buffers<CR>";
        desc = "Telescope buffers";
      }
    ];
  }
  {
    __unkeyed-1 = "onedarker.nvim";
    colorscheme = [
      "onedarker"
    ];
  }
  {
    __raw = ''
      {
          "crates.nvim",
          ft = "toml",
      },
    '';
  }
]

Declared by:

plugins.lz-n.plugins.*.enabled

When false, or if the function returns false, then this plugin will not be included in the spec. This option corresponds to the enabled property of lz.n.

Type: null or lua function string or boolean

Default: null

Plugin default: true

Declared by:

plugins.lz-n.plugins.*.__unkeyed-1

The “unkeyed” attribute is the plugin’s name. This is passed to load function and should normally match the repo name of the plugin.

More specifically, this is the name of the folder in /pack/opt/{name} that is loaded with load (packadd by default). See :h packadd.

Type: string

Declared by:

plugins.lz-n.plugins.*.after

Executed after this plugin is loaded.

Type: null or lua code string

Default: null

Declared by:

plugins.lz-n.plugins.*.before

Executed before this plugin is loaded.

Type: null or lua code string

Default: null

Declared by:

plugins.lz-n.plugins.*.beforeAll

Always executed before any plugins are loaded.

Type: null or lua code string

Default: null

Declared by:

plugins.lz-n.plugins.*.cmd

Lazy-load on command.

Type: null or anything

Default: null

Example:

[
  "Neotree"
  "Telescope"
]

Declared by:

plugins.lz-n.plugins.*.colorscheme

Lazy-load on colorscheme.

Type: null or anything

Default: null

Example: "onedarker"

Declared by:

plugins.lz-n.plugins.*.event

Lazy-load on event. Events can be specified as BufEnter or with a pattern like BufEnter *.lua

Type: null or anything

Default: null

Example:

[
  "BufEnter *.lua"
  "DeferredUIEnter"
]

Declared by:

plugins.lz-n.plugins.*.ft

Lazy-load on filetype.

Type: null or anything

Default: null

Example:

[
  "tex"
]

Declared by:

plugins.lz-n.plugins.*.keys

Lazy-load on key mapping. Mode is n by default.

Type: null or (list of anything)

Default: null

Example:

[
  "<C-a>"
  [
    "<C-x>"
    "g<C-x>"
  ]
  {
    __unkeyed-1 = "<leader>fb";
    __unkeyed-2 = "<CMD>Telescope buffers<CR>";
    desc = "Telescope buffers";
  }
  {
    __raw = "{ '<leader>ft', '<CMD>Neotree toggle<CR>', desc = 'NeoTree toggle' }";
  }
]

Declared by:

plugins.lz-n.plugins.*.load

Can be used to override the vim.g.lz_n.load() function for this plugin.

Type: null or lua code string

Default: null

Declared by:

plugins.lz-n.plugins.*.priority

Only useful for start plugins (not lazy-loaded) to force loading certain plugins first.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 50 (or 1000 if colorscheme is set)

Declared by: