diff --git a/options.html b/options.html index 77156cb..56b8a87 100644 --- a/options.html +++ b/options.html @@ -292,148 +292,432 @@ Note that these are setup after builtin plugins.

vim.extraPlugins.<name>.setup

Lua code to run during setup.

Type: strings concatenated with "\n"

Default: ""

Example: "require('aerial').setup {}"

Declared by:

<neovim-flake/modules/core> -
vim.filetree.nvimTreeLua.enable

Whether to enable filetree via nvim-tree-lua.

Type: boolean

Default: false

Example: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.actions.changeDir.global

Change directory when changing nvim's directory (DirChanged event).

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.actions.expandAll.exclude

Exclude files from expand all

Type: list of string

Default: [ ]

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.actions.openFile.quitOnOpen

Quit the tree when opening a file

Type: boolean

Default: false

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.actions.openFile.resizeWindow

Resize the tree when opening a file

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.actions.openFile.windowPicker.enable

Whether to enable Window picker.

Type: boolean

Default: false

Example: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.actions.openFile.windowPicker.chars

A string of chars used as identifiers by the window picker

Type: string

Default: "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.closeOnLastWindow

Close when tree is last window open

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.disableNetRW

Disables netrw and replaces it with tree

Type: boolean

Default: false

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.filesystemWatchers.enable

Enable filesystem watchers

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.followBufferFile

Follow file that is in current buffer on tree

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.git.enable

Whether to enable Git integration.

Type: boolean

Default: false

Example: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.git.ignore

Ignore files in git

Type: boolean

Default: false

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.groupEmptyFolders

Compact empty folders trees into a single item

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.hideDotFiles

Hide dotfiles

Type: boolean

Default: false

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.hideFiles

Files to hide in the file view by default.

Type: list of string

Default:

[
-  "node_modules"
-  ".cache"
-]

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.hijackCursor

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

Type: boolean

Default: false

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.hijackNetRW

Prevents netrw from automatically opening when opening directories

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.hijackUnnamedBufferWhenOpening

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

Type: boolean

Default: false

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.ignoreFileTypes

Ignore file types

Type: list of string

Default: [ ]

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.ignore_ft_on_setup

Ignore file types on setup

Type: list of string

Default: [ ]

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.indentMarkers

Show indent markers

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.lspDiagnostics

Shows lsp diagnostics in the tree

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.mappings.findFile

Find file in NvimTree

Type: null or string

Default: "<leader>tg"

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.mappings.focus

Focus NvimTree

Type: null or string

Default: "<leader>tf"

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.mappings.refresh

Refresh NvimTree

Type: null or string

Default: "<leader>tr"

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.mappings.toggle

Toggle NvimTree

Type: null or string

Default: "<C-n>"

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.openOnSetup

Open when vim is started on a directory

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.openTreeOnNewTab

Opens the tree view when opening a new tab

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.groupEmptyFolders

Compact empty folders trees into a single item

Type: boolean

Default: false

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.highlightOpenedFiles

Highlight opened files

Type: one of "none", "icon", "name", "all"

Default: "none"

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.higlightGit

Highlight git related files

Type: boolean

Default: false

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.default

Default icon

Type: string

Default: ""

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.folder.arrowClosed

Closed folder arrow icon

Type: string

Default: ""

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.folder.arrowOpen

Open folder arrow icon

Type: string

Default: ""

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.folder.default

Default folder icon

Type: string

Default: ""

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.folder.empty

Empty folder icon

Type: string

Default: ""

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.folder.emptyOpen

Empty open folder icon

Type: string

Default: ""

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.folder.open

Open folder icon

Type: string

Default: ""

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.folder.symlink

Symlink folder icon

Type: string

Default: ""

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.folder.symlinkOpen

Symlink open folder icon

Type: string

Default: ""

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.git.deleted

Deleted git icon

Type: string

Default: ""

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.git.ignored

Ignored git icon

Type: string

Default: "◌"

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.git.renamed

Renamed git icon

Type: string

Default: "➜"

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.git.staged

Staged git icon

Type: string

Default: "✓"

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.git.unmerged

Unmerged git icon

Type: string

Default: ""

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.git.unstaged

Unstaged git icon

Type: string

Default: "✗"

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.git.untracked

Untracked git icon

Type: string

Default: "★"

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.glyphs.symlink

Symlink icon

Type: string

Default: ""

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.show.file

Show file icons

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.show.folder

Show folder icons

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.show.folderArrow

Show folder arrow icons

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.icons.show.git

Show git icons

Type: boolean

Default: false

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.indentMarkers

Show indent markers

Type: boolean

Default: false

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.rootFolderLabel

Root folder label. Set null to disable

Type: null or string

Default: null

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.showHiddenFiles

Show hidden files

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.showParentFolder

Show parent folder

Type: boolean

Default: false

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.renderer.trailingSlash

Add a trailing slash to all folders

Type: boolean

Default: false

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.sortBy

Sort by name or extension

Type: one of "name", "extension", "modification_time", "case_sensitive"

Default: "name"

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.syncRootWithCwd

Changes the tree root directory on `DirChanged` and refreshes the tree

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.systemOpenCmd

The command used to open a file with the associated default program

Type: string

Default: "\${pkgs.xdg-utils}/bin/xdg-open"

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.trailingSlash

Add a trailing slash to all folders

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.updateCwd

Updates the tree when changing nvim's directory (DirChanged event).

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.updateFocusedFile

Updates the tree when changing nvim's directory (DirChanged event).

Type: attribute set of (boolean or attribute set of boolean)

Default:

{
+                
vim.filetree.nvimTree.enable

Whether to enable filetree via nvim-tree.lua.

Type: boolean

Default: false

Example: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions

Configuration for various actions.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.changeDir

vim `change-directory` behaviour

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.changeDir.enable

Change the working directory when changing directories in the tree.

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.changeDir.global

Use `:cd` instead of `:lcd` when changing directories. +Consider that this might cause issues with the `nvim-tree.syncRootWithCwd` option.

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.changeDir.restrictAboveCwd

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.expandAll

Configuration for expand_all behaviour.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.expandAll.exclude

A list of directories that should not be expanded automatically.

Type: list of string

Default:

[
+  ".git"
+  "target"
+  "build"
+  "result"
+]

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.expandAll.maxFolderDiscovery

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

Type: signed integer

Default: 300

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.filePopup

Configuration for file_popup behaviour.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.filePopup.openWinConfig

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

Type: attribute set

Default:

{
+  border = "rounded";
+  col = 1;
+  relative = "cursor";
+  row = 1;
+  style = "minimal";
+}

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.openFile

Configuration options for opening a file from nvim-tree.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.openFile.eject

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.openFile.quitOnOpen

Closes the explorer when opening a file.

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.openFile.resizeWindow

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.openFile.windowPicker

window_picker

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.openFile.windowPicker.enable

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.openFile.windowPicker.chars

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

Type: string

Default: "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.openFile.windowPicker.exclude.buftype

A list of buftypes to exclude from the window picker.

Type: list of string

Default:

[
+  "nofile"
+  "terminal"
+  "help"
+]

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.openFile.windowPicker.exclude.filetype

A list of filetypes to exclude from the window picker.

Type: list of string

Default:

[
+  "notify"
+  "packer"
+  "qf"
+  "diff"
+  "fugitive"
+  "fugitiveblame"
+]

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.openFile.windowPicker.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.

Type: string

Default: "default"

Example:

-- with s1n7ax/nvim-window-picker plugin
+require('window-picker').pick_window,
+

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.removeFile.closeWindow

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

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.actions.useSystemClipboard

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 '"'.

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.autoreloadOnWrite

Auto reload tree on write

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.diagnostics

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

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.diagnostics.enable

Whether to enable Enable diagnostics view in the signcolumn..

Type: boolean

Default: false

Example: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.diagnostics.debounceDelay

Idle milliseconds between diagnostic event and update.

Type: signed integer

Default: 50

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.diagnostics.icons

Icons for diagnostic severity.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.diagnostics.icons.error

Icon used for `error` diagnostic.

Type: string

Default: ""

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.diagnostics.icons.hint

Icon used for `hint` diagnostic.

Type: string

Default: ""

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.diagnostics.icons.info

Icon used for `info` diagnostic.

Type: string

Default: ""

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.diagnostics.icons.warning

Icon used for `warning` diagnostic.

Type: string

Default: ""

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.diagnostics.severity

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

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.diagnostics.severity.max

Maximum severity.

Type: one of "HINT", "INFO", "WARNING", "ERROR"

Default: "ERROR"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.diagnostics.severity.min

Minimum severity.

Type: one of "HINT", "INFO", "WARNING", "ERROR"

Default: "HINT"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.diagnostics.showOnDirs

Show diagnostic icons on parent directories.

Type: unspecified value

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.diagnostics.showOnOpenDirs

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

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.disableNetrw

Disables netrw and replaces it with tree

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.filesystemWatchers

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.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.filesystemWatchers.enable

Enable filesystem watchers.

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.filesystemWatchers.debounceDelay

Idle milliseconds between filesystem change and action.

Type: signed integer

Default: 50

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.filesystemWatchers.ignoreDirs

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.

Type: list of string

Default: [ ]

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.filters

Filtering options.

Type: submodule

Default:

{
+  dotfiles = false;
+  exclude = [ ];
+  gitClean = false;
+  gitIgnored = false;
+  noBuffer = false;
+}

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.filters.dotfiles

Do not show dotfiles: files starting with a `.`

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.filters.exclude

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

Type: list of string

Default: [ ]

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.filters.gitClean

Do not show files with no git status. This will show ignored files when +`nvim-tree.filters.git_ignored` is set, as they are effectively dirty.

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.filters.gitIgnored

Ignore files based on `.gitignore`. Requires git.enable` to be `true`

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.filters.noBuffer

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.git.enable

Whether to enable Git integration with icons and colors..

Type: boolean

Default: false

Example: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.git.disableForDirs

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

Type: list of string

Default: [ ]

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.git.showOnDirs

Show git icons on parent directories.

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.git.showOnOpenDirs

Show git icons on directories that are open.

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.git.timeout

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

Type: signed integer

Default: 400

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.hijackCursor

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.hijackDirectories

hijack new directory buffers when they are opened (`:e dir`).

Type: submodule

Default:

{
+  autoOpen = false;
   enable = true;
-  update_cwd = true;
-}

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.view.adaptiveSize

Resize the tree when the window is resized

Type: boolean

Default: true

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.view.cursorline

Whether to display the cursor line in NvimTree

Type: boolean

Default: false

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.view.side

Side the tree will appear on left or right

Type: one of "left", "right"

Default: "left"

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> -
vim.filetree.nvimTreeLua.view.width

Width of the tree in charecters

Type: signed integer

Default: 35

Declared by:

- <neovim-flake/modules/filetree/nvimtree-lua/nvimtree-lua.nix> +}

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.hijackDirectories.enable

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.

Type: boolean

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.hijackDirectories.autoOpen

Opens the tree if the tree was previously closed.

Type: boolean

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.hijackNetrw

Prevents netrw from automatically opening when opening directories

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.hijackUnnamedBufferWhenOpening

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.liveFilter

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.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.liveFilter.alwaysShowFolders

Whether to filter folders or not.

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.liveFilter.prefix

Prefix of the filter displayed in the buffer.

Type: string

Default: "[FILTER]: "

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.mappings.findFile

Find file in NvimTree

Type: null or string

Default: "<leader>tg"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.mappings.focus

Focus NvimTree

Type: null or string

Default: "<leader>tf"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.mappings.refresh

Refresh NvimTree

Type: null or string

Default: "<leader>tr"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.mappings.toggle

Toggle NvimTree

Type: null or string

Default: "<leader>t"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.modified

Indicate which file have unsaved modification.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.modified.enable

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

Type: boolean

Default: false

Example: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.modified.showOnDirs

Show modified icons on parent directories.

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.modified.showOnOpenDirs

Show modified icons on directories that are open.

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.notify

Configuration for notifications.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.notify.absolutePath

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

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.notify.threshold

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

Type: one of "ERROR", "WARNING", "INFO", "DEBUG"

Default: "INFO"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.openOnSetup

Open when vim is started on a directory

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.preferStartupRoot

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.reloadOnBufEnter

Automatically reloads the tree on `BufEnter` nvim-tree.

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.addTrailing

Appends a trailing slash to folder names.

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.fullName

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.groupEmpty

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.highlightGit

Enable file highlight for git attributes using `NvimTreeGit` highlight groups. +Requires `nvim-tree.git.enable` +This can be used with or without the icons.

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.highlightModified

Highlight modified files in the tree using `NvimTreeNormal` highlight group. +Requires `nvim-tree.view.highlightOpenedFiles`

Type: one of "none", "icon", "name", "all"

Default: "none"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.highlightOpenedFiles

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

Type: one of "none", "icon", "name", "all"

Default: "none"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons

Configuration options for icons.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.gitPlacement

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

Type: one of "before", "after", "signcolumn"

Default: "before"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.glyphs

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.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.glyphs.default

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

Type: string

Default: ""

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.glyphs.folder

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

Type: attribute set

Default:

{
+  arrowClosed = "";
+  arrowOpen = "";
+  default = "";
+  empty = "";
+  emptyOpen = "";
+  open = "";
+  symlink = "";
+  symlinkOpen = "";
+}

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.glyphs.git

Glyphs for git status.

Type: attribute set

Default:

{
+  deleted = "";
+  ignored = "◌";
+  renamed = "➜";
+  staged = "✓";
+  unmerged = "";
+  unstaged = "✗";
+  untracked = "★";
+}

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.glyphs.modified

Icon to display for modified files.

Type: string

Default: ""

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.glyphs.symlink

Glyph for symlinks.

Type: string

Default: ""

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.modifiedPlacement

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

Type: one of "before", "after", "signcolumn"

Default: "after"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.padding

Inserted between icon and filename

Type: string

Default: " "

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.show.file

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

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.show.folder

Show an icon before the folder name.

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.show.folderArrow

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

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.show.git

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.show.modified

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

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.symlinkArrow

Used as a separator between symlinks' source and target.

Type: string

Default: " ➛ "

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.icons.webdevColors

Use the webdev icon colors, otherwise `NvimTreeFileIcon`

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.indentMarkers

Configuration options for tree indent markers.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.indentMarkers.enable

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

Type: boolean

Default: false

Example: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.indentMarkers.icons

Type: attribute set

Default:

{
+  bottom = "─";
+  corner = "└";
+  edge = "│";
+  item = "│";
+  none = "";
+}

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.indentMarkers.inlineArrows

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

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.indentWidth

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

Type: signed integer

Default: 2

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.rootFolderLabel

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

Type: string or boolean

Default: false

Example: "\"\":~:s?$?/..?\""

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.specialFiles

A list of filenames that gets highlighted with `NvimTreeSpecialFile

Type: list of string

Default:

[
+  "Cargo.toml"
+  "README.md"
+  "readme.md"
+  "Makefile"
+  "MAKEFILE"
+  "flake.nix"
+]

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.renderer.symlinkDestination

Whether to show the destination of the symlink.

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.respectBufCwd

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.rootDirs

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

Type: list of string

Default: [ ]

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.selectPrompts

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 +.

Type: boolean

Default: false

Example: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.sort.foldersFirst

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

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.sort.sorter

How files within the same directory are sorted.

Type: one of "name", "extension", "modification_time", "case_sensitive", "suffix", "filetype"

Default: "name"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.syncRootWithCwd

Changes the tree root directory on `DirChanged` and refreshes the tree. +Only relevant when `updateFocusedFile.updateRoot` is `true` + +(previously `update_cwd`)

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.systemOpen.args

Optional argument list.

Type: list of string

Default: [ ]

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.systemOpen.cmd

The open command itself

Type: string

Default: "\${pkgs.xdg-utils}/bin/xdg-open"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.tab

Configuration for tab behaviour.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.tab.sync

Configuration for syncing nvim-tree across tabs.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.tab.sync.close

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.tab.sync.ignore

List of filetypes or buffer names on new tab that will prevent +`nvim-tree.tab.sync.open` and `nvim-tree.tab.sync.close`

Type: list of string

Default: [ ]

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.tab.sync.open

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.trash

Configuration options for trashing.

Type: submodule

Default:

{
+  cmd = "\${pkgs.glib}/bin/gio trash";
+}

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.trash.cmd

The command used to trash items

Type: string

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.ui

General UI configuration.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.ui.confirm.remove

Prompt before removing.

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.ui.confirm.trash

Prompt before trash.

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.updateFocusedFile

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

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.updateFocusedFile.enable

update focused file

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.updateFocusedFile.ignoreList

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`.

Type: list of string

Default: [ ]

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.updateFocusedFile.updateRoot

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`

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.view

Window / buffer setup.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.view.centralizeSelection

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.view.cursorline

Enable cursorline in nvim-tree window.

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.view.debounceDelay

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

Type: signed integer

Default: 15

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.view.float

Configuration options for floating window.

Type: submodule

Default: { }

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.view.float.enable

If true, tree window will be floating.

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.view.float.openWinConfig

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

Type: attribute set

Default:

{
+  border = "rounded";
+  col = 1;
+  height = 30;
+  relative = "editor";
+  row = 1;
+  width = 30;
+}

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.view.float.quitOnFocusLoss

Close the floating tree window when it loses focus.

Type: boolean

Default: true

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.view.number

Print the line number in front of each line.

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.view.preserveWindowProportions

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

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.view.relativenumber

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`.

Type: boolean

Default: false

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.view.side

Side of the tree.

Type: one of "left", "right"

Default: "left"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.view.signcolumn

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

Type: one of "yes", "auto", "no"

Default: "yes"

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix> +
vim.filetree.nvimTree.view.width

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.

Type: signed integer or (attribute set)

Default: 30

Example:

{
+  min = 30;
+  max = -1;
+  padding = 1;
+}
+

Declared by:

+ <neovim-flake/modules/filetree/nvimtree/nvimtree.nix>
vim.gestures.gesture-nvim.enable

Whether to enable gesture-nvim: mouse gestures.

Type: boolean

Default: false

Example: true

Declared by:

<neovim-flake/modules/utility/gestures/gesture-nvim/gesture-nvim.nix>
vim.gestures.gesture-nvim.mappings.draw

Start drawing [gesture.nvim]

Type: null or string

Default: "<LeftDrag>"

Declared by:

diff --git a/release-notes.html b/release-notes.html index dd1f15a..0a7a51a 100644 --- a/release-notes.html +++ b/release-notes.html @@ -145,7 +145,7 @@ Made Copilot’s Node package configurable. It is recommended to keep as default
  • Added vim.cursorlineOpt for configuring Neovim’s cursorlineOpt.
  • -Added vim.filetree.nvimTreeLua.view.cursorline, default false, to enable cursorline in nvimtre. +Added filetree.nvimTreeLua.view.cursorline, default false, to enable cursorline in nvimtre.
  • Added Fidget.nvim support for the Catppuccin theme.