Merge branch 'master' into feat-branch-complete-on-attach

Author: alex-courtis

README.md

@@ -22,6 +22,8 @@
 <br clear="left"/>
 <br />
 
+Take a look at the [wiki](https://github.com/nvim-tree/nvim-tree.lua/wiki) for Showcases, Tips, Recipes and more.
+
 [Join us on matrix](https://matrix.to/#/#nvim-tree:matrix.org)
 
 ## Requirements
@@ -129,7 +131,7 @@ Development is focused on:
 
 nvim-tree exposes a public API. This is non breaking, with additions made as necessary.
 
-Please raise a [feature request](https://github.com/nvim-tree/nvim-tree.lua/issues/new?assignees=&labels=feature+request&template=feature_request.md&title=) if the API is insufficent for your needs. [Pull requests](#contributing) are always welcome.
+Please raise a [feature request](https://github.com/nvim-tree/nvim-tree.lua/issues/new?assignees=&labels=feature+request&template=feature_request.md&title=) if the API is insufficent for your needs. [Contributions](#Contributing) are always welcome.
 
 [:help nvim-tree-api](doc/nvim-tree-lua.txt)
 
@@ -145,59 +147,11 @@ Custom actions may be mapped which can invoke API or perform your own actions.
 
 [:help nvim-tree-mappings](doc/nvim-tree-lua.txt)
 
-## Tips & tricks
-
-* You can add a directory by adding a `/` at the end of the paths, entering multiple directories `BASE/foo/bar/baz` will add directory foo, then bar and add a file baz to it.
-* You can update window options for the tree by setting `require"nvim-tree.view".View.winopts.MY_OPTION = MY_OPTION_VALUE`
-* `toggle` has a second parameter which allows to toggle without focusing the explorer (`require"nvim-tree".toggle(false, true)`).
-* You can allow nvim-tree to behave like vinegar, see [:help nvim-tree-vinegar](doc/nvim-tree-lua.txt)
-* If you `:set nosplitright`, the files will open on the left side of the tree, placing the tree window in the right side of the file you opened.
-* You can automatically close the tab/vim when nvim-tree is the last window in the tab: <https://github.com/nvim-tree/nvim-tree.lua/discussions/1115>. WARNING: this can catastrophically fail: <https://github.com/nvim-tree/nvim-tree.lua/issues/1368>. This will not be added to nvim-tree and the team will not provide support / assistance with this, due to complexities in vim event timings and side-effects.
-* Hide the `.git` folder: `filters = { custom = { "^.git$" } }`. See [:help nvim-tree.filters.custom](doc/nvim-tree-lua.txt).
-* To disable the display of icons see [:help nvim-tree.renderer.icons.show](doc/nvim-tree-lua.txt).
-
-## Troubleshooting
-
-## Diagnostic Logging
-
-You may enable diagnostic logging to `$XDG_CACHE_HOME/nvim/nvim-tree.log`. See [:help nvim-tree.log](doc/nvim-tree-lua.txt)
-
-## netrw Keeps Popping Up
-
-Eagerly disable netrw. See [:help nvim-tree.disable_netrw](doc/nvim-tree-lua.txt)
-
-## Performance Issues
-
-If you are experiencing performance issues with nvim-tree.lua, you can enable profiling in the logs. It is advisable to enable git logging at the same time, as that can be a source of performance problems.
-
-```lua
-log = {
-  enable = true,
-  truncate = true,
-  types = {
-    diagnostics = true,
-    git = true,
-    profile = true,
-    watcher = true,
-  },
-},
-```
-
-Please attach `$XDG_CACHE_HOME/nvim/nvim-tree.log` if you raise an issue.
-
-*Performance Tips:*
-
-* If you are using fish as an editor shell (which might be fixed in the future), try set `shell=/bin/bash` in your vim config. Alternatively, you can [prevent fish from loading interactive configuration in a non-interactive shell](https://github.com/nvim-tree/nvim-tree.lua/issues/549#issuecomment-1127394585).
-
-* Try manually running the git command (see the logs) in your shell e.g. `git --no-optional-locks status --porcelain=v1 --ignored=matching -u`.
-
-* Huge git repositories may timeout after the default `git.timeout` of 400ms. Try increasing that in your setup if you see `[git] job timed out` in the logs.
-
-* Try temporarily disabling git integration by setting `git.enable = false` in your setup.
-
 ## Contributing
 
-PRs are always welcome. See [CONTRIBUTING.md](CONTRIBUTING.md)
+PRs are always welcome. See [wiki](https://github.com/nvim-tree/nvim-tree.lua/wiki/Development) to get started.
+
+See [bug](https://github.com/nvim-tree/nvim-tree.lua/issues?q=is%3Aissue+is%3Aopen+label%3Abug) and [PR Please](https://github.com/nvim-tree/nvim-tree.lua/issues?q=is%3Aopen+is%3Aissue+label%3A%22PR+please%22) issues if you are looking for some work to get you started.
 
 ### Help Wanted
 

doc/nvim-tree-lua.txt

@@ -177,8 +177,6 @@ Subsequent calls to setup will replace the previous configuration.
       ignore_buffer_on_setup = false,
       open_on_setup = false,
       open_on_setup_file = false,
-      open_on_tab = false,
-      ignore_buf_on_tab_change = {},
       sort_by = "name",
       root_dirs = {},
       prefer_startup_root = false,
@@ -223,7 +221,7 @@ Subsequent calls to setup will replace the previous configuration.
         highlight_git = false,
         full_name = false,
         highlight_opened_files = "none",
-        root_folder_modifier = ":~",
+        root_folder_label = ":~:s?$?/..?",
         indent_width = 2,
         indent_markers = {
           enable = false,
@@ -293,6 +291,10 @@ Subsequent calls to setup will replace the previous configuration.
         enable = false,
         show_on_dirs = false,
         debounce_delay = 50,
+        severity = {
+          min = vim.diagnostic.severity.HINT,
+          max = vim.diagnostic.severity.ERROR
+        },
         icons = {
           hint = "",
           info = "",
@@ -360,6 +362,16 @@ Subsequent calls to setup will replace the previous configuration.
         prefix = "[FILTER]: ",
         always_show_folders = true,
       },
+      tab = {
+        sync = {
+          open = false,
+          close = false,
+          ignore = {},
+        },
+      },
+      notify = {
+        threshold = vim.log.levels.INFO,
+      },
       log = {
         enable = false,
         truncate = false,
@@ -374,9 +386,6 @@ Subsequent calls to setup will replace the previous configuration.
           watcher = false,
         },
       },
-      notify = {
-        threshold = vim.log.levels.INFO,
-      },
     } -- END_DEFAULT_OPTS
 <
 
@@ -417,10 +426,6 @@ You can use this option if you don't want the tree to open
 in some scenarios (eg using vim startify).
   Type: {string}, Default: `{}`
 
-*nvim-tree.ignore_buf_on_tab_change*
-List of filetypes or buffer names that will prevent `open_on_tab` to open.
-  Type: {string}, Default: `{}`
-
 *nvim-tree.auto_reload_on_write*
 Reloads the explorer every time a buffer is written to.
   Type: `boolean`, Default: `true`
@@ -430,11 +435,6 @@ Creating a file when the cursor is on a closed folder will set the
 path to be inside the closed folder, otherwise the parent folder.
   Type: `boolean`, Default: `false`
 
-*nvim-tree.open_on_tab*
-Opens the tree automatically when switching tabpage or opening a new tabpage
-if the tree was previously open.
-  Type: `boolean`, Default: `false`
-
 *nvim-tree.sort_by*
 Changes how files within the same directory are sorted.
 Can be one of `name`, `case_sensitive`, `modification_time`, `extension` or a
@@ -536,6 +536,13 @@ Configuration options for the system open command.
 *nvim-tree.diagnostics*
 Show LSP and COC diagnostics in the signcolumn
 
+    `NOTE`: it will use the default diagnostic color groups to highlight the signs.
+    If you wish to customize, you can override these groups:
+    - `NvimTreeLspDiagnosticsError`
+    - `NvimTreeLspDiagnosticsWarning`
+    - `NvimTreeLspDiagnosticsInformation`
+    - `NvimTreeLspDiagnosticsHint`
+
     *nvim-tree.diagnostics.enable*
     Enable/disable the feature.
       Type: `boolean`, Default: `false`
@@ -552,12 +559,16 @@ Show LSP and COC diagnostics in the signcolumn
     Icons for diagnostic severity.
       Type: `table`, Default: `{ hint = "", info = "", warning = "", error = "" }`
 
-    `NOTE`: it will use the default diagnostic color groups to highlight the signs.
-    If you wish to customize, you can override these groups:
-    - `NvimTreeLspDiagnosticsError`
-    - `NvimTreeLspDiagnosticsWarning`
-    - `NvimTreeLspDiagnosticsInformation`
-    - `NvimTreeLspDiagnosticsHint`
+    *nvim-tree.diagnostics.severity*
+    Severity for which the diagnostics will be displayed. See |diagnostic-severity|
+
+      *nvim-tree.diagnostics.severity.min*
+      Minimum severity.
+        Type: |vim.diagnostic.severity|, Default: `vim.diagnostic.severity.HINT`
+
+      *nvim-tree.diagnostics.severity.max*
+      Maximum severity.
+        Type: |vim.diagnostic.severity|, Default: `vim.diagnostic.severity.ERROR`
 
 *nvim-tree.git*
 Git integration with icons and colors.
@@ -749,11 +760,17 @@ UI rendering setup
     Value can be `"none"`, `"icon"`, `"name"` or `"all"`.
       Type: `string`, Default: `"none"`
 
-    *nvim-tree.renderer.root_folder_modifier*
+    *nvim-tree.renderer.root_folder_label*  (previously `renderer.root_folder_modifier`)
     In what format to show root folder. See `:help filename-modifiers` for
-    available options.
-      Type: `string`, Default: `":~"`
-
+    available `string` options.
+      Type: `string` or `function(root_cwd)`, Default: `":~:s?$?/..?"`
+
+      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
+<
     *nvim-tree.renderer.indent_width*
     Number of spaces for an each tree nesting level. Minimum 1.
       Type: `number`, Default: `2`
@@ -1002,6 +1019,26 @@ The filter can be cleared with the `F` key by default.
     Whether to filter folders or not.
       Type: `boolean`, Default: `true`
 
+*nvim-tree.tab*
+Configuration for tab behaviour.
+
+    *nvim-tree.tab.sync*
+    Configuration for syncing nvim-tree across tabs.
+
+        *nvim-tree.tab.sync.open*  (previously `nvim-tree.open_on_tab`)
+        Opens the tree automatically when switching tabpage or opening a new
+        tabpage if the tree was previously open.
+          Type: `boolean`, Default: `false`
+
+        *nvim-tree.tab.sync.close*
+        Closes the tree across all tabpages when the tree is closed.
+          Type: `boolean`, Default: `false`
+
+        *nvim-tree.tab.sync.ignore*  (previously `nvim-tree.ignore_buf_on_tab_change`)
+        List of filetypes or buffer names on new tab that will prevent
+        |nvim-tree.tab.sync.open| and |nvim-tree.tab.sync.close|
+          Type: {string}, Default: `{}`
+
 *nvim-tree.notify*
 Configuration for notification.
 
@@ -1074,8 +1111,9 @@ You can easily implement a toggle using this too:
 >
     local function toggle_replace()
       local view = require"nvim-tree.view"
+      local api = require"nvim-tree.api"
       if view.is_visible() then
-        view.close()
+        api.tree.close()
       else
         require"nvim-tree".open_replacing_current_buffer()
       end
@@ -1130,6 +1168,7 @@ exists.
     - change_root_to_node
     - change_root_to_parent
     - get_node_under_cursor
+    - get_nodes
     - find_file `(filename: string)`
     - search_node
     - collapse_all `(keep_buffers?: bool)`

lua/nvim-tree.lua

@@ -113,11 +113,11 @@ function M.open_replacing_current_buffer(cwd)
   require("nvim-tree.actions.finders.find-file").fn(bufname)
 end
 
-function M.tab_change()
+function M.tab_enter()
   if view.is_visible { any_tabpage = true } then
     local bufname = vim.api.nvim_buf_get_name(0)
     local ft = vim.api.nvim_buf_get_option(0, "ft")
-    for _, filter in ipairs(M.config.ignore_buf_on_tab_change) do
+    for _, filter in ipairs(M.config.tab.sync.ignore) do
       if bufname:match(filter) ~= nil or ft:match(filter) ~= nil then
         return
       end
@@ -223,9 +223,9 @@ function M.on_enter(netrw_disabled)
   local is_file = stats and stats.type == "file"
   local cwd
   if is_dir then
-    cwd = vim.fn.expand(bufname)
+    cwd = vim.fn.expand(vim.fn.fnameescape(bufname))
     -- INFO: could potentially conflict with rooter plugins
-    vim.cmd("noautocmd cd " .. cwd)
+    vim.cmd("noautocmd cd " .. vim.fn.fnameescape(cwd))
   end
 
   local lines = not is_dir and vim.api.nvim_buf_get_lines(bufnr, 0, -1, false) or {}
@@ -358,8 +358,8 @@ local function setup_autocommands(opts)
     })
   end
 
-  if opts.open_on_tab then
-    create_nvim_tree_autocmd("TabEnter", { callback = vim.schedule_wrap(M.tab_change) })
+  if opts.tab.sync.open then
+    create_nvim_tree_autocmd("TabEnter", { callback = vim.schedule_wrap(M.tab_enter) })
   end
   if opts.hijack_cursor then
     create_nvim_tree_autocmd("CursorMoved", {
@@ -453,8 +453,6 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
   ignore_buffer_on_setup = false,
   open_on_setup = false,
   open_on_setup_file = false,
-  open_on_tab = false,
-  ignore_buf_on_tab_change = {},
   sort_by = "name",
   root_dirs = {},
   prefer_startup_root = false,
@@ -499,7 +497,7 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
     highlight_git = false,
     full_name = false,
     highlight_opened_files = "none",
-    root_folder_modifier = ":~",
+    root_folder_label = ":~:s?$?/..?",
     indent_width = 2,
     indent_markers = {
       enable = false,
@@ -569,6 +567,10 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
     enable = false,
     show_on_dirs = false,
     debounce_delay = 50,
+    severity = {
+      min = vim.diagnostic.severity.HINT,
+      max = vim.diagnostic.severity.ERROR,
+    },
     icons = {
       hint = "",
       info = "",
@@ -636,6 +638,13 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
     prefix = "[FILTER]: ",
     always_show_folders = true,
   },
+  tab = {
+    sync = {
+      open = false,
+      close = false,
+      ignore = {},
+    },
+  },
   notify = {
     threshold = vim.log.levels.INFO,
   },
@@ -668,6 +677,7 @@ local FIELD_OVERRIDE_TYPECHECK = {
   remove_keymaps = { boolean = true, table = true },
   on_attach = { ["function"] = true, string = true },
   sort_by = { ["function"] = true, string = true },
+  root_folder_label = { ["function"] = true, string = true },
 }
 
 local function validate_options(conf)
@@ -736,7 +746,6 @@ function M.setup(conf)
   _config.open_on_setup_file = opts.open_on_setup_file
   _config.ignore_buffer_on_setup = opts.ignore_buffer_on_setup
   _config.ignore_ft_on_setup = opts.ignore_ft_on_setup
-  _config.ignore_buf_on_tab_change = opts.ignore_buf_on_tab_change
   _config.hijack_directories = opts.hijack_directories
   _config.hijack_directories.enable = _config.hijack_directories.enable and netrw_disabled
 
@@ -771,9 +780,9 @@ function M.setup(conf)
     setup_vim_commands()
   end
 
-  if M.setup_called and view.is_visible() then
-    view.close()
-    view.abandon_current_window()
+  if M.setup_called then
+    view.close_all_tabs()
+    view.abandon_all_windows()
   end
 
   if M.setup_called and core.get_explorer() ~= nil then