From 163caab28fa6634fb0ba18e9894089790a456f03 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Mon, 10 Mar 2025 08:46:47 +0000 Subject: [PATCH] Deploy PR #656 preview --- docs-preview-656/options.html | 373 ++++++++++++++++++++++++++++++++++ 1 file changed, 373 insertions(+) diff --git a/docs-preview-656/options.html b/docs-preview-656/options.html index dc3beea9..1b528e49 100644 --- a/docs-preview-656/options.html +++ b/docs-preview-656/options.html @@ -1013,6 +1013,379 @@ boolean

+
+ + vim.augroups + + +
+
+

A list of Neovim autogroups, which are used to organize and manage related +autocommands together. Groups allow multiple autocommands to be cleared +or redefined collectively, preventing duplicate definitions.

Each autogroup consists of a name, a boolean indicating whether to clear +existing autocommands, and a list of associated autocommands.

+ +

Type: +list of (submodule)

+ +

Default: +[ ]

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/autocmds.nix> + +
+
+
+ + vim.augroups.*.enable + + +
+
+

Whether to enable this autogroup

+ +

Type: +boolean

+ +

Default: +true

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/autocmds.nix> + +
+
+
+ + vim.augroups.*.clear + + +
+
+

Whether to clear existing autocommands in this group before defining new ones. +This helps avoid duplicate autocommands.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/autocmds.nix> + +
+
+
+ + vim.augroups.*.name + + +
+
+

The name of the autocommand group.

+ +

Type: +string

+ +

Example: +"MyAutoCmdGroup"

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/autocmds.nix> + +
+
+
+ + vim.autocmds + + +
+
+

A list of Neovim autocommands to be registered.

Each entry defines an autocommand, specifying events, patterns, optional +callbacks, commands, groups, and execution settings.

+ +

Type: +list of (submodule)

+ +

Default: +[ ]

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/autocmds.nix> + +
+
+
+ + vim.autocmds.*.enable + + +
+
+

Whether to enable this autocommand

+ +

Type: +boolean

+ +

Default: +true

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/autocmds.nix> + +
+
+
+ + vim.autocmds.*.callback + + +
+
+

The file pattern(s) that determine when the autocommand applies.

+ +

Type: +null or (luaInline)

+ +

Default: +null

+ +

Example:

mkLuaInline ''
+  function()
+      print("Saving a Lua file...")
+  end
+'''
+
+
+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/autocmds.nix> + +
+
+
+ + vim.autocmds.*.command + + +
+
+

Vim command string instead of a Lua function.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/autocmds.nix> + +
+
+
+ + vim.autocmds.*.desc + + +
+
+

A description for the autocommand.

+ +

Type: +null or string

+ +

Default: +null

+ +

Example: +"Notify when saving a Lua file"

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/autocmds.nix> + +
+
+
+ + vim.autocmds.*.event + + +
+
+

The event(s) that trigger the autocommand.

+ +

Type: +null or (list of string)

+ +

Default: +null

+ +

Example:

[
+  "BufRead"
+  "BufWritePre"
+]
+
+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/autocmds.nix> + +
+
+
+ + vim.autocmds.*.group + + +
+
+

An optional autocommand group to manage related autocommands.

+ +

Type: +null or string

+ +

Default: +null

+ +

Example: +"MyAutoCmdGroup"

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/autocmds.nix> + +
+
+
+ + vim.autocmds.*.nested + + +
+
+

Whether to allow nested autocommands to trigger.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/autocmds.nix> + +
+
+
+ + vim.autocmds.*.once + + +
+
+

Whether autocommand run only once.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/autocmds.nix> + +
+
+
+ + vim.autocmds.*.pattern + + +
+
+

The file pattern(s) that determine when the autocommand applies).

+ +

Type: +null or (list of string)

+ +

Default: +null

+ +

Example:

[
+  "*.lua"
+  "*.vim"
+]
+
+ +

Declared by:

+ + +
+ +<nvf/modules/neovim/init/autocmds.nix> + +
+
vim.autocomplete.enableSharedCmpSources