plugins.neo-tree.filesystem.asyncDirectoryScan

  • “auto” means refreshes are async, but it’s synchronous when called from the Neotree commands.
  • “always” means directory scans are always async.
  • “never” means directory scans are never async.

Plugin default: "auto"

Type: null or one of “auto”, “always”, “never” or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.bindToCwd

true creates a 2-way binding between vim’s cwd and neo-tree’s root.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.findArgs

Find arguments

Either use a list of strings:

findArgs = {
  fd = [
    "--exclude"
    ".git"
    "--exclude"
    "node_modules"
  ];
};

Or use a function instead of list of strings

findArgs = \'\'
  find_args = function(cmd, path, search_term, args)
    if cmd ~= "fd" then
      return args
    end
    --maybe you want to force the filter to always include hidden files:
    table.insert(args, "--hidden")
    -- but no one ever wants to see .git files
    table.insert(args, "--exclude")
    table.insert(args, ".git")
    -- or node_modules
    table.insert(args, "--exclude")
    table.insert(args, "node_modules")
    --here is where it pays to use the function, you can exclude more for
    --short search terms, or vary based on the directory
    if string.len(search_term) < 4 and path == "/home/cseickel" then
      table.insert(args, "--exclude")
      table.insert(args, "Library")
    end
    return args
  end
\'\';

Type: null or lua function string or (submodule)

Default: null

Declared by:

plugins.neo-tree.filesystem.findByFullPathWords

false means it only searches the tail of a path. true will change the filter into a full path

search with space as an implicit “.*”, so fi init will match: `./sources/filesystem/init.lua

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.findCommand

This is determined automatically, you probably don’t need to set it

Plugin default: "fd"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.groupEmptyDirs

when true, empty folders will be grouped together

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.hijackNetrwBehavior

  • “open_default”: netrw disabled, opening a directory opens neo-tree in whatever position is specified in window.position
  • “open_current”: netrw disabled, opening a directory opens within the window like netrw would, regardless of window.position
  • “disabled”: netrw left alone, neo-tree does not handle opening dirs

Plugin default: "open_default"

Type: null or one of “open_default”, “open_current”, “disabled” or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.scanMode

  • “shallow”: Don’t scan into directories to detect possible empty directory a priori.
  • “deep”: Scan into directories to detect empty or grouped empty directories a priori.

Plugin default: "shallow"

Type: null or one of “shallow”, “deep” or raw lua code

Default: null

Declared by:

plugins.neo-tree.filesystem.searchLimit

max number of search results when using filters

Plugin default: 50

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

Default: null

Declared by:

plugins.neo-tree.filesystem.useLibuvFileWatcher

This will use the OS level file watchers to detect changes instead of relying on nvim autocmd events.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by: