plugins.neo-tree.enable

Whether to enable neo-tree.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neo-tree.enableDiagnostics

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.enableGitStatus

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.enableModifiedMarkers

Show markers for files with unsaved changes.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.enableRefreshOnWrite

Refresh the tree when a file is written. Only used if use_libuv_file_watcher is false.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.package

Which package to use for the neo-tree plugin.

Type: package

Default: <derivation vimplugin-neo-tree.nvim-2024-05-15>

Declared by:

plugins.neo-tree.addBlankLineAtTop

Add a blank line at the top of the tree.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.autoCleanAfterSessionRestore

Automatically clean up broken neo-tree buffers saved in sessions

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.closeIfLastWindow

Close Neo-tree if it is the last window left in the tab

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.defaultSource

Plugin default: "filesystem"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.eventHandlers

Configuration of event handlers. Attrs:

  • keys are the events (e.g. before_render, file_opened)
  • values are lua code defining the callback function.

Example:

{
  before_render = \'\'
    function (state)
      -- add something to the state that can be used by custom components
    end
  \'\';

  file_opened = \'\'
    function(file_path)
      --auto close
      require("neo-tree").close_all()
    end
  \'\';
}

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.neo-tree.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.neo-tree.extraSources

Extra sources to be added to the sources. This is an internal nixvim option.

Type: null or (list of string)

Default: null

Declared by:

plugins.neo-tree.gitStatusAsync

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.hideRootNode

Hide the root node.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.logLevel

Plugin default: "info"

Type: null or one of “trace”, “debug”, “info”, “warn”, “error”, “fatal” or raw lua code

Default: null

Declared by:

plugins.neo-tree.logToFile

use :NeoTreeLogs to show the file

Plugin default: false

Type: null or boolean or string

Default: null

Declared by:

plugins.neo-tree.nestingRules

nesting rules

Plugin default: {}

Type: null or (attribute set of string)

Default: null

Declared by:

plugins.neo-tree.openFilesInLastWindow

If false, open files in top left window

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.popupBorderStyle

Plugin default: "NC"

Type: null or one of “NC”, “double”, “none”, “rounded”, “shadow”, “single”, “solid” or raw lua code

Default: null

Declared by:

plugins.neo-tree.resizeTimerInterval

In ms, needed for containers to redraw right aligned and faded content. Set to -1 to disable the resize timer entirely.

NOTE: this will speed up to 50 ms for 1 second following a resize

Plugin default: 500

Type: null or signed integer or floating point number or raw lua code

Default: null

Declared by:

plugins.neo-tree.retainHiddenRootIndent

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

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.sortCaseInsensitive

Used when sorting files and directories in the tree

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.sortFunction

Uses a custom function for sorting files and directories in the tree

Plugin default: nil

Type: null or lua function string

Default: null

Declared by:

plugins.neo-tree.sources

If a user has a sources list it will replace this one. Only sources listed here will be loaded. You can also add an external source by adding it’s name to this list. The name used here must be the same name you would use in a require() call.

Plugin default: ["filesystem" "buffers" "git_status"]

Type: null or (list of string)

Default: null

Declared by:

plugins.neo-tree.useDefaultMappings

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.usePopupsForInput

If false, inputs will use vim.ui.input() instead of custom floats.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by: