plugins.lazy.plugins
List of plugins
Type: list of (package or (submodule))
Default:
[ ]
Declared by:
plugins.lazy.plugins.*.enabled
When false then this plugin will not be included in the spec. (accepts fun():boolean)
Type: null or lua function string or boolean
Default:
null
Plugin default: "true"
plugins.lazy.plugins.*.cmd
Lazy-load on command
Type: null or string or list of string or raw lua code
Default:
null
plugins.lazy.plugins.*.cond
When false, or if the function returns false, then this plugin will not be loaded. Useful to disable some plugins in vscode, or firenvim for example. (accepts fun(LazyPlugin):boolean)
Type: null or lua function string or boolean
Default:
null
Plugin default: "true"
plugins.lazy.plugins.*.config
config is executed when the plugin loads. The default implementation will automatically run require(MAIN).setup(opts). Lazy uses several heuristics to determine the plugin’s MAIN module automatically based on the plugin’s name. See also opts. To use the default implementation without opts set config to true.
Type: null or lua function string or value true (singular enum)
Default:
null
plugins.lazy.plugins.*.dependencies
Plugin dependencies
Type: null or string or list of (package or (submodule))
Default:
null
plugins.lazy.plugins.*.dev
When true, a local plugin directory will be used instead. See config.dev
Type: null or boolean or raw lua code
Default:
null
Plugin default: false
plugins.lazy.plugins.*.dir
A directory pointing to a local plugin
Type: null or string
Default:
null
plugins.lazy.plugins.*.event
Lazy-load on event. Events can be specified as BufEnter or with a pattern like BufEnter *.lua
Type: null or string or list of string or raw lua code
Default:
null
plugins.lazy.plugins.*.ft
Lazy-load on filetype
Type: null or string or list of string or raw lua code
Default:
null
plugins.lazy.plugins.*.init
init functions are always executed during startup
Type: null or lua code string
Default:
null
plugins.lazy.plugins.*.keys
Lazy-load on key mapping
Type: null or string or list of string or raw lua code
Default:
null
plugins.lazy.plugins.*.lazy
When true, the plugin will only be loaded when needed. Lazy-loaded plugins are automatically loaded when their Lua modules are required, or when one of the lazy-loading handlers triggers
Type: null or boolean or raw lua code
Default:
null
Plugin default: true
plugins.lazy.plugins.*.main
You can specify the main module to use for config() and opts(), in case it can not be determined automatically. See config()
Type: null or string
Default:
null
plugins.lazy.plugins.*.module
Do not automatically load this Lua module when it’s required somewhere
Type: null or value false (singular enum)
Default:
null
plugins.lazy.plugins.*.name
Name of the plugin to install
Type: null or string
Default:
null
plugins.lazy.plugins.*.optional
When a spec is tagged optional, it will only be included in the final spec, when the same plugin has been specified at least once somewhere else without optional. This is mainly useful for Neovim distros, to allow setting options on plugins that may/may not be part of the user’s plugins
Type: null or boolean or raw lua code
Default:
null
Plugin default: false
plugins.lazy.plugins.*.opts
opts should be a table (will be merged with parent specs), return a table (replaces parent specs) or should change a table. The table will be passed to the Plugin.config() function. Setting this value will imply Plugin.config()
Type: null or (attribute set of anything) or raw lua code
Default:
null
plugins.lazy.plugins.*.pkg
Vim plugin to install
Type: package
plugins.lazy.plugins.*.priority
Only useful for start plugins (lazy=false) to force loading certain plugins first. Default priority is 50. It’s recommended to set this to a high number for colorschemes.
Type: null or signed integer or floating point number
Default:
null
plugins.lazy.plugins.*.submodules
When false, git submodules will not be fetched. Defaults to true
Type: null or boolean or raw lua code
Default:
null
Plugin default: true