Additional arguments passed to each module in addition to ones like lib, config, and pkgs, modulesPath.

This option is also available to all submodules. Submodules do not inherit args from their parent module, nor do they provide args to their parent module or sibling submodules. The sole exception to this is the argument name which is provided by parent modules to a submodule and contains the attribute name the submodule is bound to, or a unique generated name if it is not bound to an attribute.

Some arguments are already passed by default, of which the following cannot be changed with this option:

• lib: The nixpkgs library.

• config: The results of all options after merging the values from all modules together.

• options: The options declared in all modules.

• specialArgs: The specialArgs argument passed to evalModules.

• All attributes of specialArgs

  Whereas option values can generally depend on other option values thanks to laziness, this does not apply to imports, which must be computed statically before anything else.

  For this reason, callers of the module system can provide specialArgs which are available during import resolution.

  For NixOS, specialArgs includes modulesPath, which allows you to import extra modules from the nixpkgs package tree without having to somehow make the module aware of the location of the nixpkgs or NixOS directories.

  { modulesPath, ... }: {
    imports = [
      (modulesPath + "/profiles/minimal.nix")
    ];
  }
  

For NixOS, the default value for this option includes at least this argument:

• pkgs: The nixpkgs package set according to the nixpkgs.pkgs option.

Additional runtime paths that will be appended to the active runtimepath of the Neovim. This can be used to add additional lookup paths for configs, plugins, spell languages and other things you would generally place in your $HOME/.config/nvim.

This is meant as a declarative alternative to throwing files into ~/.config/nvim and having the Neovim wrapper pick them up. For more details on vim.o.runtimepath, and what paths to use; please see https://neovim.io/doc/user/options.html#'runtimepath'">the official documentation

Whether to enable complementary Neovim plugin for avante.nvim.

Option table to pass into the setup function of avante-nvim

You can pass in any additional options even if they're not listed in the docs

Since auto-suggestions are a high-frequency operation and therefore expensive, currently designating it as copilot provider is dangerous because: https://github.com/yetone/avante.nvim/issues/1048 Of course, you can reduce the request frequency by increasing suggestion.debounce.

Whether to enable automatically apply diff after LLM response..

Whether to enable automatically set the highlight group for the current line..

Whether to enable automatically set the keymap for the current line..

Whether to enable auto suggestions..

Whether to enable Claude Text Editor Tool Mode..

Whether to enable Cursor Planning Mode..

Whether to enable token counting..

Whether to enable remove unchanged lines when applying a code block..

Whether to enable pasting image from clipboard. This will be determined automatically based whether img-clip is available or not. .

The provider used in the applying phase of Cursor Planning Mode, defaults to nil, Config.provider will be used as the provider for the applying phase when nil.

Automatically jumps to the next change.

Override the 'timeoutlen' setting while hovering over a diff (see :help timeoutlen). Helps to avoid entering operator-pending mode with diff mappings starting with c. Disable by setting to -1.

Whether to enable dual_boost mode..

The first provider to generate response.

The prompt to generate response based on the two reference outputs.

The second provider to generate response.

Timeout in milliseconds.

Whether to enable hints.

Define or override the default keymaps for cancel actions.

Define or override the default keymaps for diff.

Define or override the default keymaps for jump actions.

Define or override the default keymaps for sidebar actions.

Define or override the default keymaps for submit actions.

Define or override the default keymaps for suggestion actions.

The provider used in Aider mode or in the planning phase of Cursor Planning Mode.

Suggestion debounce in milliseconds.

Suggestion throttle in milliseconds.

Define Your Custom providers.

The border type on the ask window.

Open the 'AvanteAsk' prompt in a floating window.

Which diff to focus after applying.

Start insert mode when opening the ask window.

The border type on the edit window.

Start insert mode when opening the edit window.

Height of the input window in vertical layout.

The prefix used on the user input.

The position of the sidebar.

Position of the title.

enable/disable the header.

Enable rounded sidebar header

Default % based on available width.

similar to vim.o.wrap.

Whether to enable ChatGPT AI assistant. Requires the environment variable OPENAI_API_KEY to be set.

[ChatGPT] Add tests

ChatGPT

[ChatGPT] Docstring

[ChatGPT] Edit with instructions

[ChatGPT] Explain code

[ChatGPT] Fix bugs

[ChatGPT] Grammar correction

[ChatGPT] Keywords

[ChatGPT] Optimize code

[ChatGPT] Code reability analysis

[ChatGPT] Roxygen edit

[ChatGPT] Summarize

[ChatGPT] Translate

Option table to pass into the setup function of chatgpt

You can pass in any additional options even if they're not listed in the docs

Whether to enable complementary neovim plugin for codecompanion.nvim.

Option table to pass into the setup function of codecompanion-nvim

You can pass in any additional options even if they're not listed in the docs

An adapter is what connects Neovim to an LLM.

Height of the action palette.

Whether to enable showing default actions in the action palette.

Whether to enable showing default prompt library in the action palette.

Prompt used for interactive LLM calls.

Provider used for the action palette.

Width of the action palette.

Whether to enable automatic page scrolling.

The icon to represent a pinned buffer.

The icon to represent a watched buffer.

Message to appear in chat buffer.

The separator between the different messages in the chat buffer.

Whether to enable header separators in the chat buffer.

Set this to false if you're using an external markdown formatting plugin. .

Whether to enable references in the chat buffer.

Whether to enable LLM settings to appear at the top of the chat buffer. .

Whether to enable the token count for each response.

Whether to enable opening the chat buffer in insert mode. .

Close an open chat buffer if the total columns of your display are less than...

Whether to enable a diff view to see the changes made by the LLM.

Type of split for default provider.

The preferred kind of provider.

Customize how output is created in new buffer.

Specify which language an LLM should respond in.

Change the level of logging.

Whether to enable code being sent to the LLM.

A prompt library is a collection of prompts that can be used in the action palette.

Adapter used for the chat strategy.

Define or override the default keymaps.

The chat buffer places user and LLM responses under a H2 header. These can be customized in the configuration.

Slash Commands (invoked with /) let you dynamically insert context into the chat buffer, such as file contents or date/time.

Configure tools to perform specific tasks when invoked by an LLM.

Define your own variables to share specific content.

Adapter used for the inline strategy.

Accept the suggested change.

Reject the suggested change.

Define your own variables to share specific content.

Whether to enable nvim-cmp integration for GitHub Copilot.

Whether to enable GitHub Copilot AI assistant.

Accept suggestion

Jump to next suggestion

Jump to previous suggestion

Open suggestions

Refresh suggestions

Accept suggetion

Accept next line

Accept next word

Dismiss suggestion

Next suggestion

Previous suggestion

Option table to pass into the setup function of Copilot

You can pass in any additional options even if they're not listed in the docs

The command that will be executed to initiate nodejs for GitHub Copilot. Recommended to leave as default.

Whether to enable Completion Panel.

Panel position

Panel size

Whether to enable Suggestions.

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 and a boolean indicating whether to clear existing autocommands.

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

Whether to enable this autocommand group.

The name of the autocommand group.

A list of Neovim autocommands to be registered.

Each entry defines an autocommand, specifying events, patterns, a callback or Vim command, an optional group, a description, and execution settings.

Lua function to be called when the event(s) are triggered.

Vim command to be executed when the event(s) are triggered. Cannot be defined if the callback option is already defined.

A description for the autocommand.

Whether to enable this autocommand.

The event(s) that trigger the autocommand.

An optional autocommand group to manage related autocommands.

Whether to allow nested autocommands to trigger.

Whether to run the autocommand only once.

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

Whether to enable blink.cmp.

Whether to enable friendly-snippets for blink to source from automatically.

Close [blink.cmp]

Complete [blink.cmp]

Confirm [blink.cmp]

Next item [blink.cmp]

Previous item [blink.cmp]

Scroll docs down [blink.cmp]

Scroll docs up [blink.cmp]

Option table to pass into the setup function of blink.cmp

You can pass in any additional options even if they're not listed in the docs

blink.cmp cmdline keymap

keymap presets

List of sources to enable for cmdline. Null means use default source list.

Show documentation whenever an item is selected

Delay before auto show triggers

Manages the appearance of the completion menu. You may prevent the menu from automatically showing by this option to false and manually showing it with the show keymap command.

fuzzy matcher implementation for Blink.

• "lua": slower, Lua native fuzzy matcher implementation
• `"rust": use the SIMD fuzzy matcher, 'frizbee'
• "prefer_rust": use the rust implementation, but fall back to lua
• "prefer_rust_with_warning": use the rust implementation, and fall back to lua if it is not available after emitting a warning.

Auto-downloads prebuilt binaries.

::: .{warning} Do not enable this option, as it does not work on Nix! :::

blink.cmp keymap

keymap presets

Default list of sources to enable for completion.

Settings for completion providers.

Provider module.

blink.cmp sources.

Attribute names must be source names used in vim.autocomplete.blink-cmp.setupOpts.sources.default.

Whether to enable this source.

Value of vim.autocomplete.blink-cmp.setupOpts.sources.providers..module.

Should be present in the source's documentation.

blink-cmp source plugin package.

Whether to enable emoji source.

Value of vim.autocomplete.blink-cmp.setupOpts.sources.providers.emoji.module.

blink-cmp emoji source plugin package.

Whether to enable ripgrep source.

Value of vim.autocomplete.blink-cmp.setupOpts.sources.providers.ripgrep.module.

blink-cmp ripgrep source plugin package.

Whether to enable spell source.

Value of vim.autocomplete.blink-cmp.setupOpts.sources.providers.spell.module.

blink-cmp spell source plugin package.

Whether to enable sources shared by blink.cmp and nvim-cmp.

Whether to enable nvim-cmp.

The function used to customize the completion menu entries. This is outside of setupOpts to allow for an easier integration with lspkind.nvim.

See :help cmp-config.formatting.format.

Close [nvim-cmp]

Complete [nvim-cmp]

Confirm [nvim-cmp]

Next item [nvim-cmp]

Previous item [nvim-cmp]

Scroll docs down [nvim-cmp]

Scroll docs up [nvim-cmp]

Option table to pass into the setup function of the autocomplete plugin

You can pass in any additional options even if they're not listed in the docs

A comma-separated list of options for completion.

See :help completeopt for the complete list.

The comparator functions used for sorting completions.

You can either pass a valid inline lua function (see :help cmp-config.sorting.comparators), or a string, in which case the builtin comparator with that name will be used.

A deprio function and a kinds (require("cmp.types").lsp.CompletionItemKind) variable is provided above setupOpts. By passing a type to the function, the returned function will be a comparator that always ranks the specified kind the lowest.

List of source plugins used by nvim-cmp.

The list of sources used by nvim-cmp

Whether to enable autopairs.

Option table to pass into the setup function of nvim-autopairs

You can pass in any additional options even if they're not listed in the docs

Set how bells are handled. Options: on, visual or none

Whether to enable cheatsheet-nvim: searchable cheatsheet for nvim using telescope.

Whether to enable hardtime helper for no repeat keybinds.

Option table to pass into the setup function of hardtime-nvim

You can pass in any additional options even if they're not listed in the docs

Whether to enable which-key keybind helper menu.

Register label for which-key keybind helper menu

Option table to pass into the setup function of which-key

You can pass in any additional options even if they're not listed in the docs

Show a warning when issues were detected with mappings

The default preset for the which-key window

Functions/Lua Patterns for formatting the labels

Which-key window border style

final output package

Whether to enable clipboard management for Neovim. Users may still choose to manage their clipboard through should they wish to avoid using this module. .

Clipboard providers for which packages will be added to nvf's extraPackages. The package field may be set to null if related packages are already found in system packages to potentially reduce closure sizes.

Whether to enable wl-copy.

The wl-clipboard package to use.

Whether to enable xclip.

The xclip package to use.

Whether to enable xsel.

The xsel package to use.

The register to be used by the Neovim clipboard. Recognized types are:

• unnamed: Vim will use the clipboard register "*" for all yank, delete, change and put operations which would normally go to the unnamed register.

• unnamedplus: A variant of the "unnamed" flag which uses the clipboard register "+" (:h quoteplus) instead of register "*" for all yank, delete, change and put operations which would normally go to the unnamed register.

When unnamed and unnamedplus is included simultaneously yank and delete operations (but not put) will additionally copy the text into register "*".

Please see :h clipboard for more details.

Whether to enable smart and powerful comment plugin for neovim comment-nvim.

Toggle current block comment

Toggle current line comment

Toggle block comment

Toggle line comment

Toggle selected block

Toggle selected comment

Option table to pass into the setup function of Comment-nvim

You can pass in any additional options even if they're not listed in the docs

Whether to enable basic mappings.

Whether to enable extra mappings.

Whether to enable fast and fully programmable greeter for neovim [alpha.nvim].

Alpha dashboard layout

Optional global options

Alpha default theme to use

Whether to enable Fancy and Blazing Fast start screen plugin of neovim [dashboard.nvim].

Option table to pass into the setup function of dashboard.nvim

You can pass in any additional options even if they're not listed in the docs

List of book marks to disaply on start page

Command to change the current window with. Can be cd, lcd or tcd

Should vim change to the directory of the file you open

Should vim change to the version control root when opening a file

Commands that are presented to the user on startify page

Text to place in the footer

Text to place in the header

Specify a list of default characters to use instead of numbers

Prevent startify from opening on startup but can be called with :Startify

Whether to enable dashboard via vim-startify.

How many files to list

Specify the lists and in what order they are displayed on startify.

Number of spaces used for left padding.

Make startify auto load Session.vim files from the current directory

Commands to run before saving a session

Delete all buffers when loading or closing a session

Directory to save and load sessions from

Persist session before leaving vim or switching session

Patterns to remove from session files

List of commands to run when loading a session.

List of variables to save into a session file.

Set if you want items sorted by date rather than alphabetically

List of regex patterns to exclude from MRU lists

List of vim servers to not load startify for

Turns on unsafe mode for Startify. Stops resolving links, checking files are readable and filtering bookmark list

Set if you want startify to always update and not just when neovim closes

Show environment variables in path if name is shorter than value

Whether to enable debug mode.

Set verbosity level of Neovim while debug mode is enabled.

Value must be be one of the levels expected by Neovim's https://neovim.io/doc/user/options.html#'verbose'">verbose option

Set the log file that will be used to store verbose messages set by the verbose option.

Whether to enable debugging via nvim-dap.

Continue

Go down stacktrace

Go up stacktrace

Hover

Restart

Re-run Last Debug Session

Continue to the current cursor

Step back

Step into function

Step out of function

Next step

Terminate

Toggle breakpoint

Toggle DAP-UI

Toggle Repl

List of debuggers to install

Automatically Opens and Closes DAP-UI upon starting/closing a debugging session

Whether to enable UI extension for nvim-dap.

Option table to pass into the setup function of nvim-dap-ui

You can pass in any additional options even if they're not listed in the docs

Values that will be passed to vim.diagnostic.config after being converted to a Lua table. Possible values for each key can be found in the help text for vim.diagnostics.Opts. You may find more about the diagnostics API of Neovim in :help diagnostic-api.

Use signs for diagnostics. See :help diagnostic-signs.

Use underline for diagnostics.

Update diagnostics in Insert mode. If false, diagnostics will be updated on InsertLeave (:help InsertLeave).

Use virtual lines for diagnostics.

Use virtual text for diagnostics. If multiple diagnostics are set for a namespace, one prefix per diagnostic + the last diagnostic message are shown.

Whether to enable diagostics module for Neovim.

Whether to enable asynchronous linter plugin for Neovim [nvim-lint].

Whether to enable autocmd to lint after each save.

Define the global function nvf_lint which is used by nvf to lint.

Linter configurations. Builtin linters will be updated and not replaced, but note that this is not a deep extend operation, i.e. if you define an env option, it will replace the entire env table provided by the builtin (if it exists).

Automatically add the current file name to the commands arguments. Only has an effect if stdin is false

Arguments to pass

Command of the linter

Working directory of the linter

Environment variables to use

Declares if exit code != 1 should be ignored or result in a warning.

Name of the linter

Parser function

Required files to lint. These files must exist relative to the cwd of the linter or else this linter will be skipped

Send content via stdin.

Result stream

Map of filetype to formatters. This option takes a set of key = value format where the value will be converted to its Lua equivalent through `toLuaObject. You are responsible for passing the correct Nix data types to generate a correct Lua value that conform is able to accept.

Whether to enable the experimental Lua module loader to speed up the start up process. If true, this will enable the experimental Lua module loader which:

• overrides loadfile
• adds the lua loader using the byte-compilation cache
• adds the libs loader
• removes the default Neovim loader

Additional lua files that will be sourced by Neovim. Takes both absolute and relative paths, all of which will be called via the luafile command in Neovim.

See https://neovim.io/doc/user/lua.html#lua-commands">lua-commands on the Neovim documentation for more details.

List of additional packages to make available to the Neovim wrapper.

A list of plugins and their configurations that will be set up after builtin plugins.

This option takes a special type that allows you to order your custom plugins using nvf's modified DAG library.

Setup this plugin after the following ones.

Plugin Package.

Lua code to run during setup.

Whether to enable filetree via neo-tree.nvim.

Option table to pass into the setup function of neo-tree

You can pass in any additional options even if they're not listed in the docs

Whether to add a blank line at the top of the tree

Whether to automatically clean up broken neo-tree buffers saved in sessions

You can choose a specific source.

last here which indicates the last used source

Whether to enable cursor hijacking.

If enabled neotree will keep the cursor on the first letter of the filename when moving in the tree .

Whether to enable diagnostics.

Whether to enable git status.

Whether to enable markers for files with unsaved changes..

Whether to enable tracking of opened files.

Required for components.name.highlight_opened_files .

Whether to enable Refresh the tree when a file is written.

Only used if use_libuv_file_watcher is false. .

Hijack Netrw behavior

Whether to enable async git status.

This will make the git status check async and will not block the UI. .

Whether to hide the root node of the tree

Log level for the plugin.

Must be either a boolean or a path to your log file.

Use :NeoTreeLogs to show the file

A list of filetypes that should not be replaced when opening a file

Whether to open files in the last window

If disabled, neo-tree will open files in top left window

Whether to retain the indent of the hidden root node

IF the root node is hidden, keep the indentation anyhow. This is needed if you use expanders because they render in the indent.

Whether to enable filetree via nvim-tree.lua.

Find file in NvimTree

Focus NvimTree

Refresh NvimTree

Toggle NvimTree

Open when vim is started on a directory

Option table to pass into the setup function of Nvim Tree

You can pass in any additional options even if they're not listed in the docs

Configuration for various actions.

vim change-directory behaviour

Change the working directory when changing directories in the tree.

Use :cd instead of :lcd when changing directories. Consider that this might cause issues with the nvimTree.syncRootWithCwd option.

Restrict changing to a directory above the global current working directory.

Configuration for expand_all behaviour.

A list of directories that should not be expanded automatically.

Limit the number of folders being explored when expanding every folders. Avoids hanging neovim when running this action on very large folders.

Configuration for file_popup behaviour.

Floating window config for file_popup. See |nvim_open_win| for more details.

Configuration options for opening a file from nvim-tree.

Prevent new opened file from opening in the same window as the tree.

Closes the explorer when opening a file.

Resizes the tree when opening a file. Previously view.auto_resize

window_picker

A string of chars used as identifiers by the window picker.

Enable the window picker. If this feature is not enabled, files will open in window from which you last opened the tree.

A list of buftypes to exclude from the window picker.

A list of filetypes to exclude from the window picker.

Change the default window picker, can be a string "default" or a function. The function should return the window id that will open the node, or nil if an invalid window is picked or user cancelled the action.

The picker may create a new window.

Close any window displaying a file when removing the file from the tree

A boolean value that toggle the use of system clipboard when copy/paste function are invoked. When enabled, copied text will be stored in registers '+' (system), otherwise, it will be stored in '1' and '"'.

Auto reload tree on write

Show LSP and COC diagnostics in the signcolumn Note that the modified sign will take precedence over the diagnostics signs.

Idle milliseconds between diagnostic event and update.

Whether to enable diagnostics view in the signcolumn..

Icons for diagnostic severity.

Icon used for error diagnostic.

Icon used for hint diagnostic.

Icon used for info diagnostic.

Icon used for warning diagnostic.

Severity for which the diagnostics will be displayed. See :help diagnostic-severity

Maximum severity.

Minimum severity.

Show diagnostic icons on parent directories.

Show diagnostics icons on directories that are open. Only relevant when diagnostics.show_on_dirs is true.

Disables netrw and replaces it with tree

Will use file system watcher (libuv fs_event) to watch the filesystem for changes. Using this will disable BufEnter / BufWritePost events in nvim-tree which were used to update the whole tree. With this feature, the tree will be updated only for the appropriate folder change, resulting in better performance.

Idle milliseconds between filesystem change and action.

Enable filesystem watchers.

List of vim regex for absolute directory paths that will not be watched. Backslashes must be escaped e.g. "my-project/\\.build$". Useful when path is not in .gitignore or git integration is disabled.

Filtering options.

Do not show dotfiles: files starting with a .

List of directories or files to exclude from filtering: always show them.

Do not show files with no git status. This will show ignored files when nvimTree.filters.gitIgnored is set, as they are effectively dirty.

Ignore files based on .gitignore. Requires git.enableto betrue`

Do not show files that have no buflisted() buffer.

Disable git integration when git top-level matches these paths. May be relative, evaluated via ":p"

Whether to enable Git integration with icons and colors..

Show git icons on parent directories.

Show git icons on directories that are open.

Kills the git process after some time if it takes too long. Git integration will be disabled after 10 git jobs exceed this timeout.

Hijack the cursor in the tree to put it at the start of the filename

Opens the tree if the tree was previously closed.

Enable the hijack_directories feature. Disable this option if you use vim-dirvish or dirbuf.nvim. If hijack_netrw and disable_netrw are false, this feature will be disabled.

Prevents netrw from automatically opening when opening directories

Open nvimtree in place of the unnamed buffer if it's empty.

Configurations for the live_filtering feature. The live filter allows you to filter the tree nodes dynamically, based on regex matching (see vim.regex). This feature is bound to the f key by default. The filter can be cleared with the F key by default.

Whether to filter folders or not.

Prefix of the filter displayed in the buffer.

Indicate which file have unsaved modification.

Whether to enable Modified files with icons and color highlight..

Show modified icons on parent directories.

Show modified icons on directories that are open.

Configuration for notifications.

Whether to use absolute paths or item names in fs action notifications.

Specify minimum notification level, uses the values from vim.log.levels

Prefer startup root directory when updating root directory of the tree. Only relevant when update_focused_file.update_root is true

Automatically reloads the tree on BufEnter nvim-tree.

Appends a trailing slash to folder names.

Display node whose name length is wider than the width of nvim-tree window in floating window.

Compact folders that only contain a single folder into one node in the file tree.

Enable file highlight for git attributes using NvimTreeGit highlight groups. Requires nvimTree.git.enable This can be used with or without the icons.

Highlight modified files in the tree using NvimTreeNormal highlight group. Requires nvimTree.view.highlightOpenedFiles

Highlight icons and/or names for bufloaded() files using the NvimTreeOpenedFile highlight group.

Configuration options for icons.

Place where the bookmark icons will be rendered. signcolumn requires view.signcolumn to be enabled.

Place where the diagnostics icons will be rendered. signcolumn requires view.signcolumn to be enabled.

Place where the git icons will be rendered. signcolumn requires view.signcolumn to be enabled.

Configuration options for icon glyphs. NOTE: Do not set any glyphs to more than two characters if it's going to appear in the signcolumn.

Glyph for files. Will be overridden by nvim-web-devicons if available.

Glyphs for directories. Recommended to use the defaults unless you know what you are doing.

Glyphs for git status.

Icon to display for modified files.

Glyph for symlinks.

Place where the hidden icons will be rendered. signcolumn requires view.signcolumn to be enabled.

Place where the modified icons will be rendered. signcolumn requires view.signcolumn to be enabled.

Inserted between icon and filename

Show an icon before the file name. nvim-web-devicons will be used if available.

Show an icon before the folder name.

Show a small arrow before the folder node. Arrow will be a part of the node when using renderer.indent_markers.

Show a git status icon, see renderer.icons.gitPlacement Requires git.enable to be true.

Show a modified icon, see renderer.icons.modifiedPlacement Requires modified.enable to be true.

Used as a separator between symlinks' source and target.

Use the webdev icon colors, otherwise NvimTreeFileIcon

Configuration options for tree indent markers.

Whether to enable Display indent markers when folders are open..

Individual elements of the indent markers

Display folder arrows in the same column as indent marker when using renderer.icons.show.folder_arrow

Number of spaces for an each tree nesting level. Minimum 1.

In what format to show root folder. See :help filename-modifiers for available string options. Set to false to hide the root folder.

Function is passed the absolute path of the root folder and should return a string. e.g. my_root_folder_label = function(path) return ".../" .. vim.fn.fnamemodify(path, ":t") end

A list of filenames that gets highlighted with `NvimTreeSpecialFile

Whether to show the destination of the symlink.

Will change cwd of nvim-tree to that of new buffer's when opening nvim-tree.

Preferred root directories. Only relevant when updateFocusedFile.updateRoot is true

Whether to enable Use vim.ui.select style prompts. Necessary when using a UI prompt decorator such as dressing.nvim or telescope-ui-select.nvim .

Sort folders before files. Has no effect when sort.sorter is a function.

How files within the same directory are sorted.

Changes the tree root directory on DirChanged and refreshes the tree. Only relevant when updateFocusedFile.updateRoot is true

(previously update_cwd)

Optional argument list.

The open command itself

Configuration for tab behaviour.

Configuration for syncing nvim-tree across tabs.

Closes the tree across all tabpages when the tree is closed.

List of filetypes or buffer names on new tab that will prevent nvimTree.tab.sync.open and nvimTree.tab.sync.close

Opens the tree automatically when switching tabpage or opening a new tabpage if the tree was previously open.

Configuration options for trashing.

The command used to trash items

General UI configuration.

Prompt before removing.

Prompt before trash.

Update the focused file on BufEnter, un-collapses the folders recursively until it finds the file.

update focused file

List of buffer names and filetypes that will not update the root dir of the tree if the file isn't found under the current root directory. Only relevant when update_focused_file.update_root and update_focused_file.enable are true.

Update the root directory of the tree if the file is not under current root directory. It prefers vim's cwd and root_dirs. Otherwise it falls back to the folder containing the file. Only relevant when update_focused_file.enable is true

Window / buffer setup.

If true, reposition the view so that the current node is initially centralized when entering nvim-tree.

Enable cursorline in nvim-tree window.

Idle milliseconds before some reload / refresh operations. Increase if you experience performance issues around screen refresh.

Configuration options for floating window.

If true, tree window will be floating.

Floating window config. See :h nvim_open_win() for more details.

Close the floating tree window when it loses focus.

Print the line number in front of each line.

Preserves window proportions when opening a file. If false, the height and width of windows other than nvim-tree will be equalized.

Show the line number relative to the line with the cursor in front of each line. If the option view.number is also true, the number on the cursor line will be the line number instead of 0.

Side of the tree.

Show diagnostic sign column. Value can be "yes", "auto" or"no".

Width of the window: can be a % string, a number representing columns, a function or a table.

A table (an attribute set in our case, see example) indicates that the view should be dynamically sized based on the longest line.

Whether to enable lightweight yet powerful formatter plugin for Neovim [conform-nvim].

Option table to pass into the setup function of conform.nvim

You can pass in any additional options even if they're not listed in the docs

Default values when calling conform.format()

Table or function(luainline) that will be passed to conform.format(). If this is set, Conform will run the formatter asynchronously after save.

Attribute set or Lua function that will be passed to conform.format(). If this is set, Conform will run the formatter on save.

Map of filetype to formatters. This option takes a set of key = value format where the value will be converted to its Lua equivalent. You are responsible for passing the correct Nix data types to generate a correct Lua value that conform is able to accept.

Whether to enable fzf-lua.

The configuration profile to use

Option table to pass into the setup function of fzf-lua

You can pass in any additional options even if they're not listed in the docs

Path to fzf executable

Border type for the fzf-lua picker window

Whether to enable gesture-nvim: mouse gestures.

Start drawing [gesture.nvim]

Finish drawing [gesture.nvim]

Whether to enable git integration suite.

Enabling this option will enable the following plugins:

• gitsigns
• vim-fugitive
• git-conflict
• gitlinker-nvim .

Whether to enable git-conflict.

Choose Both [Git-Conflict]

Go to the next Conflict [Git-Conflict]

Choose None [Git-Conflict]

Choose Ours [Git-Conflict]

Go to the previous Conflict [Git-Conflict]

Choose Theirs [Git-Conflict]

Option table to pass into the setup function of git-conflict

You can pass in any additional options even if they're not listed in the docs

Whether to enable gitlinker-nvim.

Option table to pass into the setup function of gitlinker-nvim

You can pass in any additional options even if they're not listed in the docs

Whether to enable gitsigns codeactions through null-ls.

Whether to enable gitsigns.

Blame line [Gitsigns]

Diff project [Gitsigns]

Diff this [Gitsigns]

Next hunk [Gitsigns]

Preview hunk [Gitsigns]

Previous hunk [Gitsigns]

Reset buffer [Gitsigns]

Reset hunk [Gitsigns]

Stage buffer [Gitsigns]

Stage hunk [Gitsigns]

Toggle blame [Gitsigns]

Toggle deleted [Gitsigns]

Undo stage hunk [Gitsigns]

Option table to pass into the setup function of gitsigns

You can pass in any additional options even if they're not listed in the docs

Whether to enable vim-fugitive.

A freeform attribute set containing global variable values for setting vim variables as early as possible. If populated, this option will set vim variables in the built luaConfigRC as the first item.

Whether to enable EditorConfig integration in Neovim.

This defaults to true as it is enabled by default in stock Neovim, setting this option to false disables EditorConfig integration entirely.

See https://neovim.io/doc/user/editorconfig.html">Neovim documentation for more details on configuring EditorConfig behaviour.

The key used for <leader> mappings

The key used for <localleader> mappings

Hide search highlight so it doesn't stay highlighted

Custom highlights to apply

The background color to use. Written as color name or hex "#RRGGBB".

Blend as an integer between 0 and 100

Whether to enable bold

The cterm arguments to use. See ':h highlight-args'

The cterm background color to use

The cterm foreground color to use

Don't override existing definition

The foreground color to use. Written as color name or hex "#RRGGBB".