plugins.neo-tree.enable

Whether to enable neo-tree.

Type: boolean

Default: false

Example: true

Declared by:

plugins.neo-tree.enableDiagnostics

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.neo-tree.enableGitStatus

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.neo-tree.enableModifiedMarkers

Show markers for files with unsaved changes.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.neo-tree.enableRefreshOnWrite

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

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.neo-tree.package

The neo-tree package to use.

Type: package

Default: pkgs.vimPlugins.neo-tree-nvim

Declared by:

plugins.neo-tree.addBlankLineAtTop

Add a blank line at the top of the tree.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.neo-tree.autoCleanAfterSessionRestore

Automatically clean up broken neo-tree buffers saved in sessions

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.neo-tree.closeIfLastWindow

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

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.neo-tree.defaultSource

Type: null or string or raw lua code

Default: null

Plugin default: "filesystem"

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

The git package to use.

Type: null or package

Default: pkgs.git

Declared by:

plugins.neo-tree.gitStatusAsync

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.neo-tree.hideRootNode

Hide the root node.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.neo-tree.logLevel

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

Default: null

Plugin default: "info"

Declared by:

plugins.neo-tree.logToFile

use :NeoTreeLogs to show the file

Type: null or boolean or string

Default: null

Plugin default: false

Declared by:

plugins.neo-tree.nestingRules

nesting rules

Type: null or (attribute set of (string or raw lua code))

Default: null

Plugin default: { }

Declared by:

plugins.neo-tree.openFilesInLastWindow

If false, open files in top left window

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.neo-tree.popupBorderStyle

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

Default: null

Plugin default: "NC"

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

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

Default: null

Plugin default: 500

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.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.neo-tree.sortCaseInsensitive

Used when sorting files and directories in the tree

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.neo-tree.sortFunction

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

Type: null or lua function string

Default: null

Plugin default: "nil"

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.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default:

[
  "filesystem"
  "buffers"
  "git_status"
]

Declared by:

plugins.neo-tree.useDefaultMappings

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.neo-tree.usePopupsForInput

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

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: